GET – System Instance
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. Information on these resources or sub systems are also linked to this resource. This resource shall be used to represent resources that represent a computing system in the Redfish specification.
Request
GET https://{{ip}}/redfish/v1/Systems/{{system_instance}}
Content-Type: application/json
Response
The response of the request will be in JSON format. The properties are mentioned in the following tables.
Name | Type | Read only | Description | ||||||||||||||||||||||||
| (OData Attributes) | Refer to OData Support | ||||||||||||||||||||||||||
| Oem | Object | Specifies the AMI defined OEM properties.
| |||||||||||||||||||||||||
Id(M) | String | True | Refer to Resource Type Definitions | ||||||||||||||||||||||||
Name(M) | String | True | |||||||||||||||||||||||||
Description | String | True | |||||||||||||||||||||||||
SystemType | String | True | An enumeration that indicates the kind of system that this resource represents. | ||||||||||||||||||||||||
Enum | Description | ||||||||||||||||||||||||||
Physical | A computer system | ||||||||||||||||||||||||||
Composed | A computer system that has been created by binding resource blocks together. | ||||||||||||||||||||||||||
Links | Object | True | The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource. | ||||||||||||||||||||||||
Name | Type | Read Only | Description | ||||||||||||||||||||||||
Oem | Object | Refer to Resource Type Definitions Note It will be present in response if there is an oem property implemented according to "How to Add OEM extensions" document. | |||||||||||||||||||||||||
Chassis(N) | Array | True | An array of references to th chassis in which this system is contained. | ||||||||||||||||||||||||
Chassis@odata.count | Number | True | An integer representing the number of items in a collection. | ||||||||||||||||||||||||
ManagedBy(N) | Array | True | An array of references to th Managers responsible for this system. | ||||||||||||||||||||||||
ManagedBy@odata.count | Number | True | An integer representing the number of items in a collection. | ||||||||||||||||||||||||
PoweredBy(N) | Array | True | An array of ID[s] of resources that power this computer system. Normally the ID will be a chassis or a specific set of power Supplies. Note Platform specific porting needed. | ||||||||||||||||||||||||
PoweredBy@odata.count | Number | True | An integer representing the number of items in a collection. | ||||||||||||||||||||||||
CooledBy(N) | Array | True | 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. Note Platform specific porting needed. | ||||||||||||||||||||||||
CooledBy@odata.count | Number | True | An integer representing the number of items in a collection. | ||||||||||||||||||||||||
Endpoints(N) | Array | True | An array of references to th endpoints that connect to this system. Note These will be available only as a port of FPX Produt. | ||||||||||||||||||||||||
Endpoints@odata.count | Number | True | An integer representing the number of items in a collection. | ||||||||||||||||||||||||
AssetTag | String | False | The user definable tag that can be used to track this computer system for inventory or other client purposes. Note This can be populated by Host Interface (Extra Bios Support is needed). | ||||||||||||||||||||||||
Manufacturer | String | True | Manufacturer or OEM of this system. Note This can be populated by Host Interface (Extra Bios Support is needed). | ||||||||||||||||||||||||
Model | String | True | Model number of this system. Note This can be populated by Host Interface (Extra Bios Support is needed). | ||||||||||||||||||||||||
SKU | String | True | The value of this property shall contain the manufacturer Stock Keeping Unit (SKU) for the system. Note This can be populated by Host Interface (Extra Bios Support is needed). | ||||||||||||||||||||||||
SerialNumber | String | True | The value of this property shall contain the serial number for this system. Note This can be populated by Host Interface (Extra Bios Support is needed). | ||||||||||||||||||||||||
PartNumber | String | True | Part number for this system as defined by the manufacturer. | ||||||||||||||||||||||||
| SubModel | String | True | This property shall contain the information about the sub-model (or config) of the system. This shall not include the model/product name or the manufacturer name. | ||||||||||||||||||||||||
UUID | String | True | The value of this property shall be used to contain a universal unique identifier number for the system. RFC4122 describes methods that can be used to create the value. The value should considered to be opaque. Client software should only treat the overall value as a universally unique identifier and should not interpret any sub-fields within the UUID. Note This can be populated by Host Interface (Extra Bios Support is needed). | ||||||||||||||||||||||||
Name | Type | Read only | Description | |
HostName | String | False | The value of this property shall be the host name for this system, as reported by the operating system or hypervisor. This value is typically provided to the Manager by a service running in the host operating system. Default it will be null value. Note Northbound API is supported but still requires host interface and host agent support from host agent and in-band communication channel and platform specific porting needed; require specific platform libraries support and hook between specific libraries and gami module should be added. | |
IndicatorLED | String | False | The value of this property shall contain the indicator light state for the indicator light associated with this system. Note This can be populated by Host Interface (Extra Bios Support is needed). | |
Enum | Description | |||
Unknown | The state of the Indicator LED cannot be determined. | |||
Lit | The Indicator LED is Lit. | |||
Blinking | The Indicator LED is Blinking. | |||
Off | The Indicator LED is Off. | |||
PowerState | String | True | The current power state of the system. | |
Enum | Description | |||
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. | |||
Boot | Object | False | This object shall contain properties which describe boot information for the current resource. Changes to this object do not alter the BIOS persistent boot order configuration. Note This can be populated by Host Interface (Extra Bios Support is needed). | |
BiosVersion | String | True | The version of the system BIOS or primary system firmware. Note This can be populated by Host Interface (Extra Bios Support is needed). | |
Name | Type | Read only | Description | |||||
ProcessorSummary | This object describes the central processors of the system in general detail. Note This can be populated by Host Interface (Extra Bios Support is needed). | |||||||
Name | Type | Read Only | Description | |||||
Count | Number | True | The number of processors in the system. | |||||
Model | String | True | The processor model for the primary or majority of processors in this system. | |||||
Status | Object | True | Refer to Resource Type Definitions Note Only supports Northbound. | |||||
MemorySummary | This object describes the central memory of the system in general detail. Note This can be populated by Host Interface (Extra Bios Support is needed). | |||||||
Name | Type | Read Only | Description | |||||
TotalSystemMemoryGiB | Number | True | The total installed, operating system-accessible memory (RAM), measured in GiB. | |||||
Status | Object | True | Refer to Resource Type Definitions Note Only supports Northbound. | |||||
MemoryMirroring | String | True | The ability and type of memory mirroring supported by this system. It can take any of the following values-: System, DIMM, Hybrid, None. It can take any of the following values: System, DIMM, Hybrid, None.Note Only supports Northbound. | |||||
| Metrics | Object | True | The link to the metrics associated with all memory in this system. This can be populated by Host Interface (Extra Bios Support is needed). | |||||
TotalSystemPersistentMemoryGiB | Number | True | The total configured, system-accessible persistent memory, measured in GiB | |||||
Actions | Object | True | ComputerSystem allows the user to perform Reset Action and it’s allowable values are as given in Resource Type Definitions . Please refer Reset enum type under Resource. It can also contain an Oem Object under Oem attribute under this Actions. | |||||
Processors(N) | Object | True | A reference to the collection of Processors associated with this system. | |||||
EthernetInterfaces(N) | Object | True | A reference to the collection of Ethernet interfaces associated w this system. | |||||
SimpleStorage(N) | Object | True | A reference to the collection of storage devices associated with the system. | |||||
LogServices(N) | Object | True | A reference to the collection of Log Services associated with this system. | |||||
Status | Object | True | Refer to Resource Complex Types for Resource.Status. Note This can be populated by Host Interface (Extra Bios Support is needed). | |||||
Name | Type | Read only | Description | ||
TrustedModules | Array | True | This object describes the array of Trusted Modules in the system. Note This can be populated by Host Interface (Extra Bios Support is needed). | ||
SecureBoot(N) | Object | True | A reference to the UEFI SecureBoot resource associated with this system. Note This can be populated by Host Interface (Extra Bios Support is needed). | ||
Bios(N) | Object | True | A reference to the BIOS settings associated with this system. Note This link will be populated only if corresponding BIO module is present. | ||
Memory(N) | Object | True | A reference to the collection of Memory associated with this system. | ||
Storage(N) | Object | True | A reference to the collection of storage device associated with this system. Note Northbound API is supported but still requires host interface and host agent support from host agent and in-band communication channel and platform specific porting needed; require specific platform libraries support and hook between specific libraries and gami module should be added. | ||
NetworkInterfaces(N) | Object | True | A reference to the collection of Network Interfaces associated w this system. Note This link will be populated only if corresponding BIO module is present. | ||
HostingRoles | Array | True | The hosing roles that this computer system supports. | ||
Enum | Description | ||||
ApplicationServer | The system hosts functionality that supports general purpose applications. | ||||
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. | ||||
HostedServices | Object | True | The services that this computer system supports. Note At present only Oem property is supported under it. Note It will be present in response if there is an oem proper implemented according to" How to Add OEM extensions" document. | ||
PCIeDevices(N) | Object | True | A reference to a collection of PCIe Devices used by this compute system. Note Links will be available only when Host Interface feature is enabled and the corresponding AMI BIOS Image is used. | ||
PCIeDevices@odata.count | Number | True | Number of PCIeDevcies used by this systems | ||
PCIeFunctions(N) | Object | True | A reference to a collection of PCIe Functions used by this computer system. Note Links will be available only Host Interface feature is enabled and the corresponding AMI BIOS Image is used. | ||
PCIeFunctions@odata.count | Number | True | Number of PCIeFunctions used by this systems | ||
PowerRestorePolicy | String | False | This property shall indicate the desired PowerState of the system when power is applied to the system. | ||
Enum | Description | ||||
AlwaysOn | The system will always power on when power is applied. | ||||
AlwaysOff | The system will always remain powered off when power is applied. | ||||
LastState | The system will return to its last power state (on or off) when power is applied | ||||
Enum | Description |
System | The system supports DIMM mirroring at the System leveI. Individual DIMMs are not paired for mirroring in this mode. |
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. |
Name | Type | Read only | Description | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@Odata.type | String | True | Refer to OData Support | ||||||||||||||||||||||||||||||||
| Crc | Object | True | Specifies the additional configuring of the Redfish service.
| ||||||||||||||||||||||||||||||||
Name | Type | Read only | Description | ||
FirmwareVersion | String | True | The firmware version of this Trusted Module. | ||
InterfaceType | String | True | This property indicates the interface type of the Trusted Module. | ||
Enum | Description | ||||
TPM1_2 | Trusted Platform Module (TPM) 1.2. | ||||
TPM2_0 | Trusted Platform Module (TPM) 2.0. | ||||
TCM1_0 | Trusted Cryptography Module (TCM) 1.0. | ||||
Status | String | True | Refer to Resource Type Definitions Note This can be populated by Host Interface(Extra Bios Support is needed). | ||
Oem | Object | Note Platform specific porting needed. | |||
FirmwareVersion2 | String | True | The 2nd firmware version of this Trusted Module, if applicable. | ||
InterfaceTypeSelection | String | True | The Interface Type selection supported by this Trusted Module. | ||
Enum | Description | ||||
None | The TrustedModule does not support switching the InterfaceType. | ||||
FirmwareUpdate | The TrustedModule supports switching InterfaceType via a firmware update. | ||||
BiosSetting | The TrustedModule supports switching InterfaceType via platform software, such as a BIOS configuration Attribute. | ||||
OemMethod | The TrustedModule supports switching InterfaceType via an OEM proprietary mechanism. | ||||