The 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)

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.

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, lit (INDICATOR_LED_LIT), blinking (INDICATOR_LED_BLINKING), off (INDICATOR_LED_OFF)

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, 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.

Raises

InvalidParameterValueError, if any information passed is invalid.

set_system_boot_source(target, enabled='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.

• 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.

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)

Bases: sushy.resources.base.ResourceCollectionBase