ironic.drivers.modules.ilo.management module

iLO Management Interface

class ironic.drivers.modules.ilo.management.Ilo5Management(*args, **kwargs)

Bases: IloManagement

clear_ca_certificates(task, certificate_files)

Clears the certificates provided in the list of files to iLO.

Parameters:

• task – a task from TaskManager.

• certificate_files – a list of certificate files.

Raises:

NodeCleaningFailure, on failure to execute of clean step.

Raises:

InstanceDeployFailure, on failure to execute of deploy step.

erase_devices(task, **kwargs)

Erase all the drives on the node.

This method performs out-of-band sanitize disk erase on all the supported physical drives in the node. This erase cannot be performed on logical drives.

Parameters:

task – a TaskManager instance.

Raises:

InvalidParameterValue, if any of the arguments are invalid.

Raises:

IloError on an error from iLO.

one_button_secure_erase(task)

Erase the whole system securely.

The One-button secure erase process resets iLO and deletes all licenses stored there, resets BIOS settings, and deletes all Active Health System (AHS) and warranty data stored on the system. It also erases supported non-volatile storage data and deletes any deployment setting profiles.

Parameters:

task – a TaskManager instance.

Raises:

IloError on an error from iLO.

class ironic.drivers.modules.ilo.management.IloManagement(*args, **kwargs)

Bases: ManagementInterface

activate_license(task, **kwargs)

Activates iLO Advanced license.

Parameters:

task – a TaskManager object.

Raises:

InvalidParameterValue, if any of the arguments are invalid.

Raises:

NodeCleaningFailure, on failure to execute of clean step.

add_https_certificate(task, **kwargs)

Adds the signed HTTPS certificate to the iLO.

Parameters:

task – a TaskManager object.

clear_iscsi_boot_target(task)

Unset iSCSI details of the system in UEFI boot mode.

Parameters:

task – a task from TaskManager.

Raises:

IloCommandNotSupportedInBiosError if system in BIOS boot mode.

Raises:

IloError on an error from iLO.

clear_secure_boot_keys(task)

Clear all secure boot keys.

Clears all the secure boot keys. This operation is supported only on HP Proliant Gen9 and above servers.

Parameters:

task – a task from TaskManager.

Raises:

NodeCleaningFailure, on failure to execute of clean step.

Raises:

InstanceDeployFailure, on failure to execute of deploy step.

create_csr(task, **kwargs)

Creates the CSR.

Parameters:

task – a TaskManager object.

flash_firmware_sum(task, **kwargs)

Deploy step to Update the firmware using Smart Update Manager (SUM).

Parameters:

task – a TaskManager object.

Raises:

InstanceDeployFailure, on failure to execute of deploy step.

Returns:

states.DEPLOYWAIT to signify the step will be completed async

get_boot_device(task)

Get the current boot device for a node.

Returns the current boot device of the node.

Parameters:

task – a task from TaskManager.

Raises:

MissingParameterValue if a required iLO parameter is missing.

Raises:

IloOperationError on an error from IloClient library.

Returns:

a dictionary containing:

boot_device:

the boot device, one of the supported devices listed in ironic.common.boot_devices or None if it is unknown.

persistent:

Whether the boot device will persist to all future boots or not, None if it is unknown.

get_boot_mode(task)

Get the current boot mode for a node.

Provides the current boot mode of the node.

Parameters:

task – A task from TaskManager.

Raises:

IloOperationError on an error from IloClient library.

Returns:

The boot mode, one of ironic.common.boot_mode or None if it is unknown.

get_properties()

Return the properties of the interface.

Returns:

dictionary of <property name>:<property description> entries.

get_secure_boot_state(task)

Get the current secure boot state for the node.

Parameters:

task – A task from TaskManager.

Raises:

MissingParameterValue if a required parameter is missing

Raises:

IloOperationError on an error from IloClient library.

Raises:

UnsupportedDriverExtension if secure boot is not supported by the hardware

Returns:

Boolean

get_sensors_data(task)

Get sensors data.

Parameters:

task – a TaskManager instance.

Raises:

FailedToGetSensorData when getting the sensor data fails.

Raises:

FailedToParseSensorData when parsing sensor data fails.

Raises:

InvalidParameterValue if required ipmi parameters are missing.

Raises:

MissingParameterValue if a required parameter is missing.

Returns:

returns a dict of sensor data group by sensor type.

get_supported_boot_devices(task)

Get a list of the supported boot devices.

Parameters:

task – a task from TaskManager.

Returns:

A list with the supported boot devices defined in ironic.common.boot_devices.

get_supported_boot_modes(task)

Get a list of the supported boot devices.

Parameters:

task – a task from TaskManager.

Raises:

IloOperationError if any exception happens in proliantutils

Returns:

A list with the supported boot devices defined in ironic.common.boot_devices.

inject_nmi(task)

Inject NMI, Non Maskable Interrupt.

Inject NMI (Non Maskable Interrupt) for a node immediately.

Parameters:

task – A TaskManager instance containing the node to act on.

Raises:

IloCommandNotSupportedError if system does not support NMI injection.

Raises:

IloError on an error from iLO.

Returns:

None

reset_bios_to_default(task)

Resets the BIOS settings to default values.

Resets BIOS to default settings. This operation is currently supported only on HP Proliant Gen9 and above servers.

Parameters:

task – a task from TaskManager.

Raises:

NodeCleaningFailure, on failure to execute of clean step.

Raises:

InstanceDeployFailure, on failure to execute of deploy step.

reset_ilo(task)

Resets the iLO.

Parameters:

task – a task from TaskManager.

Raises:

NodeCleaningFailure, on failure to execute of clean step.

Raises:

InstanceDeployFailure, on failure to execute of deploy step.

reset_ilo_credential(task, change_password=None)

Resets the iLO password.

Parameters:

• task – a task from TaskManager.

• change_password – Value for password to update on iLO.

Raises:

NodeCleaningFailure, on failure to execute of clean step.

Raises:

InstanceDeployFailure, on failure to execute of deploy step.

reset_secure_boot_keys_to_default(task)

Reset secure boot keys to manufacturing defaults.

Resets the secure boot keys to manufacturing defaults. This operation is supported only on HP Proliant Gen9 and above servers.

Parameters:

task – a task from TaskManager.

Raises:

NodeCleaningFailure, on failure to execute of clean step.

Raises:

InstanceDeployFailure, on failure to execute of deploy step.

security_parameters_update(task, **kwargs)

Updates the security parameters.

Parameters:

task – a TaskManager object.

set_boot_device(task, device, persistent=False)

Set the boot device for a node.

Set the boot device to use on next reboot of the node.

Parameters:

• task – a task from TaskManager.

• device – the boot device, one of the supported devices listed in ironic.common.boot_devices.

• persistent – Boolean value. True if the boot device will persist to all future boots, False if not. Default: False.

Raises:

InvalidParameterValue if an invalid boot device is specified.

Raises:

MissingParameterValue if a required parameter is missing.

Raises:

IloOperationError on an error from IloClient library.

set_boot_mode(task, mode)

Set the boot mode for a node.

Set the boot mode to use on next reboot of the node.

Parameters:

• task – A task from TaskManager.

• mode – The boot mode, one of ironic.common.boot_modes.

Raises:

InvalidParameterValue if an invalid boot mode is specified.

Raises:

IloOperationError if setting boot mode failed.

set_iscsi_boot_target(task)

Set iSCSI details of the system in UEFI boot mode.

The initiator is set with the target details like IQN, LUN, IP, Port etc. :param task: a task from TaskManager. :raises: MissingParameterValue if a required parameter is missing. :raises: IloCommandNotSupportedInBiosError if system in BIOS boot mode. :raises: IloError on an error from iLO.

set_secure_boot_state(task, state)

Set the current secure boot state for the node.

Parameters:

• task – A task from TaskManager.

• state – A new state as a boolean.

Raises:

MissingParameterValue if a required parameter is missing

Raises:

IloOperationError on an error from IloClient library.

Raises:

UnsupportedDriverExtension if secure boot is not supported by the hardware

update_auth_failure_logging_threshold(task, **kwargs)

Updates the Auth Failure Logging Threshold security parameter.

Parameters:

task – a TaskManager object.

update_firmware(task, **kwargs)

Updates the firmware.

Parameters:

task – a TaskManager object.

Raises:

InvalidParameterValue if update firmware mode is not ‘ilo’. Even applicable for invalid input cases.

Raises:

NodeCleaningFailure, on failure to execute of clean step.

Raises:

InstanceDeployFailure, on failure to execute of deploy step.

update_firmware_sum(task, **kwargs)

Clean step to update the firmware using Smart Update Manager (SUM)

Parameters:

task – a TaskManager object.

Raises:

NodeCleaningFailure, on failure to execute of clean step.

Returns:

states.CLEANWAIT to signify the step will be completed async

update_minimum_password_length(task, **kwargs)

Updates the Minimum Password Length security parameter.

Parameters:

task – a TaskManager object.

validate(task)

Check that ‘driver_info’ contains required ILO credentials.

Validates whether the ‘driver_info’ property of the supplied task’s node contains the required credentials information.

Parameters:

task – a task from TaskManager.

Raises:

InvalidParameterValue if required iLO parameters are not valid.

Raises:

MissingParameterValue if a required parameter is missing.