Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

ComputerSystem

Description

This resource shall represent a computer system in the Redfish Specification. 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.

Fields

FieldTypeDescription
@odata.contextstringThe OData description of a payload.
@odata.etagstringThe current ETag of the resource.
@odata.idstringThe unique identifier for a resource.
@odata.typestringThe type of a resource.
AssetTagstringThis property shall contain the system asset tag value. Modifying this property may modify the AssetTag in the containing Chassis resource.
BiosVersionstringThis property shall contain the version string of the currently installed and running BIOS for x86 systems. For other systems, this property may contain a version string that represents the primary system firmware.
BootBootThis property shall contain properties that describe boot information for the system. For UEFI systems, this object shall contain UEFI boot settings.
DescriptionstringThe description of this resource. Used for commonality in the schema definitions.
HostNamestringThis property shall contain the DNS host name for this system, without any domain information.
IdstringThe unique identifier for this resource within the collection of similar resources.
IndicatorLEDstringThis property shall contain the indicator light state for the indicator light associated with this system.
LinksLinksThis property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.
ManufacturerstringThis property shall contain the name of the organization responsible for producing the system. This organization may be the entity from whom the system is purchased, but this is not necessarily true.
MemoryMemoryCollectionThis property shall contain a link to a resource collection of type MemoryCollection.
MemoryDomainsMemoryDomainCollectionThis property shall contain a link to a resource collection of type MemoryDomainCollection.
MemorySummaryMemorySummaryThis property shall contain properties that describe the central memory for this resource.
ModelstringThis property shall contain the product name for this system, without the manufacturer name.
NamestringThe name of the resource or array member.
OemobjectThe OEM extension property.
PartNumberstringThis property shall contain the manufacturer-provided part number for the system.
PowerStatestringThis property shall contain the power state of the system.
ProcessorSummaryProcessorSummaryThis property shall contain properties that describe the central processors for this resource. Processors described by the Processors link property shall not be included in the summary.
ProcessorsProcessorCollectionThis property shall contain a link to a resource collection of type ProcessorCollection.
SerialNumberstringThis property shall contain the serial number for this system.
SKUstringThis property shall contain the SKU number for this system.
StatusStatusThis property shall contain any status or health properties of the resource.
SubModelstringThis property shall contain the sub-model information as provided by the manufacturer for this system.
SystemTypestringThis property shall contain the type of computer system that this resource represents.
UUIDstringThis property shall contain the universally unique identifier number for this system.