Systems

ActionInfo 1.4.2⁠


Version	v1.4
Release	2023.2

Description⁠

The ActionInfo schema defines the supported parameters and other information for a Redfish action. Supported parameters can differ among vendors and even among resource instances. This data can ensure that action requests from applications contain supported parameters.

Properties⁠

Property	Type	Attributes	Notes
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
Parameters [ {	array		The list of parameters included in the specified Redfish action.
AllowableNumbers (v1.3+) [ ]	array (string, null)	read-only	The allowable numeric values or duration values, inclusive ranges of values, and incremental step values for this parameter as applied to this action target.
AllowablePattern (v1.3+)	string	read-only (null)	The allowable pattern for this parameter as applied to this action target.
AllowableValueDescriptions (v1.4+) [ ]	array (string, null)	read-only	Descriptions of allowable values for this parameter.
AllowableValues [ ]	array (string, null)	read-only	The allowable values for this parameter as applied to this action target.
ArraySizeMaximum (v1.2+)	integer	read-only (null)	The maximum number of array elements allowed for this parameter.
ArraySizeMinimum (v1.2+)	integer	read-only (null)	The minimum number of array elements required for this parameter.
DataType	string (enum)	read-only (null)	The JSON property type for this parameter. For the possible property values, see DataType in Property details.
MaximumValue (v1.1+)	number	read-only (null)	The maximum supported value for this parameter.
MinimumValue (v1.1+)	number	read-only (null)	The minimum supported value for this parameter.
Name	string	read-only required	The name of the parameter for this action.
ObjectDataType	string	read-only (null)	The data type of an object-based parameter.
Required	boolean	read-only	An indication of whether the parameter is required to complete this action.
} ]

Property details⁠

DataType⁠

The JSON property type for this parameter.

string	Description
Boolean	A boolean.
Number	A number.
NumberArray	An array of numbers.
Object	An embedded JSON object.
ObjectArray	An array of JSON objects.
String	A string.
StringArray	An array of strings.

Example response⁠

{
    "@odata.type": "#ActionInfo.v1_5_0.ActionInfo",
    "Id": "ResetActionInfo",
    "Name": "Reset Action Info",
    "Parameters": [
        {
            "Name": "ResetType",
            "Required": true,
            "DataType": "String",
            "AllowableValues": [
                "On",
                "ForceOff",
                "GracefulShutdown",
                "GracefulRestart",
                "ForceRestart",
                "Nmi",
                "ForceOn",
                "PushPowerButton"
            ]
        }
    ],
    "@odata.id": "/redfish/v1/Systems/1/ResetActionInfo"
}

Bios 1.2.3⁠


Version	v1.2
Release	2021.1

Description⁠

The Bios schema contains properties related to the BIOS attribute registry. The attribute registry describes the system-specific BIOS attributes and actions for changing to BIOS settings. Changes to the BIOS typically require a system reset before they take effect. It is likely that a client finds the @Redfish.Settings term in this resource, and if it is found, the client makes requests to change BIOS settings by modifying the resource identified by the @Redfish.Settings term.

URIs⁠

/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Bios
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Bios
/redfish/v1/Systems/{ComputerSystemId}/Bios

Properties⁠

Property	Type	Attributes	Notes
Actions {	object		The available actions for this resource.
#Bios.ChangePassword {}	object		This action changes a BIOS password. For more information, see the Actions section below.
#Bios.ResetBios {}	object		This action resets the BIOS attributes to default. For more information, see the Actions section below.
}
AttributeRegistry	string	read-only (null)	The resource ID of the attribute registry that has the system-specific information about a BIOS resource.
Attributes {	object		The list of BIOS attributes specific to the manufacturer or provider.
(pattern)	string, boolean, number	read-write (null)	Property names follow regular expression pattern "^[A-Za-z][A-Za-z0-9_]+$"
}
Links (v1.1+) {	object		The links to other resources that are related to this resource.
ActiveSoftwareImage (v1.1+) {	object		The link to the software inventory that represents the active BIOS firmware image.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
}
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
SoftwareImages (v1.1+) [ {	array		The images that are associated with this BIOS.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
}
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
ResetBiosToDefaultsPending (v1.2+)	boolean	read-only (null)	An indication of whether there is a pending request to reset the BIOS attributes to default values.

Actions⁠

ChangePassword⁠

Description

This action changes a BIOS password.

Action URI

{Base URI of target resource}/Actions/Bios.ChangePassword

Action parameters

Parameter Name	Type	Attributes	Notes
NewPassword	string	required	The new BIOS password.
OldPassword	string	required	The existing BIOS password.
PasswordName	string	required	The name of the BIOS password to change.

Request Example

{
    "OldPassword": "secret123",
    "NewPassword": "B3tterS3cur1tY!",
    "PasswordName": "Admin"
}

ResetBios⁠

Description

This action resets the BIOS attributes to default.

Action URI

{Base URI of target resource}/Actions/Bios.ResetBios

Action parameters

This action takes no parameters.

Example response⁠

{
    "@odata.type": "#Bios.v1_2_3.Bios",
    "Id": "BIOS",
    "Name": "BIOS Configuration Current Settings",
    "AttributeRegistry": "BiosAttributeRegistryP89.v1_0_0",
    "Attributes": {
        "AdminPhone": "",
        "BootMode": "Uefi",
        "EmbeddedSata": "Raid",
        "NicBoot1": "NetworkBoot",
        "NicBoot2": "Disabled",
        "PowerProfile": "MaxPerf",
        "ProcCoreDisable": 0,
        "ProcHyperthreading": "Enabled",
        "ProcTurboMode": "Enabled",
        "UsbControl": "UsbEnabled"
    },
    "@Redfish.Settings": {
        "@odata.type": "#Settings.v1_4_0.Settings",
        "ETag": "9234ac83b9700123cc32",
        "Messages": [
            {
                "MessageId": "Base.1.0.SettingsFailed",
                "RelatedProperties": [
                    "/Attributes/ProcTurboMode"
                ]
            }
        ],
        "SettingsObject": {
            "@odata.id": "/redfish/v1/Systems/437XR1138R2/Bios/Settings"
        },
        "Time": "2016-03-07T14:44.30-05:00"
    },
    "Actions": {
        "#Bios.ResetBios": {
            "target": "/redfish/v1/Systems/437XR1138R2/Bios/Actions/Bios.ResetBios"
        },
        "#Bios.ChangePassword": {
            "target": "/redfish/v1/Systems/437XR1138R2/Bios/Actions/Bios.ChangePassword"
        }
    },
    "@odata.id": "/redfish/v1/Systems/437XR1138R2/Bios"
}

ComputerSystem 1.25.0⁠


Version	v1.25
Release	2025.2

Description⁠

The ComputerSystem schema represents a computer or system instance and the software-visible resources, or items within the data plane, such as memory, CPU, and other devices that it can access. Details of those resources or subsystems are also linked through this resource.

URIs⁠

/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}
/redfish/v1/Systems/{ComputerSystemId}

Properties⁠

Property	Type	Attributes	Notes
Actions {	object		The available actions for this resource.
#ComputerSystem.AddResourceBlock (v1.6+) {}	object		This action adds a resource block to a system. For more information, see the Actions section below.
#ComputerSystem.Decommission (v1.21+) {}	object		This action decommissions a system. For more information, see the Actions section below.
#ComputerSystem.RemoveResourceBlock (v1.6+) {}	object		This action removes a resource block from a system. For more information, see the Actions section below.
#ComputerSystem.Reset {}	object		This action resets the system. For more information, see the Actions section below.
#ComputerSystem.SetDefaultBootOrder (v1.5+) {}	object		This action sets the `BootOrder` property to the default settings. For more information, see the Actions section below.
}
AssetTag	string	read-write (null)	The user-definable tag that can track this computer system for inventory or other client purposes.
Bios (v1.1+) {}	object		The link to the BIOS settings associated with this system.
BiosVersion	string	read-only (null)	The version of the system BIOS or primary system firmware.
Boot {	object		The boot settings for this system.
AliasBootOrder (v1.6+) [ ]	array (string (enum))	read-write (null)	Ordered array of boot source aliases representing the persistent boot order associated with this computer system. For the possible property values, see AliasBootOrder in Property details.
AutomaticRetryAttempts (v1.11+)	integer	read-write (null)	The number of attempts the system will automatically retry booting.
AutomaticRetryConfig (v1.11+)	string (enum)	read-write (null)	The configuration of how the system retries booting automatically. For the possible property values, see AutomaticRetryConfig in Property details.
BootNext (v1.5+)	string	read-write (null)	The `BootOptionReference` of the Boot Option to perform a one-time boot from when `BootSourceOverrideTarget` is `UefiBootNext`.
BootOptions (v1.5+) {}	object		The link to the collection of the UEFI boot options associated with this computer system.
BootOrder (v1.5+) [ ]	array (string, null)	read-write	An array of `BootOptionReference` strings that represent the persistent boot order for with this computer system. Changes to the boot order typically require a system reset before they take effect. It is likely that a client finds the `@Redfish.Settings` term in this resource, and if it is found, the client makes requests to change boot order settings by modifying the resource identified by the `@Redfish.Settings` term.
BootOrderPropertySelection (v1.6+)	string (enum)	read-write (null)	The name of the boot order property that the system uses for the persistent boot order. For the possible property values, see BootOrderPropertySelection in Property details.
BootSourceOverrideEnabled	string (enum)	read-write (null)	The state of the boot source override feature. For the possible property values, see BootSourceOverrideEnabled in Property details.
BootSourceOverrideMode (v1.1+)	string (enum)	read-write (null)	The BIOS boot mode to use when the system boots from the `BootSourceOverrideTarget` boot source. For the possible property values, see BootSourceOverrideMode in Property details.
BootSourceOverrideTarget	string (enum)	read-write (null)	The current boot source to use at the next boot instead of the normal boot device, if `BootSourceOverrideEnabled` does not contain `Disabled`. For the possible property values, see BootSourceOverrideTarget in Property details.
Certificates (v1.7+) {}	object		The link to a collection of certificates used for booting through HTTPS by this computer system.
HttpBootUri (v1.9+)	string (URI)	read-write (null)	The URI to boot from when `BootSourceOverrideTarget` is set to `UefiHttp`.
RemainingAutomaticRetryAttempts (v1.11+)	integer	read-only (null)	The number of remaining automatic retry boots.
StopBootOnFault (v1.15+)	string (enum)	read-write (null)	If the boot should stop on a fault. For the possible property values, see StopBootOnFault in Property details.
TrustedModuleRequiredToBoot (v1.14+)	string (enum)	read-write (null)	The Trusted Module boot requirement. For the possible property values, see TrustedModuleRequiredToBoot in Property details.
UefiTargetBootSourceOverride	string	read-write (null)	The UEFI device path of the device from which to boot when `BootSourceOverrideTarget` is `UefiTarget`.
}
BootProgress (v1.13+) {	object	(null)	This object describes the last boot progress state.
LastBootTimeSeconds (v1.18+)	number	read-only (null)	The number of seconds the system spent booting to the operating system during the last boot.
LastState (v1.13+)	string (enum)	read-only (null)	The last boot progress state. For the possible property values, see LastState in Property details.
LastStateTime (v1.13+)	string (date-time)	read-only (null)	The date and time when the last boot state was updated.
Oem (v1.13+) {}	object		The OEM extension property. See the Resource schema for details on this property.
OemLastState (v1.13+)	string	read-only (null)	The OEM-specific last state, if the LastState type is `OEM`.
}
Certificates (v1.14+) {}	object		The link to a collection of certificates for device identity and attestation.
Composition (v1.18+) {	object	(null)	Information about the composition capabilities and state of the computer system.
UseCases (v1.18+) [ ]	array (string (enum))	read-only (null)	The composition use cases in which this computer system can participate. For the possible property values, see UseCases in Property details.
}
EthernetInterfaces {}	object		The link to the collection of Ethernet interfaces associated with this system.
FabricAdapters (v1.10+) {}	object		The link to the collection of fabric adapters associated with this system.
GraphicalConsole (v1.13+) {	object		The information about the graphical console (KVM-IP) service of this system.
ConnectTypesSupported (v1.13+) [ ]	array (string (enum))	read-only	This property enumerates the graphical console connection types that the implementation allows. For the possible property values, see ConnectTypesSupported in Property details.
MaxConcurrentSessions (v1.13+)	integer	read-only	The maximum number of service sessions, regardless of protocol, that this system can support.
Port (v1.13+)	integer	read-write (null)	The protocol port.
ServiceEnabled (v1.13+)	boolean	read-write	An indication of whether the service is enabled for this system.
}
GraphicsControllers (v1.15+) {}	object		The link to a collection of graphics controllers that can output video for this system.
HostedServices (v1.2+) {	object		The services that this computer system supports.
Oem (v1.2+) {}	object		The OEM extension property. See the Resource schema for details on this property.
StorageServices (v1.2+) {}	object		The link to a collection of storage services that this computer system supports.
}
HostingRoles (v1.2+) [ ]	array (string (enum))	read-only	The hosting roles that this computer system supports. For the possible property values, see HostingRoles in Property details.
HostName	string	read-write (null)	The DNS host name, without any domain information.
HostWatchdogTimer (v1.5+) {	object		The host watchdog timer functionality for this system.
FunctionEnabled (v1.5+)	boolean	read-write required (null)	An indication of whether a user has enabled the host watchdog timer functionality. This property indicates only that a user has enabled the timer. To activate the timer, installation of additional host-based software is necessary; an update to this property does not initiate the timer.
Oem (v1.5+) {}	object		The OEM extension property. See the Resource schema for details on this property.
Status (v1.5+) {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
TimeoutAction (v1.5+)	string (enum)	read-write required (null)	The action to perform when the watchdog timer reaches its timeout value. For the possible property values, see TimeoutAction in Property details.
WarningAction (v1.5+)	string (enum)	read-write (null)	The action to perform when the watchdog timer is close to reaching its timeout value. This action typically occurs from three to ten seconds before to the timeout value, but the exact timing is dependent on the implementation. For the possible property values, see WarningAction in Property details.
}
IdlePowerSaver (v1.16+) {	object	(null)	The idle power saver settings of the computer system.
Enabled (v1.16+)	boolean	read-write	An indication of whether idle power saver is enabled.
EnterDwellTimeSeconds (v1.16+)	integer (s)	read-write (null)	The duration in seconds the computer system is below the `EnterUtilizationPercent` value before the idle power save is activated.
EnterUtilizationPercent (v1.16+)	number (%)	read-write (null)	The percentage of utilization when the computer system enters idle power save. If the computer system's utilization goes below this value, it enters idle power save.
ExitDwellTimeSeconds (v1.16+)	integer (s)	read-write (null)	The duration in seconds the computer system is above the `ExitUtilizationPercent` value before the idle power save is stopped.
ExitUtilizationPercent (v1.16+)	number (%)	read-write (null)	The percentage of utilization when the computer system exits idle power save. If the computer system's utilization goes above this value, it exits idle power save.
}
IndicatorLED (deprecated v1.13)	string (enum)	read-write (null)	The state of the indicator LED, which identifies the system. For the possible property values, see IndicatorLED in Property details. Deprecated in v1.13 and later. This property has been deprecated in favor of the `LocationIndicatorActive` property.
IPMIHostInterface (v1.25+) {	object		The information about the in-band IPMI service of this system.
ServiceEnabled (v1.25+)	boolean	read-write	An indication of whether the service is enabled for this system.
}
KeyManagement (v1.16+) {	object	(null)	The key management settings of the computer system.
KMIPCertificates (v1.16+) {}	object		The link to a collection of server certificates for the servers referenced by the `KMIPServers` property.
KMIPServers (v1.16+) [ {	array		The KMIP servers to which this computer system is subscribed.
Address (v1.16+)	string	read-write (null)	The KMIP server address.
CacheDuration (v1.20+)	string (duration)	read-write (null)	The duration the system caches KMIP data.
CachePolicy (v1.20+)	string (enum)	read-write (null)	The cache policy to control how KMIP data is cached. For the possible property values, see CachePolicy in Property details.
Password (v1.16+)	string	read-write (null)	The password to access the KMIP server. The value is `null` in responses.
Port (v1.16+)	integer	read-write (null)	The KMIP server port.
Username (v1.16+)	string	read-write (null)	The username to access the KMIP server.
} ]
}
LastResetCause (v1.23+)	string (enum)	read-only	The last reset cause of the system. For the possible property values, see LastResetCause in Property details.
LastResetTime (v1.12+)	string (date-time)	read-only	The date and time when the system was last reset or rebooted.
Links {	object		The links to other resources that are related to this resource.
Chassis [ {	array		An array of links to the chassis that contains this system.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ConsumingComputerSystems (v1.5+) [ {	array		An array of links to computer systems that are realized, in whole or in part, from this computer system.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
CooledBy [ {	array		An array of links to resources or objects that cool this computer system. Normally, the link is for either a chassis or a specific set of fans.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Endpoints (v1.2+) [ {	array		An array of links to the endpoints that connect to this system.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
HostingComputerSystem (v1.21+) {}	object	(null)	The link to the system that is hosting this virtual machine.
ManagedBy [ {	array		An array of links to the managers responsible for this system.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
OffloadedNetworkDeviceFunctions (v1.17+) [ {	array		The network device functions to which this system performs offload computation, such as with a SmartNIC.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
PoweredBy [ {	array		An array of links to resources or objects that power this computer system. Normally, the link is for either a chassis or a specific set of power supplies.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ResourceBlocks (v1.4+) [ {	array		An array of links to the resource blocks that are used in this computer system.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
SupplyingComputerSystems (v1.5+) [ {	array		An array of links to computer systems that contribute, in whole or in part, to the implementation of this computer system.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
TrustedComponents (v1.19+) [ {	array		An array of links to the trusted components for this system.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
VirtualMachines (v1.21+) [ {	array		An array of links to the virtual machines this system is hosting.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
}
LocationIndicatorActive (v1.13+)	boolean	read-write (null)	An indicator allowing an operator to physically locate this resource.
LogServices {}	object		The link to the collection of log services associated with this system.
Manufacturer	string	read-only (null)	The manufacturer or OEM of this system.
ManufacturingMode (v1.18+)	boolean	read-only (null)	An indication of whether the system is in manufacturing mode. Manufacturing mode is a special boot mode, not normally available to end users, that modifies features and settings for use while the system is being manufactured and tested.
Measurements (v1.14+, deprecated v1.17) [ { } ]	array (object)		An array of DSP0274-defined measurement blocks. See the SoftwareInventory.v1_13_0 schema for details on this property. Deprecated in v1.17 and later. This property has been deprecated in favor of the `ComponentIntegrity` resource.
Memory (v1.1+) {}	object		The link to the collection of memory associated with this system.
MemoryDomains (v1.2+) {}	object		The link to the collection of memory domains associated with this system.
MemorySummary {	object		The central memory of the system in general detail.
MemoryMirroring (v1.1+)	string (enum)	read-only (null)	The ability and type of memory mirroring that this computer system supports. For the possible property values, see MemoryMirroring in Property details.
Metrics (v1.8+) {}	object		The link to the metrics associated with all memory in this system.
Status (deprecated v1.16) {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property. Deprecated in v1.16 and later. This property has been deprecated in favor of the `Conditions` property within `Status` in the root of this resource.
TotalSystemMemoryGiB	number (GiBy)	read-only (null)	The total configured operating system-accessible memory (RAM), measured in GiB.
TotalSystemPersistentMemoryGiB (v1.4+)	number (GiBy)	read-only (null)	The total configured, system-accessible persistent memory, measured in GiB.
}
Model	string	read-only (null)	The product name for this system, without the manufacturer name.
NetworkInterfaces (v1.3+) {}	object		The link to the collection of Network Interfaces associated with this system.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
OperatingSystem (v1.21+) {}	object		The link to the operating system information associated with this system.
PartNumber	string	read-only (null)	The part number for this system.
PCIeDevices (v1.2+) [ {	array		The link to a collection of PCIe devices that this computer system uses.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
PCIeFunctions (v1.2+) [ {	array		The link to a collection of PCIe functions that this computer system uses.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
PowerCycleDelaySeconds (v1.13+)	number	read-write (null)	The number of seconds to delay power on after a `Reset` action requesting `PowerCycle` or `FullPowerCycle`. Zero seconds indicates no delay.
PowerMode (v1.15+)	string (enum)	read-write (null)	The power mode setting of the computer system. For the possible property values, see PowerMode in Property details.
PowerOffDelaySeconds (v1.13+)	number	read-write (null)	The number of seconds to delay power off during a reset. Zero seconds indicates no delay to power off.
PowerOnDelaySeconds (v1.13+)	number	read-write (null)	The number of seconds to delay power on after an externally performed power cycle or during a reset. Zero seconds indicates no delay to power up.
PowerRestorePolicy (v1.6+)	string (enum)	read-write	The desired power state of the system when power is restored after a power loss. For the possible property values, see PowerRestorePolicy in Property details.
PowerState	string (enum)	read-only (null)	The current power state of the system. For the possible property values, see PowerState in Property details.
Processors {}	object		The link to the collection of processors associated with this system.
ProcessorSummary {	object		The central processors of the system in general detail.
CoreCount (v1.14+)	integer	read-only (null)	The number of processor cores in the system.
Count	integer	read-only (null)	The number of physical processors in the system.
LogicalProcessorCount (v1.5+)	integer	read-only (null)	The number of logical processors in the system.
Metrics (v1.7+) {}	object		The link to the metrics associated with all processors in this system.
Model	string	read-only (null)	The processor model for the primary or majority of processors in this system.
Status (deprecated v1.16) {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property. Deprecated in v1.16 and later. This property has been deprecated in favor of the `Conditions` property within `Status` in the root of this resource.
ThreadingEnabled (v1.15+)	boolean	read-write	An indication of whether threading is enabled on all processors in this system.
}
Redundancy (v1.5+) [ {	array		The link to a collection of redundancy entities. Each entity specifies a kind and level of redundancy and a collection, or redundancy set, of other computer systems that provide the specified redundancy to this computer system.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
SecureBoot (v1.1+) {}	object		The link to the UEFI Secure Boot associated with this system.
SerialConsole (v1.13+) {	object		The serial console services that this system provides.
IPMI (v1.13+) {}	object		The connection details for an IPMI Serial-over-LAN service. For more information about this property, see SerialConsoleProtocol in Property Details.
MaxConcurrentSessions (v1.13+)	integer	read-only	The maximum number of service sessions, regardless of protocol, that this system can support.
SSH (v1.13+) {}	object		The connection details for an SSH serial console service. For more information about this property, see SerialConsoleProtocol in Property Details.
Telnet (v1.13+) {}	object		The connection details for a Telnet serial console service. For more information about this property, see SerialConsoleProtocol in Property Details.
}
SerialNumber	string	read-only (null)	The serial number for this system.
SimpleStorage {}	object		The link to the collection of storage devices associated with this system.
SKU	string	read-only (null)	The manufacturer SKU for this system.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
Storage (v1.1+) {}	object		The link to the collection of storage devices associated with this system.
SubModel (v1.5+)	string	read-only (null)	The sub-model for this system.
SystemType	string (enum)	read-only	The type of computer system that this resource represents. For the possible property values, see SystemType in Property details.
TrustedModules (v1.1+, deprecated v1.19) [ {	array		An array of trusted modules in the system. Deprecated in v1.19 and later. This property has been deprecated in favor of the `TrustedComponents` property in `Links`.
FirmwareVersion (v1.1+)	string	read-only (null)	The firmware version of this Trusted Module.
FirmwareVersion2 (v1.3+)	string	read-only (null)	The second firmware version of this Trusted Module, if applicable.
InterfaceType (v1.1+)	string (enum)	read-only (null)	The interface type of the Trusted Module. For the possible property values, see InterfaceType in Property details.
InterfaceTypeSelection (v1.3+)	string (enum)	read-only (null)	The interface type selection supported by this Trusted Module. For the possible property values, see InterfaceTypeSelection in Property details.
Oem (v1.1+) {}	object		The OEM extension property. See the Resource schema for details on this property.
Status (v1.1+) {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
} ]
USBControllers (v1.15+) {}	object		The link to a collection of USB controllers for this system.
UUID	string (uuid)	read-only (null)	The UUID for this system.
VirtualMedia (v1.13+) {}	object		The link to the virtual media services for this system.
VirtualMediaConfig (v1.13+) {	object		The information about the virtual media service of this system.
Port (v1.13+)	integer	read-write (null)	The protocol port.
ServiceEnabled (v1.13+)	boolean	read-write	An indication of whether the service is enabled for this system.
}

Actions⁠

AddResourceBlock (v1.6+)⁠

Description

This action adds a resource block to a system.

Action URI

{Base URI of target resource}/Actions/ComputerSystem.AddResourceBlock

Action parameters

Parameter Name	Type	Attributes	Notes
ComputerSystemETag	string	optional	The current ETag of the system.
ResourceBlock {}	object	required	The resource block to add to the system.
ResourceBlockETag	string	optional	The current ETag of the resource block to add to the system.

Request Example

{
    "ResourceBlock": {
        "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Offload-GPU1"
    },
    "ResourceBlockETag": "W/\"19472363938\"",
    "ComputerSystemETag": "W/\"99374369273\""
}

Decommission (v1.21+)⁠

Description

This action decommissions a system.

Action URI

{Base URI of target resource}/Actions/ComputerSystem.Decommission

Action parameters

Parameter Name	Type	Attributes	Notes
ComputerSystemETag	string	optional	The current ETag of the system.
DecommissionTypes [ ]	array (string (enum))	read-write	The types of data to remove from the system. For the possible property values, see DecommissionTypes in Property details.
OEMDecommissionTypes [ ]	array (string)	optional	The OEM-specific types of data to remove from the system.
RequireSecureErase	boolean	optional	Ensure secure erasure of all devices and fail the request if not possible.

Request Example

{
    "DecommissionTypes": [
        "All"
    ],
    "RequireSecureErase": false
}

RemoveResourceBlock (v1.6+)⁠

Description

This action removes a resource block from a system.

Action URI

{Base URI of target resource}/Actions/ComputerSystem.RemoveResourceBlock

Action parameters

Parameter Name	Type	Attributes	Notes
ComputerSystemETag	string	optional	The current ETag of the system.
ResourceBlock {}	object	required	The resource block to remove from the system.
ResourceBlockETag	string	optional	The current ETag of the resource block to remove from the system.

Request Example

{
    "ResourceBlock": {
        "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Offload-GPU1"
    },
    "ResourceBlockETag": "W/\"19472363938\"",
    "ComputerSystemETag": "W/\"99374369273\""
}

Reset⁠

Description

This action resets the system.

Action URI

{Base URI of target resource}/Actions/ComputerSystem.Reset

Action parameters

Parameter Name	Type	Attributes	Notes
ResetType	string (enum)	optional	The type of reset. For the possible property values, see ResetType in Property details.

Request Example

{
    "ResetType": "ForceRestart"
}

SetDefaultBootOrder (v1.5+)⁠

Description

This action sets the BootOrder property to the default settings.

Action URI

{Base URI of target resource}/Actions/ComputerSystem.SetDefaultBootOrder

Action parameters

This action takes no parameters.

Property details⁠

AliasBootOrder⁠

Ordered array of boot source aliases representing the persistent boot order associated with this computer system.

string	Description
BiosSetup	Boot to the BIOS setup utility.
Cd	Boot from the CD or DVD.
Diags	Boot to the manufacturer's diagnostics program.
Floppy	Boot from the floppy disk drive.
Hdd	Boot from a hard drive.
None	Boot from the normal boot device.
Pxe	Boot from the Pre-boot eXecution Environment (PXE).
Recovery	Boot to a system-designated recovery process or image.
RemoteDrive	Boot from a remote drive, such as an iSCSI target.
SDCard	Boot from an SD card.
UefiBootNext	Boot to the UEFI device that the `BootNext` property specifies.
UefiHttp	Boot from a UEFI HTTP network location.
UefiShell	Boot to the UEFI Shell.
UefiTarget	Boot to the UEFI device specified in the `UefiTargetBootSourceOverride` property.
Usb	Boot from a system BIOS-specified USB device.
Utilities	Boot to the manufacturer's utilities program or programs.

AutomaticRetryConfig⁠

The configuration of how the system retries booting automatically.

string	Description
Disabled	Disable automatic retrying of booting.
RetryAlways	Always automatically retry booting.
RetryAttempts	Automatic retrying of booting is based on a specified retry count.

BootOrderPropertySelection⁠

The name of the boot order property that the system uses for the persistent boot order.

string	Description
AliasBootOrder	The system uses the `AliasBootOrder` property to specify the persistent boot order.
BootOrder	The system uses the `BootOrder` property to specify the persistent boot order.

BootSourceOverrideEnabled⁠

The state of the boot source override feature.

string	Description
Continuous	The system boots to the target specified in the `BootSourceOverrideTarget` property until this property is `Disabled`.
Disabled	The system boots normally.
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`.

BootSourceOverrideMode⁠

The BIOS boot mode to use when the system boots from the BootSourceOverrideTarget boot source.

string	Description
Legacy	The system boots in non-UEFI boot mode to the boot source override target.
UEFI	The system boots in UEFI boot mode to the boot source override target.

BootSourceOverrideTarget⁠

The current boot source to use at the next boot instead of the normal boot device, if BootSourceOverrideEnabled does not contain Disabled.

string	Description
BiosSetup	Boot to the BIOS setup utility.
Cd	Boot from the CD or DVD.
Diags	Boot to the manufacturer's diagnostics program.
Floppy	Boot from the floppy disk drive.
Hdd	Boot from a hard drive.
None	Boot from the normal boot device.
Pxe	Boot from the Pre-boot eXecution Environment (PXE).
Recovery	Boot to a system-designated recovery process or image.
RemoteDrive	Boot from a remote drive, such as an iSCSI target.
SDCard	Boot from an SD card.
UefiBootNext	Boot to the UEFI device that the `BootNext` property specifies.
UefiHttp	Boot from a UEFI HTTP network location.
UefiShell	Boot to the UEFI Shell.
UefiTarget	Boot to the UEFI device specified in the `UefiTargetBootSourceOverride` property.
Usb	Boot from a system BIOS-specified USB device.
Utilities	Boot to the manufacturer's utilities program or programs.

CachePolicy⁠

The cache policy to control how KMIP data is cached.

string	Description
AfterFirstUse	The system caches KMIP data after first use for the duration specified by the `CacheDuration` property.
None	The system does not cache KMIP data.

ConnectTypesSupported⁠

This property enumerates the graphical console connection types that the implementation allows.

string	Description
KVMIP	The controller supports a graphical console connection through a KVM-IP (redirection of Keyboard, Video, Mouse over IP) protocol.
OEM	The controller supports a graphical console connection through an OEM-specific protocol.

DecommissionTypes⁠

The types of data to remove from the system.

string	Description
All	Remove all possible data from the server.
BIOSConfig	Reset all BIOS settings to factory defaults.
Logs	Clear all logs.
ManagerConfig	Reset all manager settings to factory defaults.
NetworkConfig	Reset all network settings to factory defaults.
StorageConfig	Reset all storage controller settings to factory defaults. This will leave the user data intact unless that is also specified.
TPM	Reset all user-accessible TPM settings to factory defaults.
UserData	Remove all possible data from block devices and other user or operating system accessible storage attached to the system.

HostingRoles⁠

The hosting roles that this computer system supports.

string	Description
Appliance	The system hosts functionality that supports the system acting as an appliance.
ApplicationServer	The system hosts functionality that supports general purpose applications.
BareMetalServer	The system hosts functionality that supports the system acting as a bare-metal server.
ContainerServer	The system hosts functionality that supports the system acting as a container server.
StorageServer	The system hosts functionality that supports the system acting as a storage server.
Switch	The system hosts functionality that supports the system acting as a switch.
VirtualMachineServer	The system hosts functionality that supports the system acting as a virtual machine server.

idRef⁠


@odata.id	string (URI)	read-only	The unique identifier for a resource.

IndicatorLED⁠

The state of the indicator LED, which identifies the system.

string	Description
Blinking	The indicator LED is blinking.
Lit	The indicator LED is lit.
Off	The indicator LED is off.
Unknown (deprecated v1.1)	The state of the indicator LED cannot be determined. Deprecated in v1.1 and later. This value has been deprecated in favor of returning `null` if the state is unknown.

InterfaceType⁠

The interface type of the Trusted Module.

string	Description
TCM1_0	Trusted Cryptography Module (TCM) 1.0.
TPM1_2	Trusted Platform Module (TPM) 1.2.
TPM2_0	Trusted Platform Module (TPM) 2.0.

InterfaceTypeSelection⁠

The interface type selection supported by this Trusted Module.

string	Description
BiosSetting	The TrustedModule supports switching InterfaceType through platform software, such as a BIOS configuration attribute.
FirmwareUpdate	The TrustedModule supports switching InterfaceType through a firmware update.
None	The TrustedModule does not support switching the InterfaceType.
OemMethod	The TrustedModule supports switching InterfaceType through an OEM proprietary mechanism.

LastResetCause⁠

The last reset cause of the system.

string	Description
ManagementCommand	System start or restart via an external command to the management controller or BMC.
OSSoftRestart	System start or restart via an OS soft restart.
PowerButtonPress	System start or restart via a power button press.
PowerEvent	System start or restart caused by a power event triggering a system shutdown.
PowerRestorePolicy	System start or restart due to the power restore policy.
RTCWakeup	System power-up via an RTC (system real time clock) wakeup.
SystemCrash	System start or restart caused by a system crash.
ThermalEvent	System start or restart caused by a thermal event triggering a system shutdown.
Unknown	System start or restart detected, but the cause is unknown.
WatchdogExpiration	System start or restart caused by a watchdog expiration.

LastState⁠

The last boot progress state.

string	Description
BusInitializationStarted	The system has started initializing the buses.
MemoryInitializationStarted	The system has started initializing the memory.
None	The system is not booting.
OEM	A boot progress state in an OEM-defined format.
OSBootStarted	The operating system has started booting.
OSRunning	The operating system is running.
PCIResourceConfigStarted	The system has started initializing the PCI resources.
PrimaryProcessorInitializationStarted	The system has started initializing the primary processor.
SecondaryProcessorInitializationStarted	The system has started initializing the remaining processors.
SetupEntered (v1.15+)	The system has entered the setup utility.
SystemHardwareInitializationComplete	The system has completed initializing all hardware.

MemoryMirroring⁠

The ability and type of memory mirroring that this computer system supports.

string	Description
DIMM	The system supports DIMM mirroring at the DIMM level. Individual DIMMs can be mirrored.
Hybrid	The system supports a hybrid mirroring at the system and DIMM levels. Individual DIMMs can be mirrored.
None	The system does not support DIMM mirroring.
System	The system supports DIMM mirroring at the system level. Individual DIMMs are not paired for mirroring in this mode.

PowerMode⁠

The power mode setting of the computer system.

string	Description
BalancedPerformance	The system performs at the highest speeds while utilization is high and performs at reduced speeds when the utilization is low.
EfficiencyFavorPerformance (v1.22+)	The system performs at reduced speeds at all utilizations to save power while attempting to maintain performance. This mode differs from `EfficiencyFavorPower` in that more performance is retained but less power is saved.
EfficiencyFavorPower (v1.22+)	The system performs at reduced speeds at all utilizations to save power at the cost of performance. This mode differs from `PowerSaving` in that more performance is retained and less power is saved. This mode differs from `EfficiencyFavorPerformance` in that less performance is retained but more power is saved.
MaximumPerformance	The system performs at the highest speeds possible.
OEM	The system power mode is OEM-defined.
OSControlled	The system power mode is controlled by the operating system.
PowerSaving	The system performs at reduced speeds to save power.
Static	The system power mode is static.

PowerRestorePolicy⁠

The desired power state of the system when power is restored after a power loss.

string	Description
AlwaysOff	The system always remains powered off when power is applied.
AlwaysOn	The system always powers on when power is applied.
LastState	The system returns to its last on or off power state when power is applied.

PowerState⁠

The current power state of the system.

string	Description
Off	The resource is powered off. The components within the resource might continue to have AUX power.
On	The resource is powered on.
Paused	The resource is paused.
PoweringOff	A temporary state between on and off. The components within the resource can take time to process the power off action.
PoweringOn	A temporary state between off and on. The components within the resource can take time to process the power on action.

ResetType⁠

The type of reset.

string	Description
ForceOff	Turn off the unit immediately (non-graceful shutdown).
ForceOn	Turn on the unit immediately.
ForceRestart	Shut down immediately and non-gracefully and restart the unit.
FullPowerCycle	Full power cycle the unit immediately (non-graceful). Behaves like removing utility lines, followed by restoring utility lines to the resource.
GracefulRestart	Shut down gracefully and restart the unit.
GracefulShutdown	Shut down gracefully and power off.
Nmi	Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.
On	Turn on the unit.
Pause	Pause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors.
PowerCycle	Power cycle the unit immediately (non-graceful). Behaves like a power removal, followed by a power restore to the resource.
PushPowerButton	Simulate the pressing of the physical power button on this unit.
Resume	Resume execution on the paused unit. This is typically a feature of virtual machine hypervisors.
Suspend	Write the state of the unit to disk before powering off. This allows for the state to be restored when powered back on.

SerialConsoleProtocol⁠

The information about a serial console service that this system provides.


ConsoleEntryCommand (v1.13+)	string	read-only (null)	The command string passed to the service to select or enter the system's serial console.
HotKeySequenceDisplay (v1.13+)	string	read-only (null)	The hotkey sequence available for the user to exit the serial console session.
Port (v1.13+)	integer	read-write (null)	The protocol port.
ServiceEnabled (v1.13+)	boolean	read-write	An indication of whether the service is enabled for this system.
SharedWithManagerCLI (v1.13+)	boolean	read-only	Indicates whether the serial console service is shared with access to the manager's command-line interface (CLI).

StopBootOnFault⁠

If the boot should stop on a fault.

string	Description
AnyFault	The system should stop the boot on any fault.
Never	The system performs any normal recovery actions during boot if a fault occurs.

SystemType⁠

The type of computer system that this resource represents.

string	Description
Composed (v1.4+)	A computer system constructed by binding resource blocks together.
DPU (v1.16+)	A computer system that performs the functions of a data processing unit, such as a SmartNIC.
OS (deprecated v1.21)	An operating system instance. Deprecated in v1.21 and later. This value has been deprecated in favor of representing operating systems with the `OperatingSystem` resource.
Physical	A computer system.
PhysicallyPartitioned	A hardware-based partition of a computer system.
Virtual	A virtual machine instance running on this system.
VirtuallyPartitioned	A virtual or software-based partition of a computer system.

TimeoutAction⁠

The action to perform when the watchdog timer reaches its timeout value.

string	Description
None	No action taken.
OEM	Perform an OEM-defined action.
PowerCycle	Power cycle the system.
PowerDown	Power down the system.
ResetSystem	Reset the system.

TrustedModuleRequiredToBoot⁠

The Trusted Module boot requirement.

string	Description
Disabled	No Trusted Module requirement to boot.
Required	A functional Trusted Module is required to boot.

UseCases⁠

The composition use cases in which this computer system can participate.

string	Description
ExpandableSystem	This computer system supports expandable system composition and is associated with a resource block.
ResourceBlockCapable	This computer system supports being registered as a resource block in order for it to participate in composition requests.

WarningAction⁠

The action to perform when the watchdog timer is close to reaching its timeout value. This action typically occurs from three to ten seconds before to the timeout value, but the exact timing is dependent on the implementation.

string	Description
DiagnosticInterrupt	Raise a (typically non-maskable) Diagnostic Interrupt.
MessagingInterrupt	Raise a legacy IPMI messaging interrupt.
None	No action taken.
OEM	Perform an OEM-defined action.
SCI	Raise an interrupt using the ACPI System Control Interrupt (SCI).
SMI	Raise a Systems Management Interrupt (SMI).

Example response⁠

{
    "@odata.type": "#ComputerSystem.v1_27_0.ComputerSystem",
    "Id": "437XR1138R2",
    "Name": "WebFrontEnd483",
    "SystemType": "Physical",
    "AssetTag": "Chicago-45Z-2381",
    "Manufacturer": "Contoso",
    "Model": "3500RX",
    "SKU": "8675309",
    "SerialNumber": "437XR1138R2",
    "PartNumber": "224071-J23",
    "Description": "Web Front End node",
    "UUID": "38947555-7742-3448-3784-823347823834",
    "HostName": "web483",
    "Status": {
        "State": "Enabled",
        "Health": "OK",
        "HealthRollup": "OK"
    },
    "HostingRoles": [
        "ApplicationServer"
    ],
    "LocationIndicatorActive": false,
    "PowerState": "On",
    "Boot": {
        "BootSourceOverrideEnabled": "Once",
        "BootSourceOverrideTarget": "Pxe",
        "BootSourceOverrideTarget@Redfish.AllowableValues": [
            "None",
            "Pxe",
            "Cd",
            "Usb",
            "Hdd",
            "BiosSetup",
            "Utilities",
            "Diags",
            "SDCard",
            "UefiTarget"
        ],
        "BootSourceOverrideMode": "UEFI",
        "UefiTargetBootSourceOverride": "/0x31/0x33/0x01/0x01"
    },
    "TrustedModules": [
        {
            "FirmwareVersion": "1.13b",
            "InterfaceType": "TPM1_2",
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            }
        }
    ],
    "Oem": {
        "Contoso": {
            "@odata.type": "#Contoso.ComputerSystem",
            "ProductionLocation": {
                "FacilityName": "PacWest Production Facility",
                "Country": "USA"
            }
        },
        "Chipwise": {
            "@odata.type": "#Chipwise.ComputerSystem",
            "Style": "Executive"
        }
    },
    "BiosVersion": "P79 v1.33 (02/28/2015)",
    "ProcessorSummary": {
        "Count": 2,
        "Model": "Multi-Core Intel(R) Xeon(R) processor 7xxx Series"
    },
    "MemorySummary": {
        "TotalSystemMemoryGiB": 96,
        "TotalSystemPersistentMemoryGiB": 0,
        "MemoryMirroring": "None"
    },
    "Bios": {
        "@odata.id": "/redfish/v1/Systems/437XR1138R2/BIOS"
    },
    "Processors": {
        "@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors"
    },
    "Memory": {
        "@odata.id": "/redfish/v1/Systems/437XR1138R2/Memory"
    },
    "EthernetInterfaces": {
        "@odata.id": "/redfish/v1/Systems/437XR1138R2/EthernetInterfaces"
    },
    "SimpleStorage": {
        "@odata.id": "/redfish/v1/Systems/437XR1138R2/SimpleStorage"
    },
    "LogServices": {
        "@odata.id": "/redfish/v1/Systems/437XR1138R2/LogServices"
    },
    "Links": {
        "Chassis": [
            {
                "@odata.id": "/redfish/v1/Chassis/1U"
            }
        ],
        "ManagedBy": [
            {
                "@odata.id": "/redfish/v1/Managers/BMC"
            }
        ]
    },
    "Actions": {
        "#ComputerSystem.Reset": {
            "target": "/redfish/v1/Systems/437XR1138R2/Actions/ComputerSystem.Reset",
            "ResetType@Redfish.AllowableValues": [
                "On",
                "ForceOff",
                "GracefulShutdown",
                "GracefulRestart",
                "ForceRestart",
                "Nmi",
                "ForceOn",
                "PushPowerButton"
            ]
        },
        "Oem": {
            "#Contoso.Reset": {
                "target": "/redfish/v1/Systems/437XR1138R2/Oem/Contoso/Actions/Contoso.Reset"
            }
        }
    },
    "@odata.id": "/redfish/v1/Systems/437XR1138R2"
}

ActionInfo 1.4.2⁠​

Description⁠​

Properties⁠​

Property details⁠​

DataType⁠​

Example response⁠​

Bios 1.2.3⁠​

Description⁠​

URIs⁠​

Properties⁠​

Actions⁠​

ChangePassword⁠​

ResetBios⁠​

Example response⁠​

ComputerSystem 1.25.0⁠​

Description⁠​

URIs⁠​

Properties⁠​

Actions⁠​

AddResourceBlock (v1.6+)⁠​

Decommission (v1.21+)⁠​

RemoveResourceBlock (v1.6+)⁠​

Reset⁠​

SetDefaultBootOrder (v1.5+)⁠​

Property details⁠​

AliasBootOrder⁠​

AutomaticRetryConfig⁠​

BootOrderPropertySelection⁠​

BootSourceOverrideEnabled⁠​

BootSourceOverrideMode⁠​

BootSourceOverrideTarget⁠​

CachePolicy⁠​

ConnectTypesSupported⁠​

DecommissionTypes⁠​

HostingRoles⁠​

idRef⁠​

IndicatorLED⁠​

InterfaceType⁠​

InterfaceTypeSelection⁠​

LastResetCause⁠​

LastState⁠​

MemoryMirroring⁠​

PowerMode⁠​

PowerRestorePolicy⁠​

PowerState⁠​

ResetType⁠​

SerialConsoleProtocol⁠​

StopBootOnFault⁠​

SystemType⁠​

TimeoutAction⁠​

TrustedModuleRequiredToBoot⁠​

UseCases⁠​

WarningAction⁠​

Example response⁠​

ActionInfo 1.4.2⁠

Description⁠

Properties⁠

Property details⁠

DataType⁠

Example response⁠

Bios 1.2.3⁠

Description⁠

URIs⁠

Properties⁠

Actions⁠

ChangePassword⁠

ResetBios⁠

Example response⁠

ComputerSystem 1.25.0⁠

Description⁠

URIs⁠

Properties⁠

Actions⁠

AddResourceBlock (v1.6+)⁠

Decommission (v1.21+)⁠

RemoveResourceBlock (v1.6+)⁠

Reset⁠

SetDefaultBootOrder (v1.5+)⁠

Property details⁠

AliasBootOrder⁠

AutomaticRetryConfig⁠

BootOrderPropertySelection⁠

BootSourceOverrideEnabled⁠

BootSourceOverrideMode⁠

BootSourceOverrideTarget⁠

CachePolicy⁠

ConnectTypesSupported⁠

DecommissionTypes⁠

HostingRoles⁠

idRef⁠

IndicatorLED⁠

InterfaceType⁠

InterfaceTypeSelection⁠

LastResetCause⁠

LastState⁠

MemoryMirroring⁠

PowerMode⁠

PowerRestorePolicy⁠

PowerState⁠

ResetType⁠

SerialConsoleProtocol⁠

StopBootOnFault⁠

SystemType⁠

TimeoutAction⁠

TrustedModuleRequiredToBoot⁠

UseCases⁠

WarningAction⁠

Example response⁠