The Ilo class encapsulates all functionality. It autodetects which iLO version is in use and will send the correct messages for that version. Its methods are divided into several categories below: getting information, changing settings and upgrading firmware.
There are quite a few methods to get information about your server, its enclosing chassis or the iLO board itself. To see what they return, please refer to the example output.
Methods that manipulate the iLO, such as setting the servers name, or changing a users password do not have a return value.
The exception IloError is raised in case of errors that occur when communicating with the IlO. The subclass IloLoginFailed is raised for login failures.
Represents an iLO/iLO2/iLO3/iLO4/RILOE II management interface on a specific host. A new connection using the specified login, password and timeout will be made for each API call. The library will detect which protocol to use, but you can override this by setting protocol to ILO_RAW or ILO_HTTP. Use ILO_LOCAL to avoid using a network connection and use hponcfg instead. Username and password are ignored for ILO_LOCAL connections. Set delayed to True to make python-hpilo not send requests immediately, but group them together. See call_delayed()
Activate an iLO advanced license
Add a new federation group
Add a new user to the iLO interface with the specified name, password and permissions. Permission attributes should be boolean values.
Clears Active Health System information log
In delayed mode, calling a method on an iLO object will not cause an immediate callout to the iLO. Instead, the method and parameters are stored for future calls of this method. This method makes one connection to the iLO and sends all commands as one XML document. This speeds up applications that make many calls to the iLO by removing seconds of overhead per call.
The return value of call_delayed is a list of return values for individual methods that don’t return None. This means that there may be fewer items returned than methods called as only get_* methods return data
Delayed calls only work on iLO 2 or newer
Configure whether to use the fqdn or the short hostname for certificate requests
Get a certificate signing request from the iLO
Clears the iLO event log
Clears the server event log
Clears the server power on time
Force a cold boot of the server
Configure the computer lock settings
Delete the specified federation group membership
Delete a users SSH key
Delete the specified user from the ilo
Disable Insight Remote Support functionality and unregister the server
Eject the virtual floppy
Eject the virtual media attached to the specified device
Submity AHS data to the insight remote support server
Reset the iLO to factory default settings
Enable FIPS standard to enforce AES/3DES encryption, can only be reset with a call to factory_defaults. Resets Administrator password and license key
Get active health system logging status
Get the list of installed languages - broken because iLO returns invalid XML
Get a list of all license types and licenses
Get basic and authorization info of all users
Get a list of all loginnames
Gets the server asset tag
Get ssl certificate subject information
Get the current boot mode (legaci or uefi)
Get directory authentication configuration
Get server health information
Get the iLO encryption settings
Get the ERS Insight Remote Support settings
Get all federation group names
Get all federation group names and associated privileges
Get privileges for a specific federation group
Get the iLO federation mulicast settings
Is the FIPS-mandated AES/3DESencryption enforcement in place
Get the iLO type and firmware version, use get_product_name to get the server model
Get global iLO settings
Get SMBIOS records that describe the host. By default only the ones where human readable information is available are returned. To get all records pass decoded_only=False
Get the configuration of the ProLiant power regulator
Whether the server is powered on or not
Get the version of the power micro firmware
Get the full iLO event log
Get the default language set
Get the iLO network settings
Get information about the OA of the enclosing chassis
Get the one time boot state of the host
Get the pending boot mode (legaci or uefi)
Returns whether persistent mouse and keyboard are enabled
Get the boot order of the host
Get the power cap setting
Get current, min, max and average power readings
Get the model name of the server, use get_fw_version to get the iLO model
Get the power and power alert threshold settings
Get the rack settings for an iLO
Retrieve the security message that is displayed on the login screen
Get the automatic power on delay setting
Get the IML log of the server
Get the fqdn of the server this iLO is managing
Get the name of the server this iLO is managing
How many minutes ago has the server been powered on
Get the fqdn of the HP System Management Homepage
Where does the iLO send SNMP traps to and which traps does it send
Get location information
Get the HP SIM Single Sign-On settings
Get the status of the Trusted Platform Module
Get two-factor authentication settings
Get the status of the UID light
Get user info about a specific user
Get the status of virtual media devices. Valid devices are FLOPPY and CDROM
Press and hold the power button
Change a set of shortcuts
Import a signed SSL certificate
Imports an SSH key for the specified user. The value of ssh_key should be the content of an id_dsa.pub file
Insert a virtual floppy or CDROM. Note that you will also need to use set_vm_status() to connect the media
Modify iLO directory configuration, only values that are specified will be changed.
Set attributes for a federation group, only specified arguments will be changed. All arguments except group_name, new_group_name and group_key should be boolean
Modify iLO global settings, only values that are specified will be changed.
Configure the network settings for the iLO card. The static route arguments require hashes with the keys specified in the HP documentation.
Configure the SNMP and Insight Manager integration settings.
Set attributes for a user, only specified arguments will be changed. All arguments except user_name and password should be boolean
Press the power button
Apply a deployment profile
Retrieve the results of the last profile_apply
Delet the specified deployment profile
Make the iLO download a blob and create a deployment profile
List all profile descriptors
Reset the iLO/RILOE board
Power cycle the server
Enable or disable AHS logging
Set the server asset tag
Register your iLO with HP Insigt Online using Direct Connect. Note that you must also call dc_registration_complete
Connect to an Insight Remote Support server
Register your iLO with HP Insigt Online using Direct Connect. Note that you must also call dc_registration_complete
Set the Federation multicast configuration
Turn host power on or off
Set the configuration of the ProLiant power regulator
Set the default language. Only EN, JA and ZH are supported
Set one time boot device, device should be one of normal, floppy, cdrom, hdd, usb, rbsu or network. Ilo 4 also supports EMB-MENU (Displays the default boot menu), EMB-ACU (Boots into ACU), EMB-HPSUM-AUTO (Boots HPSUM in automatic update mode), EMB-DIAGS (Launches Insight Diagnostics for Linux in interactive mode) and RBSU (Boots into the system RBSU)
Set the boot mode for the next boot to UEFI or legacy
Enable/disable persistent mouse and keyboard
Set persistent boot order, devices should be comma-separated
Set the power cap feature to a specific value
Set the power alert threshold
Enables/disables the security message on the iLO login screen and sets its value
Set the automatic power on delay setting. Valid settings are False, True (for minumum delay), 15, 30, 45 60 (for that amount of delay or random (for a random delay of up to 60 seconds.)
Set the fqdn of the server
Set the name of the server
Set the parameters of the RILOE virtual floppy specified virtual media. Valid boot options are boot_once, boot_always, no_boot, connect and disconnect.
Set the parameters of the specified virtual media. Valid boot options are boot_once, boot_always, no_boot, connect and disconnect. Valid devices are floppy and cdrom
Initiate an L2 data collection submission to the Insight Remote Support server.
Trigger a test service event submission to the Insight Remote Support server.
Turn the UID light on (“Yes”) or off (“No”)
Upload new RIB firmware, either specified by filename (.bin or .scexe) or version number. Use “latest” as version number to download and use the latest available firmware.
API note:
As this function may take a while, you can choose to receive progress messages by passing a callable in the progress parameter. This callable will be called many times to inform you about upload and flash progress.
Force a warm boot of the server
Get basic discovery data which all iLO versions expose over unauthenticated URL