Bases: ManagementInterface
Clear all secure boot keys.
task – a task from TaskManager.
UnsupportedDriverExtension if secure boot is now supported.
RedfishError on runtime driver error.
Detects and returns the hardware vendor.
Uses the System’s Manufacturer field.
task – A task from TaskManager.
InvalidParameterValue if an invalid component, indicator or state is specified.
MissingParameterValue if a required parameter is missing
RedfishError on driver-specific problems.
String representing the BMC reported Vendor or Manufacturer, otherwise returns None.
Get the current boot device for a node.
task – a task from TaskManager.
InvalidParameterValue on malformed parameter(s)
MissingParameterValue on missing parameter(s)
RedfishConnectionError when it fails to connect to Redfish
RedfishError on an error from the Sushy library
a dictionary containing:
the boot device, one of ironic.common.boot_devices
or
None if it is unknown.
Boolean value or None, True if the boot device persists, False otherwise. None if it’s unknown.
Get the current boot mode for a node.
Provides the current boot mode of the node.
task – A task from TaskManager.
MissingParameterValue if a required parameter is missing
DriverOperationError or its derivative in case of driver runtime error.
The boot mode, one of ironic.common.boot_mode
or
None if it is unknown.
Get current state of the indicator of the hardware component.
task – A task from TaskManager.
component – The hardware component, one of
ironic.common.components
.
indicator – Indicator ID (as reported by get_supported_indicators).
MissingParameterValue if a required parameter is missing
RedfishError on an error from the Sushy library
Current state of the indicator, one of
ironic.common.indicator_states
.
Get MAC address information for the node.
task – A TaskManager instance containing the node to act on.
RedfishConnectionError when it fails to connect to Redfish
RedfishError on an error from the Sushy library
A list of MAC addresses for the node
Return the properties of the interface.
dictionary of <property name>:<property description> entries.
Get the current secure boot state for the node.
task – A task from TaskManager.
MissingParameterValue if a required parameter is missing
RedfishError or its derivative in case of a driver runtime error.
UnsupportedDriverExtension if secure boot is not supported by the hardware.
Boolean
Get sensors data.
task – a TaskManager instance.
FailedToGetSensorData when getting the sensor data fails.
FailedToParseSensorData when parsing sensor data fails.
InvalidParameterValue if required parameters are missing.
MissingParameterValue if a required parameter is missing.
returns a dict of sensor data grouped by sensor type.
Get a list of the supported boot devices.
task – a task from TaskManager.
A list with the supported boot devices defined
in ironic.common.boot_devices
.
Get a list of the supported boot modes.
task – A task from TaskManager.
A list with the supported boot modes defined
in ironic.common.boot_modes
. If boot
mode support can’t be determined, empty list
is returned.
Get a map of the supported indicators (e.g. LEDs).
task – A task from TaskManager.
component – If not None, return indicator information for just this component, otherwise return indicators for all existing components.
A dictionary of hardware components
(ironic.common.components
) as keys with values
being dictionaries having indicator IDs as keys and indicator
properties as values.
{
'chassis': {
'enclosure-0': {
"readonly": true,
"states": [
"OFF",
"ON"
]
}
},
'system':
'blade-A': {
"readonly": true,
"states": [
"OFF",
"ON"
]
}
},
'drive':
'ssd0': {
"readonly": true,
"states": [
"OFF",
"ON"
]
}
}
}
Inject NMI, Non Maskable Interrupt.
Inject NMI (Non Maskable Interrupt) for a node immediately.
task – A TaskManager instance containing the node to act on.
InvalidParameterValue on malformed parameter(s)
MissingParameterValue on missing parameter(s)
RedfishConnectionError when it fails to connect to Redfish
RedfishError on an error from the Sushy library
Reset secure boot keys to manufacturing defaults.
task – a task from TaskManager.
UnsupportedDriverExtension if secure boot is now supported.
RedfishError on runtime driver error.
Restore boot device if needed.
Checks the redfish_boot_device internal flag and sets the one-time boot device accordingly. A warning is issued if it fails.
This method is supposed to be called from the Redfish power interface and should be considered private to the Redfish hardware type.
task – a task from TaskManager.
system – a Redfish System object.
Set the boot device for a node.
Set the boot device to use on next reboot of the node.
task – a task from TaskManager.
device – the boot device, one of
ironic.common.boot_devices
.
persistent – Boolean value. True if the boot device will persist to all future boots, False if not. Default: False.
InvalidParameterValue on malformed parameter(s)
MissingParameterValue on missing parameter(s)
RedfishConnectionError when it fails to connect to Redfish
RedfishError on an error from the Sushy library
Set the boot mode for a node.
Set the boot mode to use on next reboot of the node.
task – A task from TaskManager.
mode – The boot mode, one of
ironic.common.boot_modes
.
InvalidParameterValue if an invalid boot mode is specified.
MissingParameterValue if a required parameter is missing
RedfishConnectionError when it fails to connect to Redfish
RedfishError on an error from the Sushy library
Set indicator on the hardware component to the desired state.
task – A task from TaskManager.
component – The hardware component, one of
ironic.common.components
.
indicator – Indicator ID (as reported by get_supported_indicators).
state – Desired state of the indicator, one of
ironic.common.indicator_states
.
InvalidParameterValue if an invalid component, indicator or state is specified.
MissingParameterValue if a required parameter is missing
RedfishError on an error from the Sushy library
Set the current secure boot state for the node.
task – A task from TaskManager.
state – A new state as a boolean.
MissingParameterValue if a required parameter is missing
RedfishError or its derivative in case of a driver runtime error.
UnsupportedDriverExtension if secure boot is not supported by the hardware.
Updates the firmware on the node.
task – a TaskManager instance containing the node to act on.
firmware_images – A list of firmware images are to apply.
None if it is completed.
RedfishError on an error from the Sushy library.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.