Bases: sushy.resources.base.CompositeField
Bases: sushy.resources.base.ResourceBase
Vendor-specific key-value dict of effective BIOS attributes
Attributes cannot be updated directly.
To update use set_attribute()
or set_attributes()
Change BIOS password
Human-readable description of the BIOS resource
Get the Attribute Registry associated with this BIOS instance
language – RFC 5646 language code for Message Registries. Indicates language of registry to be used. Defaults to ‘en’.
the BIOS Attribute Registry
The Bios resource identity string
Indicates if a given resource has a maintenance window assignment for applying settings or operations
The name of the resource
Pending BIOS attributes
BIOS attributes that have been committed to the system, but for them to take effect system restart is necessary
Reset the BIOS attributes to default
Update an attribute
Attribute update is not immediate but requires system restart.
Committed attributes can be checked at pending_attributes
property
key – Attribute name
value – Attribute value
apply_time – When to update the attribute. Optional. APPLY_TIME_IMMEDIATE - Immediate, APPLY_TIME_ON_RESET - On reset, APPLY_TIME_MAINT_START - During specified maintenance time APPLY_TIME_MAINT_RESET - On reset during specified maintenance time
maint_window_start_time – The start time of a maintenance window, datetime. Required when updating during maintenance window and default maintenance window not set by the system.
maint_window_duration – Duration of maintenance time since maintenance window start time in seconds. Required when updating during maintenance window and default maintenance window not set by the system.
Update many attributes at once
Attribute update is not immediate but requires system restart.
Committed attributes can be checked at pending_attributes
property
value – Key-value pairs for attribute name and value
apply_time – When to update the attributes. Optional. APPLY_TIME_IMMEDIATE - Immediate, APPLY_TIME_ON_RESET - On reset, APPLY_TIME_MAINT_START - During specified maintenance time APPLY_TIME_MAINT_RESET - On reset during specified maintenance time
maint_window_start_time – The start time of a maintenance window, datetime. Required when updating during maintenance window and default maintenance window not set by the system.
maint_window_duration – Duration of maintenance time since maintenance window start time in seconds. Required when updating during maintenance window and default maintenance window not set by the system.
List of supported BIOS update apply times
List of supported update apply time names
Status of the last attribute update
sushy.resources.settings.SettingsUpdate
object
containing status and any messages
Boot to the BIOS Setup Utility
Boot from the CD/DVD disc
Boot the manufacturer’s Diagnostics program
Boot from the floppy disk drive
Boot from a hard drive
Boot from the normal boot device
Boot from the Pre-Boot EXecution (PXE) environment
Boot from an SD Card
Boot from a UEFI HTTP network location
Boot to the UEFI Shell
Boot to the UEFI Device specified in the UefiTargetBootSourceOverride property
Boot from a USB device as specified by the system BIOS
Boot the manufacturer’s Utilities program(s)
UEFI secure boot is disabled.
UEFI secure boot is enabled.
The Indicator LED is blinking
Deprecated: Use sushy.resources.constants.INDICATOR_LED_BLINKING.
The Indicator LED is lit
Deprecated: Use sushy.resources.constants.INDICATOR_LED_LIT.
The Indicator LED is off
Deprecated: Use sushy.resources.constants.INDICATOR_LED_OFF.
The state of the Indicator LED cannot be determine
Deprecated: Use sushy.resources.constants.INDICATOR_LED_UNKNOWN.
The system is powered off, although some components may continue to have AUX power such as management controller
The system is powered on
A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process
A temporary state between Off and On. This temporary state can be very short
A computer system created by binding resource blocks together
An operating system instance
A physical computer system
A hardware-based partition of a computer system
A virtual machine instance
A virtual or software-based partition of a computer system
Bases: sushy.resources.base.ResourceBase
This class adds the EthernetInterface resource
Description
The Ethernet Interface identity string
This is the currently configured MAC address of the interface.
The name of the resource or array element
This is the permanent MAC address assigned to this interface (port)
This is the current speed in Mbps of this interface.
Describes the status and health of this interface.
Bases: sushy.resources.base.ResourceCollectionBase
Summary of MAC addresses and interfaces state
This filters the MACs whose health is OK, which means the MACs in both ‘Enabled’ and ‘Disabled’ States are returned.
dictionary in the format {‘aa:bb:cc:dd:ee:ff’: sushy.STATE_ENABLED, ‘aa:bb:aa:aa:aa:aa’: sushy.STATE_DISABLED}
Bases: sushy.resources.base.ResourceBase
The processor identity string
The instruction set of the processor
The processor manufacturer
The maximum clock speed of the processor in MHz.
The product model number of this device
The architecture of the processor
The processor id
The type of processor
The socket or location of the processor
The processor status
A reference to the collection of Sub-Processors
The total number of cores contained in this processor
The total number of execution threads supported by this processor
Bases: sushy.resources.base.ResourceCollectionBase
Property to provide ProcessorSummary info
It is calculated once when the first time it is queried. On refresh, this property gets reset.
A namedtuple containing the count
of processors
in regards to logical CPUs, and their architecture
.
Bases: sushy.resources.base.CompositeField
The processor effective family
The processor effective model
The processor identification registers
The processor microcode info
The processor stepping
The processor vendor id
Bases: sushy.resources.base.CompositeField
Action that resets the UEFI Secure Boot keys.
Bases: sushy.resources.common.ActionField
Bases: sushy.resources.base.ResourceBase
The UEFI Secure Boot state during the current boot cycle.
A collection of secure boot databases.
It is set once when the first time it is queried. On refresh, this property is marked as stale (greedy-refresh not done). Here the actual refresh of the sub-resource happens, if stale.
MissingAttributeError if ‘SecureBootDatabases/@odata.id’ field is missing.
SimpleStorageCollection instance
Human-readable description of the BIOS resource
Whether the UEFI Secure Boot takes effect on next boot.
This property can be enabled in UEFI boot mode only.
Get the allowed values for resetting the keys.
A set with the allowed values.
The Bios resource identity string
The current UEFI Secure Boot Mode.
The name of the resource
Reset secure boot keys.
reset_type – Reset type, one of SECORE_BOOT_RESET_KEYS_* constants.
Enable/disable secure boot.
enabled – True, if secure boot is enabled for next boot.
Bases: sushy.resources.base.CompositeField
Action that resets the UEFI Secure Boot keys.
Bases: sushy.resources.common.ActionField
Bases: sushy.resources.base.ResourceBase
Standard UEFI database type.
The system description
Get the allowed values for resetting the keys.
A set with the allowed values.
The secure boot database identity string
The secure boot database name
Reset secure boot keys.
reset_type – Reset type, one of SECORE_BOOT_RESET_KEYS_* constants.
Bases: sushy.resources.base.ListField
The storage device/s associated with SimpleStorage.
The size of the storage device.
The name of the storage device
Describes the status and health of a storage device.
Bases: sushy.resources.base.ResourceBase
This class represents a simple storage.
It represents the properties of a storage controller and its directly-attached devices. A storage device can be a disk drive or optical media device.
The storage devices associated with this resource.
The SimpleStorage identity string
The name of the resource
Bases: sushy.resources.base.ResourceCollectionBase
Represents a collection of simple storage associated with system.
Sizes of each Disk in bytes in SimpleStorage collection resource.
Returns the list of cached values until it (or its parent resource) is refreshed.
Max size available (in bytes) among all enabled Disk resources.
Returns the cached value until it (or its parent resource) is refreshed.
Bases: sushy.resources.base.CompositeField
Bases: sushy.resources.base.CompositeField
Bases: sushy.resources.base.CompositeField
The overall health state of memory.
This signifies health state of memory along with its dependent resources.
The size of memory of the system in GiB.
This signifies the total installed, operating system-accessible memory (RAM), measured in GiB.
Bases: sushy.resources.base.ResourceBase
The system asset tag
Property to reference Bios instance
It is set once when the first time it is queried. On refresh, this property is marked as stale (greedy-refresh not done). Here the actual refresh of the sub-resource happens, if stale.
The system BIOS version
A dictionary containing the current boot device, frequency and mode
A list of chassis where this system resides.
Returns a list of Chassis objects representing the chassis or cabinets where this system is mounted.
MissingAttributeError if ‘@odata.id’ field is missing.
A list of Chassis instances
The system description
Property to reference EthernetInterfaceCollection instance
It is set once when the first time it is queried. On refresh, this property is marked as stale (greedy-refresh not done). Here the actual refresh of the sub-resource happens, if stale.
Get the allowed values for resetting the system.
A set with the allowed values.
Get the allowed values for changing the boot source.
A set with the allowed values.
The system hostname
The system identity string
Whether the indicator LED is lit or off
Indicates if a given resource has a maintenance window assignment for applying settings or operations
A list of managers for this system.
Returns a list of Manager objects representing the managers that manage this system.
MissingAttributeError if ‘@odata.id’ field is missing.
A list of Manager instances
The system manufacturer
The summary info of memory of the system in general detail
The system name
The system part number
The system power state
Property to reference ProcessorCollection instance
It is set once when the first time it is queried. On refresh, this property is marked as stale (greedy-refresh not done). Here the actual refresh of the sub-resource happens, if stale.
Reset the system.
value – The target value.
InvalidParameterValueError, if the target value is not allowed.
Property to reference SecureBoot instance
It is set once when the first time it is queried. On refresh, this property is marked as stale (greedy-refresh not done). Here the actual refresh of the sub-resource happens, if stale.
The system serial number
Set IndicatorLED to the given state.
state – Desired LED state, lit (INDICATOR_LED_LIT), blinking (INDICATOR_LED_BLINKING), off (INDICATOR_LED_OFF)
InvalidParameterValueError, if any information passed is invalid.
Set boot source and/or boot frequency and/or boot mode.
Set the boot source and/or boot frequency and/or boot mode to use on next reboot of the System.
target – The target boot source, optional.
enabled – The frequency, whether to set it for the next reboot only (BOOT_SOURCE_ENABLED_ONCE) or persistent to all future reboots (BOOT_SOURCE_ENABLED_CONTINUOUS) or disabled (BOOT_SOURCE_ENABLED_DISABLED), optional.
mode – The boot mode (UEFI: BOOT_SOURCE_MODE_UEFI or BIOS: BOOT_SOURCE_MODE_BIOS), optional.
InvalidParameterValueError, if any information passed is invalid.
Set boot source and/or boot frequency and/or boot mode.
Set the boot source and/or boot frequency and/or boot mode to use on next reboot of the System.
This method is obsoleted by set_system_boot_options.
target – The target boot source.
enabled – The frequency, whether to set it for the next reboot only (BOOT_SOURCE_ENABLED_ONCE) or persistent to all future reboots (BOOT_SOURCE_ENABLED_CONTINUOUS) or disabled (BOOT_SOURCE_ENABLED_DISABLED). Default is BOOT_SOURCE_ENABLED_ONCE.
mode – The boot mode (UEFI: BOOT_SOURCE_MODE_UEFI or BIOS: BOOT_SOURCE_MODE_BIOS), optional.
InvalidParameterValueError, if any information passed is invalid.
A collection of simple storage associated with system.
This returns a reference to SimpleStorageCollection instance. SimpleStorage represents the properties of a storage controller and its directly-attached devices.
It is set once when the first time it is queried. On refresh, this property is marked as stale (greedy-refresh not done). Here the actual refresh of the sub-resource happens, if stale.
MissingAttributeError if ‘SimpleStorage/@odata.id’ field is missing.
SimpleStorageCollection instance
The system stock-keeping unit
The system status
A collection of storage subsystems associated with system.
This returns a reference to StorageCollection instance. A storage subsystem represents a set of storage controllers (physical or virtual) and the resources such as drives and volumes that can be accessed from that subsystem.
It is set once when the first time it is queried. On refresh, this property is marked as stale (greedy-refresh not done). Here the actual refresh of the sub-resource happens, if stale.
MissingAttributeError if ‘Storage/@odata.id’ field is missing.
StorageCollection instance
The system type
The system UUID
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.