The rsd_lib.resources.v2_1.system.system Module

class rsd_lib.resources.v2_1.system.system.ActionsField(*args, **kwargs)

Bases: sushy.resources.base.CompositeField

reset = <sushy.resources.common.ResetActionField object>

class rsd_lib.resources.v2_1.system.system.BootField(*args, **kwargs)

Bases: sushy.resources.base.CompositeField

Boot field

This object contains the boot information for the current resource.

boot_source_override_enabled = <sushy.resources.base.Field object>

Describes the state of the Boot Source Override feature

boot_source_override_mode = <sushy.resources.base.Field object>

The BIOS Boot Mode (either Legacy or UEFI) to be used when BootSourceOverrideTarget boot source is booted from.

boot_source_override_mode_allowed_values = <sushy.resources.base.Field object>

boot_source_override_target = <sushy.resources.base.Field object>

The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is true.

boot_source_override_target_allowed_values = <sushy.resources.base.Field object>

uefi_target_boot_source_override = <sushy.resources.base.Field object>

This property is the UEFI Device Path of the device to boot from when BootSourceOverrideSupported is UefiTarget.

class rsd_lib.resources.v2_1.system.system.IntelRackScaleField(*args, **kwargs)

Bases: sushy.resources.base.CompositeField

discovery_state = <sushy.resources.base.Field object>

This indicates computer system discovery state

memory_sockets = <sushy.resources.base.Field object>

This indicates number of memory sockets available in system

pci_devices = <rsd_lib.resources.v2_1.system.system.PciDeviceCollectionField object>

This indicates array of PCI devices present in computer system

pcie_connection_id = <sushy.resources.base.Field object>

This property is an array of IDs of cable or cables connected to this port.

processor_sockets = <sushy.resources.base.Field object>

This indicates number of processor sockets available in system

class rsd_lib.resources.v2_1.system.system.LinksField(*args, **kwargs)

Bases: sushy.resources.base.CompositeField

chassis = <sushy.resources.base.Field object>

An array of references to the chassis in which this system is contained

cooled_by = <sushy.resources.base.Field object>

An array of ID[s] of resources that cool this computer system. Normally the ID will be a chassis or a specific set of fans.

endpoints = <sushy.resources.base.Field object>

An array of references to the endpoints that connect to this system.

managed_by = <sushy.resources.base.Field object>

An array of references to the Managers responsible for this system

powered_by = <sushy.resources.base.Field object>

An array of ID[s] of resources that power this computer system. Normally the ID will be a chassis or a specific set of powerSupplies

class rsd_lib.resources.v2_1.system.system.MemorySummaryField(*args, **kwargs)

Bases: sushy.resources.base.CompositeField

MemorySummary field

This object describes the memory of the system in general detail.

status = <rsd_lib.base.StatusField object>

This indicates the known state of the resource, such as if it is enabled.

total_system_memory_gib = <sushy.resources.base.Field object>

The total installed, operating system-accessible memory (RAM), measured in GiB.

class rsd_lib.resources.v2_1.system.system.OemField(*args, **kwargs)

Bases: sushy.resources.base.CompositeField

intel_rackscale = <rsd_lib.resources.v2_1.system.system.IntelRackScaleField object>

Intel Rack Scale Design specific properties.

class rsd_lib.resources.v2_1.system.system.PciDeviceCollectionField(*args, **kwargs)

Bases: sushy.resources.base.ListField

device_id = <sushy.resources.base.Field object>

vendor_id = <sushy.resources.base.Field object>

class rsd_lib.resources.v2_1.system.system.ProcessorSummaryField(*args, **kwargs)

Bases: sushy.resources.base.CompositeField

ProcessorSummary field

This object describes the central processors of the system in general detail.

count = <sushy.resources.base.Field object>

The number of processors in the system.

model = <sushy.resources.base.Field object>

The processor model for the primary or majority of processors in this system.

status = <rsd_lib.base.StatusField object>

This indicates the known state of the resource, such as if it is enabled.

class rsd_lib.resources.v2_1.system.system.System(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)

Bases: rsd_lib.base.ResourceBase

ComputerSystem resource class

This schema defines a computer system and its respective properties. A computer system represents a machine (physical or virtual) and the local resources such as memory, cpu and other devices that can be accessed from that machine.

asset_tag = <sushy.resources.base.Field object>

The user definable tag that can be used to track this computer system for inventory or other client purposes

bios_version = <sushy.resources.base.Field object>

The version of the system BIOS or primary system firmware.

boot = <rsd_lib.resources.v2_1.system.system.BootField object>

Information about the boot settings for this system

property ethernet_interfaces

Property to provide reference to EthernetInterfaceCollection instance

It is calculated once when it is queried for the first time. On refresh, this property is reset.

get_allowed_reset_system_values()

Get the allowed values for resetting the system.

Returns

A set with the allowed values.

get_allowed_system_boot_mode_values()

Get the allowed values for the boot source mode.

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.

host_name = <sushy.resources.base.Field object>

The DNS Host Name, without any domain information

hosting_roles = <sushy.resources.base.Field object>

The hosing roles that this computer system supports.

indicator_led = <sushy.resources.base.Field object>

The state of the indicator LED, used to identify the system

links = <rsd_lib.resources.v2_1.system.system.LinksField object>

Contains references to other resources that are related to this resource.

property log_services

Property to provide reference to LogServiceCollection instance

It is calculated once when it is queried for the first time. On refresh, this property is reset.

manufacturer = <sushy.resources.base.Field object>

The manufacturer or OEM of this system.

property memory

Property to provide reference to MemoryCollection instance

It is calculated once when it is queried for the first time. On refresh, this property is reset.

memory_summary = <rsd_lib.resources.v2_1.system.system.MemorySummaryField object>

This object describes the central memory of the system in general detail.

model = <sushy.resources.base.Field object>

The model number for this system

property network_interfaces

Property to provide reference to NetworkInterfaceCollection instance

It is calculated once when it is queried for the first time. On refresh, this property is reset.

oem = <rsd_lib.resources.v2_1.system.system.OemField object>

Oem specific properties.

part_number = <sushy.resources.base.Field object>

The part number for this system

property pcie_devices

Property to provide a list of PCIeDevice instance

It is calculated once when it is queried for the first time. On refresh, this property is reset.

property pcie_functions

Property to provide a list of PCIeFunction instance

It is calculated once when it is queried for the first time. On refresh, this property is reset.

power_state = <sushy.resources.base.Field object>

This is the current power state of the system

processor_summary = <rsd_lib.resources.v2_1.system.system.ProcessorSummaryField object>

This object describes the central processors of the system in general detail.

property processors

Property to provide reference to ProcessorCollection instance

It is calculated once when it is queried for the first time. On refresh, this property is reset.

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 serial number for this system

set_system_boot_source(target, enabled='Once', mode=None)

Set the boot source.

Set the boot source to use on next reboot of the System.

Parameters

• target – The target boot source.

• enabled – The frequency, whether to set it for the next reboot only (“Once”) or persistent to all future reboots (“Continuous”) or disabled (“Disabled”).

• mode – The boot mode, UEFI (“UEFI”) or BIOS (“Legacy”).

Raises

InvalidParameterValueError, if any information passed is invalid.

property simple_storage

Property to provide reference to SimpleStorageCollection instance

It is calculated once when it is queried for the first time. On refresh, this property is reset.

sku = <sushy.resources.base.Field object>

The manufacturer SKU for this system

status = <rsd_lib.base.StatusField object>

This indicates the known state of the resource, such as if it is enabled.

property storage

Property to provide reference to StorageCollection instance

It is calculated once when it is queried for the first time. On refresh, this property is reset.

system_type = <sushy.resources.base.Field object>

The type of computer system represented by this resource.

update(asset_tag)

Update AssetTag

Parameters

asset_tag – The user assigned asset tag for this computer system

uuid = <sushy.resources.base.Field object>

The universal unique identifier (UUID) for this system

class rsd_lib.resources.v2_1.system.system.SystemCollection(connector, path, redfish_version=None, registries=None, root=None)

Bases: rsd_lib.base.ResourceCollectionBase