ComputerSystem

Schema Definition

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.

Properties

Property	Type	Nullable	Required	Permission	Description
@odata.context	String			read-only	The OData description of a payload. Format: uri
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
@odata.type	String			read-only	The type of a resource.
Actions {	Object			read-write	The available actions for this resource.
#ComputerSystem.Reset {	Object			read-write	This action is used to reset the system.
target	String			read-write	Link to invoke action Format: uri
title	String			read-write	Friendly action name
}
Oem { }	Object			read-write	The available OEM specific actions for this resource.
}
Boot {	Object			read-write	Information about the boot settings for this system.
BootSourceOverrideEnabled	String	Yes		read-write	Describes the state of the Boot Source Override feature. Possible Values: Disabled: The system will boot normally. Once: On its next boot cycle, the system will boot (one time) to the Boot Source Override Target. The value of BootSourceOverrideEnabled is then reset back to Disabled. Continuous: The system will boot to the target specified in the BootSourceOverrideTarget until this property is set to Disabled.
BootSourceOverrideTarget	String	Yes		read-write	The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is true. Possible Values: None: Boot from the normal boot device. Pxe: Boot from the Pre-Boot EXecution (PXE) environment. Cd: Boot from the CD/DVD disc. Usb: Boot from a USB device as specified by the system BIOS. Hdd: Boot from a hard drive.
}
Description	String	Yes		read-only	Provides a description of this resource and is used for commonality in the schema definitions.
EthernetInterfaces {	Reference(EthernetInterfaceCollection)			read-only	A reference to the collection of Ethernet interfaces associated with this system.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
Id	String		GET	read-only	Uniquely identifies the resource within the collection of like resources.
IndicatorLED	String	Yes		read-write	The state of the indicator LED, used to identify the system. Possible Values: Lit: The Indicator LED is lit. Blinking: The Indicator LED is blinking. Off: The Indicator LED is off.
Links {	Object			read-write	Contains references to other resources that are related to this resource.
Oem { }	Object			read-write	Oem extension object.
}
Manufacturer	String	Yes		read-only	The manufacturer or OEM of this system.
Model	String	Yes		read-only	The product name for this system, without the manufacturer name.
Name	String		GET	read-only	The name of the resource or array element.
Oem {	Object			read-write	This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
EID_47597 {	Object			read-write	RECS\|Box ComputerSystem extension
Baseboard {	Reference(Baseboard)			read-only	The Baseboard hosting this ComputerSystem
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
ComposedIn {	Reference(ComposedNode)	Yes		read-only	This is a link to the ComposedNode, this ComputerSystem is composed in.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
FormFactor	String			read-only	The form factor of the computer system. Possible Values: Unknown COM Express Type 1/2 COM Express Type 6 COM Express Type 7 COM Express Type 10 Apalis Jetson COM-HPC Server COM-HPC Client
HSLLInterface {	Reference(HSLLInterface)	Yes		read-only	This is a link to the HSLLInterface provided by this system
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
KvmStatus	String			read-write	The KVM status of the ComputerSystem. Attention: If set to KVM/iKVM, KVM is released from all other ComputerSystems. Possible Values: None KVM iKVM
Power {	Reference(Power)			read-only	A reference to the power properties (power supplies, power policies, sensors) of this baseboard.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
Thermal {	Reference(Thermal)			read-only	A reference to the thermal properties (fans, cooling, sensors) of this baseboard.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
}
}
PowerState	String	Yes		read-only	This is the current power state of the system. Possible Values: On: The system is powered on. Off: The system is powered off, although some components may continue to have AUX power such as management controller. PoweringOn: A temporary state between Off and On. This temporary state can be very short. PoweringOff: A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process.
ProcessorSummary {	Object			read-write	This object describes the central processors of the system in general detail.
Count	Int64	Yes		read-only	The number of physical processors in the system. Minimum: 0
Model	String	Yes		read-only	The processor model for the primary or majority of processors in this system.
}
Processors {	Reference(ProcessorCollection)			read-only	A reference to the collection of Processors associated with this system.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
SKU	String	Yes		read-only	The manufacturer SKU for this system.
SerialNumber	String	Yes		read-only	The serial number for this system.
Status {	Object			read-write	This type describes the status and health of a resource and its children.
Health	String	Yes		read-only	This represents the health state of this resource in the absence of its dependent resources. Possible Values: OK: Normal. Warning: A condition exists that requires attention. Critical: A critical condition exists that requires immediate attention.
HealthRollup	String	Yes		read-only	This represents the overall health state from the view of this resource. Possible Values: OK: Normal. Warning: A condition exists that requires attention. Critical: A critical condition exists that requires immediate attention.
Oem { }	Object			read-write	Oem extension object.
State	String	Yes		read-only	This indicates the known state of the resource, such as if it is enabled. Possible Values: Enabled: This function or resource has been enabled. Disabled: This function or resource has been disabled. StandbyOffline: This function or resource is enabled, but awaiting an external action to activate it. StandbySpare: This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. InTest: This function or resource is undergoing testing. Starting: This function or resource is starting. Absent: This function or resource is not present or not detected. UnavailableOffline: This function or resource is present but cannot be used. Deferring: The element will not process any commands but will queue new requests. Quiesced: The element is enabled but only processes a restricted set of commands. Updating: The element is updating and may be unavailable or degraded.
}
UUID	Guid	Yes		read-only	The universal unique identifier (UUID) for this system. Pattern: ([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})

Actions

#ComputerSystem.Reset

Parameters

Property	Type	Nullable	Required	Permission	Description
ResetType	String	Yes		read-write	The type of reset to be performed. Possible Values: On: Turn the unit on. ForceOff: Turn the unit off immediately (non-graceful shutdown). GracefulShutdown: Perform a graceful shutdown and power off. GracefulRestart: Perform a graceful shutdown followed by a restart of the system. ForceRestart: Perform an immediate (non-graceful) shutdown, followed by a restart. ForceOn: Turn the unit on immediately. PushPowerButton: Simulate the pressing of the physical power button on this unit.

Request

POST /redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1/Actions/ComputerSystem.Reset
Content-Type: application/json
{
"ResetType": "On"
}

Response

HTTP/1.1 204
Location: Node

Operations

GET

Request

GET /redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1
Content-Type: application/json

Response

{
    "@odata.context": "uri",
    "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1",
    "@odata.type": "String",
    "Actions": {
        "#ComputerSystem.Reset": {
            "target": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1/Actions/ComputerSystem.Reset",
            "ResetType@Redfish.AllowableValues": ["On", "ForceOff", "GracefulShutdown", "GracefulRestart", "ForceRestart", "ForceOn", "PushPowerButton"],
            "title": "String"
        }
        "Oem": { }
    }
    "Boot": {
        "BootSourceOverrideEnabled": "Disabled",
        "BootSourceOverrideEnabled@Redfish.AllowableValues": ["Disabled", "Once", "Continuous"],
        "BootSourceOverrideTarget": "None",
        "BootSourceOverrideTarget@Redfish.AllowableValues": ["None", "Pxe", "Cd", "Usb", "Hdd"]
    }
    "Description": "String",
    "EthernetInterfaces": {
        "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1/EthernetInterfaces"
    },
    "Id": "String",
    "IndicatorLED": "Lit",
    "IndicatorLED@Redfish.AllowableValues": ["Lit", "Blinking", "Off"],
    "Links": {
        "Oem": { }
    }
    "Manufacturer": "String",
    "Model": "String",
    "Name": "String",
    "Oem": {
        "EID_47597": {
            "Baseboard": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1"
            },
            "ComposedIn": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1"
            },
            "FormFactor": "Unknown",
            "HSLLInterface": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1/HSLLInterface"
            },
            "KvmStatus": "None",
            "KvmStatus@Redfish.AllowableValues": ["None", "KVM", "iKVM"],
            "Power": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1/Power"
            },
            "Thermal": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1/Thermal"
            }
        }
    }
    "PowerState": "On",
    "ProcessorSummary": {
        "Count": 0,
        "Model": "String"
    }
    "Processors": {
        "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1/Processors"
    },
    "SKU": "String",
    "SerialNumber": "String",
    "Status": {
        "Health": "OK",
        "HealthRollup": "OK",
        "Oem": { },
        "State": "Enabled"
    }
    "UUID": "00000000-0000-0000-0000-000000000000"
}

POST

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

PATCH

Request

PATCH /redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1
Content-Type: application/json
{
    "Boot": {
        "BootSourceOverrideEnabled": "Disabled",
        "BootSourceOverrideTarget": "None"
    }
    "IndicatorLED": "Lit",
    "Oem": {
        "EID_47597": {
            "KvmStatus": "None"
        }
    }
}

Response

HTTP/1.1 204 No Content

DELETE

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

Schema Navigation

ComputerSystem

Schema Definition

Properties

Actions

#ComputerSystem.Reset

Parameters

Request

Response

Operations

GET

Request

Response

POST

PATCH

Request

Response

DELETE