sushy.resources.system package¶
Subpackages¶
Submodules¶
sushy.resources.system.bios module¶
- class sushy.resources.system.bios.ActionsField(*args, **kwargs)¶
Bases:
sushy.resources.base.CompositeField
- change_password = <sushy.resources.common.ActionField object>¶
- reset_bios = <sushy.resources.common.ActionField object>¶
- class sushy.resources.system.bios.Bios(connector, path, redfish_version=None, registries=None, root=None)¶
Bases:
sushy.resources.base.ResourceBase
- property apply_time_settings¶
- attributes = <sushy.resources.base.Field object>¶
Vendor-specific key-value dict of effective BIOS attributes
Attributes cannot be updated directly. To update use
set_attribute()
orset_attributes()
- change_password(new_password, old_password, password_name)¶
Change BIOS password
- description = <sushy.resources.base.Field object>¶
Human-readable description of the BIOS resource
- get_attribute_registry(language='en')¶
Get the Attribute Registry associated with this BIOS instance
- Parameters
language – RFC 5646 language code for Message Registries. Indicates language of registry to be used. Defaults to ‘en’.
- Returns
the BIOS Attribute Registry
- identity = <sushy.resources.base.Field object>¶
The Bios resource identity string
- maintenance_window = <sushy.resources.settings.MaintenanceWindowField object>¶
Indicates if a given resource has a maintenance window assignment for applying settings or operations
- name = <sushy.resources.base.Field object>¶
The name of the resource
- property pending_attributes¶
Pending BIOS attributes
BIOS attributes that have been committed to the system, but for them to take effect system restart is necessary
- reset_bios()¶
Reset the BIOS attributes to default
- set_attribute(key, value, apply_time=None, maint_window_start_time=None, maint_window_duration=None)¶
Update an attribute
Attribute update is not immediate but requires system restart. Committed attributes can be checked at
pending_attributes
property- Parameters
key – Attribute name
value – Attribute value
apply_time – When to update the attribute. Optional. An
sushy.ApplyTime
value.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.
- set_attributes(value, apply_time=None, maint_window_start_time=None, maint_window_duration=None)¶
Update many attributes at once
Attribute update is not immediate but requires system restart. Committed attributes can be checked at
pending_attributes
property- Parameters
value – Key-value pairs for attribute name and value
apply_time – When to update the attributes. Optional. An
sushy.ApplyTime
value.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.
- property supported_apply_times¶
List of supported BIOS update apply times
- Returns
List of supported update apply time names
- property update_status¶
Status of the last attribute update
- Returns
sushy.resources.settings.SettingsUpdate
object containing status and any messages
sushy.resources.system.constants module¶
- class sushy.resources.system.constants.BootSource(value)¶
Bases:
enum.Enum
Boot source target constants
- BIOS_SETUP = 'BiosSetup'¶
Boot to the BIOS setup utility.
- CD = 'Cd'¶
Boot from the CD or DVD.
- DIAGS = 'Diags'¶
Boot to the manufacturer’s diagnostics program.
- FLOPPY = 'Floppy'¶
Boot from the floppy disk drive.
- HDD = 'Hdd'¶
Boot from a hard drive.
- NONE = 'None'¶
Boot from the normal boot device.
- PXE = 'Pxe'¶
Boot from the Pre-Boot EXecution (PXE) environment.
- REMOTE_DRIVE = 'RemoteDrive'¶
Boot from a remote drive, such as an iSCSI target.
- SD_CARD = 'SDCard'¶
Boot from an SD card.
- UEFI_BOOT_NEXT = 'UefiBootNext'¶
Boot to the UEFI device that the BootNext property specifies.
- UEFI_HTTP = 'UefiHttp'¶
Boot from a UEFI HTTP network location.
- UEFI_SHELL = 'UefiShell'¶
Boot to the UEFI Shell.
- UEFI_TARGET = 'UefiTarget'¶
Boot to the UEFI device specified in the UefiTargetBootSourceOverride property.
- USB = 'Usb'¶
Boot from a system BIOS-specified USB device.
- USB_CD = 'UsbCd'¶
Boot from a USB CD device as specified by the system BIOS.
This is NOT a standard value! On SuperMicro X11 and X12 machines, virtual media is presented as an USB CD drive as opposed to a CD drive. Both are present in the list of boot devices, however only selecting UsbCd as the boot source results in a successful boot from vMedia. If CD is selected, boot fails even if vMedia is inserted.
- UTILITIES = 'Utilities'¶
Boot to the manufacturer’s utilities program or programs.
- class sushy.resources.system.constants.BootSourceOverrideEnabled(value)¶
Bases:
enum.Enum
Boot source enabled constants
- CONTINUOUS = 'Continuous'¶
The system boots to the target specified in the BootSourceOverrideTarget property until this property is Disabled.
- DISABLED = 'Disabled'¶
The system boots normally.
- ONCE = 'Once'¶
On its next boot cycle, the system boots one time to the boot source override target. Then, the BootSourceOverrideEnabled value is reset to Disabled.
- class sushy.resources.system.constants.BootSourceOverrideMode(value)¶
Bases:
enum.Enum
Boot source mode constants
- LEGACY = 'Legacy'¶
The system boots in non-UEFI boot mode to the boot source override target.
- UEFI = 'UEFI'¶
The system boots in UEFI boot mode to the boot source override target.
- class sushy.resources.system.constants.InstructionSet(value)¶
Bases:
enum.Enum
Processor InstructionSet constants
- ARM_A32 = 'ARM-A32'¶
ARM 32-bit.
- ARM_A64 = 'ARM-A64'¶
ARM 64-bit.
- IA_64 = 'IA-64'¶
Intel IA-64.
- MIPS32 = 'MIPS32'¶
MIPS 32-bit.
- MIPS64 = 'MIPS64'¶
MIPS 64-bit.
- OEM = 'OEM'¶
OEM-defined.
- POWER_ISA = 'PowerISA'¶
PowerISA-64 or PowerISA-32.
- X86 = 'x86'¶
x86 32-bit.
- X86_64 = 'x86-64'¶
x86 64-bit.
- class sushy.resources.system.constants.ProcessorArchitecture(value)¶
Bases:
enum.Enum
Processor Architecture constants
- ARM = 'ARM'¶
ARM.
- IA_64 = 'IA-64'¶
Intel Itanium.
- MIPS = 'MIPS'¶
MIPS.
- OEM = 'OEM'¶
OEM-defined.
- POWER = 'Power'¶
Power.
- X86 = 'x86'¶
x86 or x86-64.
- class sushy.resources.system.constants.ProcessorType(value)¶
Bases:
enum.Enum
Processor type constants
- ACCELERATOR = 'Accelerator'¶
An accelerator.
- CORE = 'Core'¶
A core in a processor.
- CPU = 'CPU'¶
A CPU.
- DSP = 'DSP'¶
A DSP.
- FPGA = 'FPGA'¶
An FPGA.
- GPU = 'GPU'¶
A GPU.
- OEM = 'OEM'¶
An OEM-defined processing unit.
- THREAD = 'Thread'¶
A thread in a processor.
- sushy.resources.system.constants.SYSTEM_POWER_STATE_OFF = PowerState.OFF¶
The system is powered off, although some components may continue to have AUX power such as management controller
- sushy.resources.system.constants.SYSTEM_POWER_STATE_ON = PowerState.ON¶
The system is powered on
- sushy.resources.system.constants.SYSTEM_POWER_STATE_POWERING_OFF = PowerState.POWERING_OFF¶
A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process
- sushy.resources.system.constants.SYSTEM_POWER_STATE_POWERING_ON = PowerState.POWERING_ON¶
A temporary state between Off and On. This temporary state can be very short
- class sushy.resources.system.constants.SecureBootCurrentBoot(value)¶
Bases:
enum.Enum
An enumeration.
- DISABLED = 'Disabled'¶
UEFI Secure Boot is currently disabled.
- ENABLED = 'Enabled'¶
UEFI Secure Boot is currently enabled.
- class sushy.resources.system.constants.SecureBootDatabaseId(value)¶
Bases:
enum.Enum
An enumeration.
- ALLOWED_KEYS_DATABASE = 'db'¶
- DEFAULT_ALLOWED_KEYS_DATABASE = 'dbDefault'¶
- DEFAULT_DENIED_KEYS_DATABASE = 'dbxDefault'¶
- DEFAULT_KEY_EXCHANGE_KEYS = 'KEKDefault'¶
- DEFAULT_PLATFORM_KEY = 'PKDefault'¶
- DEFAULT_RECOVERY_KEYS_DATABASE = 'dbrDefault'¶
- DEFAULT_TIMESTAMP_DATABASE = 'dbtDefault'¶
- DENIED_KEYS_DATABASE = 'dbx'¶
- KEY_EXCHANGE_KEYS = 'KEK'¶
- PLATFORM_KEY = 'PK'¶
- RECOVERY_KEYS_DATABASE = 'dbr'¶
- TIMESTAMP_DATABASE = 'dbt'¶
- class sushy.resources.system.constants.SecureBootMode(value)¶
Bases:
enum.Enum
An enumeration.
- AUDIT = 'AuditMode'¶
UEFI Secure Boot is currently in Audit Mode.
- DEPLOYED = 'DeployedMode'¶
UEFI Secure Boot is currently in Deployed Mode.
- SETUP = 'SetupMode'¶
UEFI Secure Boot is currently in Setup Mode.
- USER = 'UserMode'¶
UEFI Secure Boot is currently in User Mode.
- class sushy.resources.system.constants.SecureBootResetKeysType(value)¶
Bases:
enum.Enum
An enumeration.
- DELETE_ALL_KEYS = 'DeleteAllKeys'¶
Delete the contents of all UEFI Secure Boot key databases, including the PK key database. This puts the system in Setup Mode.
- DELETE_PK = 'DeletePK'¶
Delete the contents of the PK UEFI Secure Boot database. This puts the system in Setup Mode.
- RESET_ALL_KEYS_TO_DEFAULT = 'ResetAllKeysToDefault'¶
Reset the contents of all UEFI Secure Boot key databases, including the PK key database, to the default values.
- class sushy.resources.system.constants.SystemType(value)¶
Bases:
enum.Enum
System type constants
- COMPOSED = 'Composed'¶
A computer system constructed by binding resource blocks together.
- DPU = 'DPU'¶
A computer system that performs the functions of a data processing unit, such as a SmartNIC.
- OS = 'OS'¶
An operating system instance.
- PHYSICAL = 'Physical'¶
A computer system.
- PHYSICALLY_PARTITIONED = 'PhysicallyPartitioned'¶
A hardware-based partition of a computer system.
- VIRTUAL = 'Virtual'¶
A virtual machine instance running on this system.
- VIRTUALLY_PARTITIONED = 'VirtuallyPartitioned'¶
A virtual or software-based partition of a computer system.
sushy.resources.system.ethernet_interface module¶
- class sushy.resources.system.ethernet_interface.EthernetInterface(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)¶
Bases:
sushy.resources.base.ResourceBase
This class adds the EthernetInterface resource
- description = <sushy.resources.base.Field object>¶
Description
- identity = <sushy.resources.base.Field object>¶
The Ethernet Interface identity string
- mac_address = <sushy.resources.base.Field object>¶
This is the currently configured MAC address of the interface.
- name = <sushy.resources.base.Field object>¶
The name of the resource or array element
- permanent_mac_address = <sushy.resources.base.Field object>¶
This is the permanent MAC address assigned to this interface (port)
- speed_mbps = <sushy.resources.base.Field object>¶
This is the current speed in Mbps of this interface.
- status = <sushy.resources.common.StatusField object>¶
Describes the status and health of this interface.
- class sushy.resources.system.ethernet_interface.EthernetInterfaceCollection(connector, path, redfish_version=None, registries=None, root=None)¶
Bases:
sushy.resources.base.ResourceCollectionBase
- property summary¶
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.
- Returns
dictionary in the format {‘aa:bb:cc:dd:ee:ff’: sushy.State.ENABLED, ‘aa:bb:aa:aa:aa:aa’: sushy.State.DISABLED}
sushy.resources.system.processor module¶
- class sushy.resources.system.processor.Processor(connector, identity, redfish_version=None, registries=None, root=None)¶
Bases:
sushy.resources.base.ResourceBase
- identity = <sushy.resources.base.Field object>¶
The processor identity string
- instruction_set = <sushy.resources.base.MappedField object>¶
The instruction set of the processor
- manufacturer = <sushy.resources.base.Field object>¶
The processor manufacturer
- max_speed_mhz = <sushy.resources.base.Field object>¶
The maximum clock speed of the processor in MHz.
- model = <sushy.resources.base.Field object>¶
The product model number of this device
- processor_architecture = <sushy.resources.base.MappedField object>¶
The architecture of the processor
- processor_id = <sushy.resources.system.processor.ProcessorIdField object>¶
The processor id
- processor_type = <sushy.resources.base.MappedField object>¶
The type of processor
- socket = <sushy.resources.base.Field object>¶
The socket or location of the processor
- status = <sushy.resources.common.StatusField object>¶
The processor status
- property sub_processors¶
A reference to the collection of Sub-Processors
- total_cores = <sushy.resources.base.Field object>¶
The total number of cores contained in this processor
- total_threads = <sushy.resources.base.Field object>¶
The total number of execution threads supported by this processor
- class sushy.resources.system.processor.ProcessorCollection(connector, path, redfish_version=None, registries=None, root=None)¶
Bases:
sushy.resources.base.ResourceCollectionBase
- property summary¶
Property to provide ProcessorSummary info
It is calculated once when the first time it is queried. On refresh, this property gets reset.
- Returns
A namedtuple containing the
count
of processors in regards to logical CPUs, and theirarchitecture
.
- class sushy.resources.system.processor.ProcessorIdField(*args, **kwargs)¶
Bases:
sushy.resources.base.CompositeField
- effective_family = <sushy.resources.base.Field object>¶
The processor effective family
- effective_model = <sushy.resources.base.Field object>¶
The processor effective model
- identification_registers = <sushy.resources.base.Field object>¶
The processor identification registers
- microcode_info = <sushy.resources.base.Field object>¶
The processor microcode info
- step = <sushy.resources.base.Field object>¶
The processor stepping
- vendor_id = <sushy.resources.base.Field object>¶
The processor vendor id
sushy.resources.system.secure_boot module¶
- class sushy.resources.system.secure_boot.ActionsField(*args, **kwargs)¶
Bases:
sushy.resources.base.CompositeField
- reset_keys = <sushy.resources.system.secure_boot.ResetKeysActionField object>¶
Action that resets the UEFI Secure Boot keys.
- class sushy.resources.system.secure_boot.ResetKeysActionField(*args, **kwargs)¶
Bases:
sushy.resources.common.ActionField
- allowed_values = <sushy.resources.base.Field object>¶
- class sushy.resources.system.secure_boot.SecureBoot(connector, path, redfish_version=None, registries=None, root=None)¶
Bases:
sushy.resources.base.ResourceBase
- current_boot = <sushy.resources.base.MappedField object>¶
The UEFI Secure Boot state during the current boot cycle.
- property databases¶
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.
- Raises
MissingAttributeError if ‘SecureBootDatabases/@odata.id’ field is missing.
- Returns
SimpleStorageCollection instance
- description = <sushy.resources.base.Field object>¶
Human-readable description of the BIOS resource
- enabled = <sushy.resources.base.Field object>¶
Whether the UEFI Secure Boot takes effect on next boot.
This property can be enabled in UEFI boot mode only.
- get_allowed_reset_keys_values()¶
Get the allowed values for resetting the keys.
- Returns
A set with the allowed values.
- identity = <sushy.resources.base.Field object>¶
The Bios resource identity string
- mode = <sushy.resources.base.MappedField object>¶
The current UEFI Secure Boot Mode.
- name = <sushy.resources.base.Field object>¶
The name of the resource
- reset_keys(reset_type)¶
Reset secure boot keys.
- Parameters
reset_type – Reset type, one of SECURE_BOOT_RESET_KEYS_* constants.
- set_enabled(enabled)¶
Enable/disable secure boot.
- Parameters
enabled – True, if secure boot is enabled for next boot.
sushy.resources.system.secure_boot_database module¶
- class sushy.resources.system.secure_boot_database.ActionsField(*args, **kwargs)¶
Bases:
sushy.resources.base.CompositeField
- reset_keys = <sushy.resources.system.secure_boot_database.ResetKeysActionField object>¶
Action that resets the UEFI Secure Boot keys.
- class sushy.resources.system.secure_boot_database.ResetKeysActionField(*args, **kwargs)¶
Bases:
sushy.resources.common.ActionField
- allowed_values = <sushy.resources.base.Field object>¶
- class sushy.resources.system.secure_boot_database.SecureBootDatabase(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)¶
Bases:
sushy.resources.base.ResourceBase
- database_id = <sushy.resources.base.MappedField object>¶
Standard UEFI database type.
- description = <sushy.resources.base.Field object>¶
The system description
- get_allowed_reset_keys_values()¶
Get the allowed values for resetting the keys.
- Returns
A set with the allowed values.
- identity = <sushy.resources.base.Field object>¶
The secure boot database identity string
- name = <sushy.resources.base.Field object>¶
The secure boot database name
- reset_keys(reset_type)¶
Reset secure boot keys.
- Parameters
reset_type – Reset type, one of SECURE_BOOT_RESET_KEYS_* constants.
- class sushy.resources.system.secure_boot_database.SecureBootDatabaseCollection(connector, path, redfish_version=None, registries=None, root=None)¶
sushy.resources.system.simple_storage module¶
- class sushy.resources.system.simple_storage.DeviceListField(*args, **kwargs)¶
Bases:
sushy.resources.base.ListField
The storage device/s associated with SimpleStorage.
- capacity_bytes = <sushy.resources.base.Field object>¶
The size of the storage device.
- name = <sushy.resources.base.Field object>¶
The name of the storage device
- status = <sushy.resources.common.StatusField object>¶
Describes the status and health of a storage device.
- class sushy.resources.system.simple_storage.SimpleStorage(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)¶
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.
- devices = <sushy.resources.system.simple_storage.DeviceListField object>¶
The storage devices associated with this resource.
- identity = <sushy.resources.base.Field object>¶
The SimpleStorage identity string
- name = <sushy.resources.base.Field object>¶
The name of the resource
- class sushy.resources.system.simple_storage.SimpleStorageCollection(connector, path, redfish_version=None, registries=None, root=None)¶
Bases:
sushy.resources.base.ResourceCollectionBase
Represents a collection of simple storage associated with system.
- property disks_sizes_bytes¶
Sizes of each Disk in bytes in SimpleStorage collection resource.
Returns the list of cached values until it (or its parent resource) is refreshed.
- property max_size_bytes¶
Max size available (in bytes) among all enabled Disk resources.
Returns the cached value until it (or its parent resource) is refreshed.
sushy.resources.system.system module¶
- class sushy.resources.system.system.ActionsField(*args, **kwargs)¶
Bases:
sushy.resources.base.CompositeField
- reset = <sushy.resources.common.ResetActionField object>¶
- class sushy.resources.system.system.BootField(*args, **kwargs)¶
Bases:
sushy.resources.base.CompositeField
- allowed_values = <sushy.resources.base.Field object>¶
- enabled = <sushy.resources.base.MappedField object>¶
- mode = <sushy.resources.base.MappedField object>¶
- target = <sushy.resources.base.MappedField object>¶
- class sushy.resources.system.system.MemorySummaryField(*args, **kwargs)¶
Bases:
sushy.resources.base.CompositeField
- health = <sushy.resources.base.Field object>¶
The overall health state of memory.
This signifies health state of memory along with its dependent resources.
- size_gib = <sushy.resources.base.Field object>¶
The size of memory of the system in GiB.
This signifies the total installed, operating system-accessible memory (RAM), measured in GiB.
- class sushy.resources.system.system.System(connector, identity, redfish_version=None, registries=None, root=None)¶
Bases:
sushy.resources.base.ResourceBase
- asset_tag = <sushy.resources.base.Field object>¶
The system asset tag
- property bios¶
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.
- bios_version = <sushy.resources.base.Field object>¶
The system BIOS version
- boot = <sushy.resources.system.system.BootField object>¶
A dictionary containing the current boot device, frequency and mode
- property chassis¶
A list of chassis where this system resides.
Returns a list of Chassis objects representing the chassis or cabinets where this system is mounted.
- Raises
MissingAttributeError if ‘@odata.id’ field is missing.
- Returns
A list of Chassis instances
- description = <sushy.resources.base.Field object>¶
The system description
- property ethernet_interfaces¶
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_allowed_reset_system_values()¶
Get the allowed values for resetting the system.
- Returns
A set with the allowed values.
- get_allowed_system_boot_source_values()¶
Get the allowed values for changing the boot source.
- Returns
A set with the allowed values.
- hostname = <sushy.resources.base.Field object>¶
The system hostname
- identity = <sushy.resources.base.Field object>¶
The system identity string
- indicator_led = <sushy.resources.base.MappedField object>¶
Whether the indicator LED is lit or off
- maintenance_window = <sushy.resources.settings.MaintenanceWindowField object>¶
Indicates if a given resource has a maintenance window assignment for applying settings or operations
- property managers¶
A list of managers for this system.
Returns a list of Manager objects representing the managers that manage this system.
- Raises
MissingAttributeError if ‘@odata.id’ field is missing.
- Returns
A list of Manager instances
- manufacturer = <sushy.resources.base.Field object>¶
The system manufacturer
- memory_summary = <sushy.resources.system.system.MemorySummaryField object>¶
The summary info of memory of the system in general detail
- name = <sushy.resources.base.Field object>¶
The system name
- part_number = <sushy.resources.base.Field object>¶
The system part number
- power_state = <sushy.resources.base.MappedField object>¶
The system power state
- property processors¶
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_system(value)¶
Reset the system.
- Parameters
value – The target value.
- Raises
InvalidParameterValueError, if the target value is not allowed.
- property secure_boot¶
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.
- serial_number = <sushy.resources.base.Field object>¶
The system serial number
- set_indicator_led(state)¶
Set IndicatorLED to the given state.
- Parameters
state – Desired LED state, an IndicatorLED value.
- Raises
InvalidParameterValueError, if any information passed is invalid.
- set_system_boot_options(target=None, enabled=None, mode=None)¶
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.
- Parameters
target – The target boot source, a
sushy.BootSource
value. Optional.enabled – How long the override be enabled, a
sushy.BootSourceOverrideEnabled
value. Optional.mode – The boot mode, a
sushy.BootSourceOverrideMode
value. Optional.
- Raises
InvalidParameterValueError, if any information passed is invalid.
- set_system_boot_source(target, enabled=BootSourceOverrideEnabled.ONCE, mode=None)¶
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.
- Parameters
target – The target boot source, a
sushy.BootSource
value.enabled – The frequency, whether to set it for the next a
sushy.BootSourceOverrideEnabled
value. Default is ONCE.mode – The boot mode, a
sushy.BootSourceOverrideMode
value.
- Raises
InvalidParameterValueError, if any information passed is invalid.
- property simple_storage¶
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.
- Raises
MissingAttributeError if ‘SimpleStorage/@odata.id’ field is missing.
- Returns
SimpleStorageCollection instance
- sku = <sushy.resources.base.Field object>¶
The system stock-keeping unit
- status = <sushy.resources.common.StatusField object>¶
The system status
- property storage¶
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.
- Raises
MissingAttributeError if ‘Storage/@odata.id’ field is missing.
- Returns
StorageCollection instance
- system_type = <sushy.resources.base.MappedField object>¶
The system type
- uuid = <sushy.resources.base.Field object>¶
The system UUID
- class sushy.resources.system.system.SystemCollection(connector, path, redfish_version=None, registries=None, root=None)¶