community.general.hpilo_info module – Gather information through an HP iLO interface

Note

This module is part of the community.general collection (version 9.4.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.hpilo_info.

Synopsis

  • This module gathers information on a specific system using its HP iLO interface. These information includes hardware and network related information useful for provisioning (e.g. macaddress, uuid).

  • This module requires the hpilo python module.

Requirements

The below requirements are needed on the host that executes this module.

  • hpilo

Parameters

Parameter

Comments

host

string / required

The HP iLO hostname/address that is linked to the physical system.

login

string

The login name to authenticate to the HP iLO interface.

Default: "Administrator"

password

string

The password to authenticate to the HP iLO interface.

Default: "admin"

ssl_version

string

Change the ssl_version used.

Choices:

  • "SSLv3"

  • "SSLv23"

  • "TLSv1" ← (default)

  • "TLSv1_1"

  • "TLSv1_2"

Attributes

Attribute

Support

Description

check_mode

Support: full

This action does not modify state.

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: N/A

This action does not modify state.

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

  • This module ought to be run from a system that can access the HP iLO interface directly, either by using local_action or using delegate_to.

Examples

- name: Gather facts from a HP iLO interface only if the system is an HP server
  community.general.hpilo_info:
    host: YOUR_ILO_ADDRESS
    login: YOUR_ILO_LOGIN
    password: YOUR_ILO_PASSWORD
  when: cmdb_hwmodel.startswith('HP ')
  delegate_to: localhost
  register: results

- ansible.builtin.fail:
    msg: 'CMDB serial ({{ cmdb_serialno }}) does not match hardware serial ({{ results.hw_system_serial }}) !'
  when: cmdb_serialno != results.hw_system_serial

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

host_power_status

string

added in community.general 3.5.0

Power status of host.

Will be one of ON, OFF and UNKNOWN.

Returned: always

Sample: "ON"

hw_bios_date

string

BIOS date

Returned: always

Sample: "05/05/2011"

hw_bios_version

string

BIOS version

Returned: always

Sample: "P68"

hw_eth_ilo

dictionary

Interface information (for the iLO network interface)

Returned: always

Sample: [{"macaddress": "00:11:22:33:44:BA"}, {"macaddress_dash": "00-11-22-33-44-BA"}]

hw_ethX

dictionary

Interface information (for each interface)

Returned: always

Sample: [{"macaddress": "00:11:22:33:44:55", "macaddress_dash": "00-11-22-33-44-55"}]

hw_product_name

string

Product name

Returned: always

Sample: "ProLiant DL360 G7"

hw_product_uuid

string

Product UUID

Returned: always

Sample: "ef50bac8-2845-40ff-81d9-675315501dac"

hw_system_serial

string

System serial number

Returned: always

Sample: "ABC12345D6"

hw_uuid

string

Hardware UUID

Returned: always

Sample: "123456ABC78901D2"

Authors

  • Dag Wieers (@dagwieers)