ironic.drivers.modules.ilo.management module¶
iLO Management Interface
-
class
ironic.drivers.modules.ilo.management.
Ilo5Management
[source]¶ Bases:
ironic.drivers.modules.ilo.management.IloManagement
-
erase_devices
(task, **kwargs)[source]¶ 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.
-
-
class
ironic.drivers.modules.ilo.management.
IloManagement
[source]¶ Bases:
ironic.drivers.base.ManagementInterface
-
activate_license
(task, **kwargs)[source]¶ 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.
-
clear_iscsi_boot_target
(task)[source]¶ 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)[source]¶ 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.
-
get_boot_device
(task)[source]¶ 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_properties
()[source]¶ Return the properties of the interface.
- Returns
dictionary of <property name>:<property description> entries.
-
get_sensors_data
(task)[source]¶ 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)[source]¶ 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
.
-
inject_nmi
(task)[source]¶ 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)[source]¶ 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)[source]¶ 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)[source]¶ 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)[source]¶ 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.
-
set_boot_device
(task, device, persistent=False)[source]¶ 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_iscsi_boot_target
(task)[source]¶ 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.
-
update_firmware
(task, **kwargs)[source]¶ 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)[source]¶ Updates the firmware using Smart Update Manager (SUM).
- Parameters
task – a TaskManager object.
- Raises
NodeCleaningFailure, on failure to execute of clean step.
-
validate
(task)[source]¶ 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.
-