Documentation

hpilo_facts - Gather facts through an HP iLO interface

New in version 2.3.

Synopsis

  • This module gathers facts for a specific system using its HP iLO interface. These facts include 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 Choices/Defaults Comments
host
required
The HP iLO hostname/address that is linked to the physical system.
login Default:
Administrator
The login name to authenticate to the HP iLO interface.
password Default:
admin
The password to authenticate to the HP iLO interface.
ssl_version
(added in 2.4)
    Choices:
  • SSLv3
  • SSLv23
  • TLSv1 ←
  • TLSv1_1
  • TLSv1_2
Change the ssl_version used.

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

# Task to gather facts from a HP iLO interface only if the system is an HP server
- hpilo_facts:
    host: YOUR_ILO_ADDRESS
    login: YOUR_ILO_LOGIN
    password: YOUR_ILO_PASSWORD
  when: cmdb_hwmodel.startswith('HP ')
  delegate_to: localhost

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

Return Values

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

Key Returned Description
hw_bios_date
string
always
BIOS date

Sample:
05/05/2011
hw_bios_version
string
always
BIOS version

Sample:
P68
hw_eth_ilo
dictionary
always
Interface information (for the iLO network interface)

Sample:
[{'macaddress': '00:11:22:33:44:BA'}, {'macaddress_dash': '00-11-22-33-44-BA'}]
hw_ethX
dictionary
always
Interface information (for each interface)

Sample:
[{'macaddress': '00:11:22:33:44:55', 'macaddress_dash': '00-11-22-33-44-55'}]
hw_product_name
string
always
Product name

Sample:
ProLiant DL360 G7
hw_product_uuid
string
always
Product UUID

Sample:
ef50bac8-2845-40ff-81d9-675315501dac
hw_system_serial
string
always
System serial number

Sample:
ABC12345D6
hw_uuid
string
always
Hardware UUID

Sample:
123456ABC78901D2


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Dag Wieers (@dagwieers)

Hint

If you notice any issues in this documentation you can edit this document to improve it.