GET – Server properties

Use the GET method to retrieve properties in System resource for Redfish service.

Request URL

GET https://<BMC_IPADDR>/redfish/v1/Systems/1

Request body

None

Response body

Field					Type	Description
Id					String	“1”
Name					String	“ComputerSystem”
Description					String	This resource is used to represent a computing system for a Redfish implementation.
SystemType					String	The type of computer system represented by this resource
AssetTag					String	The asset tag of the system
Manufacturer					String	The manufacturer tag of the system
Model					String	Model of the system
SubModel					String	Sub model of the system
SKU					String	The manufacturer SKU for this system.
SerialNumber					String	Serial number of the system
PartNumber					String	null
UUID					String	The universal unique identifier (UUID) for this system
HostName					String	The full name of this host: XCC2-SubModel-SerialNumber
IndicatorLED					String	The indicator light state for the indicator light associated with this system
Boot					Object	Describes boot information for the current resource. Changes to this object do not alter the BIOS persistent boot order configuration
	BootOptions				Link	The link to the collection of the UEFI boot options associated with this computer system.
	BootOrder				Array	Items: string Item count: N
		BootOrder[N]			String	BootOptionReference strings that represent the persistent boot order for with this computer system.
	BootOrderPropertySelection				String	“BootOrder”.
	BootSourceOverrideEnabled				String	Describes the state of the Boot Source Override feature
	BootSourceOverrideMode				String	The BIOS Boot Mode (either Legacy or UEFI) to be used when BootSourceOverrideTarget boot source is booted from
	UefiTargetBootSourceOverride				String	The UEFI Device Path of the device to boot from when BootSourceOverrideSupported is UefiTarget.
	AutomaticRetryConfig				String	Read only. The value is "RetryAlways" or "RetryAttempts".
	AutomaticRetryAttempts				Number	If the AutomaticRetryConfig is "RetryAlways", this property doesn’t exist. If the AutomaticRetryConfig is "RetryAttempts", the value is 50.
	BootSourceOverrideTarget				String	The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is true
	BootSourceOverrideTarget @Redfish.AllowableValues				Array	Items: string Item count: 8
	BootSourceOverrideTarget @Redfish.AllowableValues[0]				String	“None”
	BootSourceOverrideTarget @Redfish.AllowableValues[1]				String	“Pxe”
	BootSourceOverrideTarget @Redfish.AllowableValues[2]				String	“Cd”
	BootSourceOverrideTarget @Redfish.AllowableValues[3]				String	“Usb”
	BootSourceOverrideTarget @Redfish.AllowableValues[4]				String	“Hdd”
	BootSourceOverrideTarget @Redfish.AllowableValues[5]				String	“BiosSetup”
	BootSourceOverrideTarget @Redfish.AllowableValues[6]				String	“Diags”
	BootSourceOverrideTarget @Redfish.AllowableValues[7]				String	“UefiTarget”
	BootSourceOverrideEnabled @Redfish.AllowableValues				Array	Items: string Item count: 2
	BootSourceOverrideEnabled @Redfish.AllowableValues[0]				String	“Once”
	BootSourceOverrideEnabled @Redfish.AllowableValues[1]				String	“Disabled”
BiosVersion					String	The version of the system BIOS.
TrustedModules					Object	An array of trusted modules in the system. Note This object is not supported on AMD Milan-based systems.
	InterfaceType				String	The interface type of the Trusted Module.
	FirmwareVersion				String	The firmware version of this Trusted Module.
	InterfaceTypeSelection				String	The interface type selection supported by this Trusted Module.
	Status				Object	The status of this trusted module.
		State			String	The state of this trusted module.
		Health			String	If state is “Absent”, it is hidden, otherwise it is “OK”
ProcessorSummary					Object	This object describes the central processors of the system in general detail.
	Count				Number	The number of processors in the system.
	LogicalProcessorCount				Integer	The logical Processor Count.
	Metrics				Link	The link to the metrics associated with all processors in this system.
	Model				String	The processor model for the primary or majority of processors in this system.
	Status				Object	Reflect the processor summary status.
		State			String	”Enabled”
		HealthRollup			String	This represents the overall health state from the view of this resource.
		Health			String	This represents the health state of this resource in the absence of its dependent resources.
MemorySummary					Object	This object describes the memory of the system in general detail.
	Metrics				Link	The link to the metrics associated with all memories in this system.
	TotalSystemMemoryGiB				Number	The total installed, operating system-accessible memory (RAM), measured in GiB.
	Status				Object	Reflect the memory summary status.
		State			String	“Enabled”.
		HealthRollup			String	This represents the overall health state from the view of this resource.
		Health			String	This represents the health state of this resource in the absence of its dependent resources.
Processors					Link	This object describes the processor of the system in general detail.
Status					Object	Expanded
	State				String	“Enabled”
	HealthRollup				String	This represents the overall health state from the view of this resource.
	Health				String	This represents the health state of this resource in the absence of its dependent resources.
Links					Object	An object for reference links.
	ManagedBy				Array	An array of references to Managers responsible for this system.
	Chassis				Array	An array of references to the chassis in which this system is contained.
	PoweredBy				Array	An array of references to power responsible for this system.
	CooledBy				Array	An array of references to cooling device responsible for this system.
EthernetInterfaces					Link	A reference to the collection of Ethernet interfaces associated with this system.
NetworkInterfaces					Link	A reference to the collection of network interfaces associated with this system.
LogServices					Link	A reference to the collection of Log Services associated with this system.
PowerState					String	Current power state of the system.
Bios					Link	A reference to the BIOS settings associated with this system.
Memory					Link	A reference to the collection of memory device associated with this system.
Storage					Link	A reference to the collection of storage device with this system.
SecureBoot					Link	A reference to the SecureBoot settings associated with this system.
HostWatchdogTimer					Object	This object describes the Host Watchdog Timer functionality for this system.
	FunctionEnabled				Boolean	This indicates if the Host Watchdog Timer functionality has been enabled. Additional host-based software is necessary to activate the timer function.
	Status				Object	Expanded
		State			String	“Disabled”or“StandbyOffline”.
	TimeoutAction				String	This property indicates the action to perform when the Watchdog Timer reaches its timeout value.
	TimeoutAction@ Redfish.AllowableValues				Array	Item type: string Item count: 1 Item: [“PowerCycle”]
	WarningAction				String	This property indicates the action to perform when the Watchdog Timer is close (typically 3-10 seconds) to reaching its timeout value.
	WarningAction@ Redfish.AllowableValues				Array	Item type: string Item count: 1 Item: [“None”]
PCIeDevices					Array	An array of references to pci devices in which this system is contained.
PCIeFunctions					Array	An array of references to pci functions in which this system is contained.
VirtualMedia					Link	A reference to the virtual media services for this system.
KeyManagement					Object	Expanded
	KMIPServers				Array	An array of the KMIP servers to which this computer system is subscribed.
		KMIPServers[N]			Object	Expanded
			Address		String	The KMIP server address.
			Port		Int	The KMIP server port.
	KMIPCertificates				Link	A URI reference to a collection of server certificates for the servers referenced by the KMIPServers property.
Actions					Object	The available actions for this resource.
	#ComputerSystem.Reset				Object	This action shall perform a reset of the ComputerSystem. For systems which implement APCI Power Button functionality, the PushPowerButton value shall perform or emulate an ACPI Power Button push. The ForceOff value shall remove power from the system or perform an ACPI Power Button Override (commonly known as a 4-second hold of the Power Button). The ForceRestart value shall perform a ForceOff action followed by a On action.
		@Redfish.ActionInfo			Link	{SR}/Systems/1/ResetActionInfo
		ResetType@Redfish.AllowableValues			Array	Items: string Item count: 7
		ResetType@Redfish.AllowableValues[0]			String	“On”
		ResetType@Redfish.AllowableValues[1]			String	“Nmi”
		ResetType@Redfish.AllowableValues[2]			String	“GracefulShutdown”
		ResetType@Redfish.AllowableValues[3]			String	“GracefulRestart”
		ResetType@Redfish.AllowableValues[4]			String	“ForceOn”
		ResetType@Redfish.AllowableValues[5]			String	“ForceOff”
		ResetType@Redfish.AllowableValues[6]			String	“ForceRestart”
@Redfish.Settings					Object	Expanded
	Messages				Array	Items: object Item count: 0 or 1
		Messages[0]			Object	Expanded Indicate a “RebootRequired” message when successful to modify the Boot/BootOrder of Pending resource.
			MessageId		String	“ExtendedError.1.2. RebootRequired”
			RelatedProperties		Array	Items: string Item count: 1
				RelatedProperties[0]	String	“#/Boot/BootOrder”
			Severity		String	“Warning”
			Message		String	“Changes completed successfully, but these changes will not take effect until next reboot.”
			Resolution		String	“Reboot the computer system for the changes to take effect.”
	SettingsObject				Link	/redfish/v1/Systems/1/Pending
	Time				String	Indicate the time at which the Settings resource was last applied, otherwise the value is null.
	SupportedApplyTimes				Array	Items: string Item count: 1
		SupportedApplyTimes[0]			String	“OnReset”

Status code

HTTP Status Code	Error Message ID
500	InternalError

Example

The following example JSON response is returned:

{
    "TrustedModules": [
        {
            "FirmwareVersion": "7.51.6405.5136",
            "Status": {
                "Health": "OK",
                "State": "Enabled"
            },
            "InterfaceType": "TPM2_0",
            "InterfaceTypeSelection": "BiosSetting"
        }
    ],
    "Memory": {
        "@odata.id": "/redfish/v1/Systems/1/Memory"
    },
    "Description": "This resource is used to represent a computing system for a Redfish implementation.",
    "Bios": {
        "@odata.id": "/redfish/v1/Systems/1/Bios"
    },
    "@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem",
    "SecureBoot": {
        "@odata.id": "/redfish/v1/Systems/1/SecureBoot"
    },
    "IndicatorLED": "Off",
    "Model": "ThinkSystem ST650 V3 MAIN BOARD",
    "LogServices": {
        "@odata.id": "/redfish/v1/Systems/1/LogServices"
    },
    "Name": "ComputerSystem",
    "@odata.type": "#ComputerSystem.v1_17_0.ComputerSystem",
    "@odata.id": "/redfish/v1/Systems/1",
    "PCIeFunctions@odata.count": 5,
    "PartNumber": null,
    "@odata.etag": "\"2830443250c3932c789b18\"",
    "UUID": "00000000-0000-0000-0000-000000000000",
    "Processors": {
        "@odata.id": "/redfish/v1/Systems/1/Processors"
    },
    "MemorySummary": {
        "Status": {
            "HealthRollup": "OK",
            "Health": "OK",
            "State": "Enabled"
        },
        "Metrics": {
            "@odata.id": "/redfish/v1/Systems/1/MemorySummary/MemoryMetrics"
        },
        "TotalSystemMemoryGiB": 16
    },
    "HostName": "XCC-0123-1234567890",
    "AssetTag": "Madrid2",
    "NetworkInterfaces": {
        "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces"
    },
    "SystemType": "Physical",
    "SerialNumber": "1234567890",
    "EthernetInterfaces": {
        "@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces"
    },
    "Manufacturer": "Lenovo",
    "SKU": "7D7AMT1",
    "HostWatchdogTimer": {
        "TimeoutAction@Redfish.AllowableValues": [
            "PowerCycle"
        ],
        "WarningAction@Redfish.AllowableValues": [
            "None"
        ],
        "FunctionEnabled": false,
        "WarningAction": "None",
        "TimeoutAction": "PowerCycle",
        "Status": {
            "State": "Disabled"
        }
    },
    "Links": {
        "CooledBy": [
            {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/0"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/1"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/2"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/3"
            }
        ],
        "PoweredBy": [],
        "Chassis": [
            {
                "@odata.id": "/redfish/v1/Chassis/1"
            }
        ],
        "ManagedBy": [
            {
                "@odata.id": "/redfish/v1/Managers/1"
            }
        ]
    },
    "Oem": {
        …
    },
    "PCIeFunctions": [
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_2/PCIeFunctions/ob_2.00"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_2/PCIeFunctions/ob_2.01"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_5/PCIeFunctions/ob_5.00"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_4/PCIeFunctions/ob_4.00"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_1/PCIeFunctions/ob_1.00"
        }
    ],
    "@Redfish.Settings": {
        "Messages": [],
        "SettingsObject": {
            "@odata.id": "/redfish/v1/Systems/1/Pending"
        },
        "SupportedApplyTimes": [
            "OnReset"
        ],
        "Time": null,
        "@odata.type": "#Settings.v1_3_0.Settings"
    },
    "Id": "1",
    "ProcessorSummary": {
        "Count": 1,
        "Metrics": {
            "@odata.id": "/redfish/v1/Systems/1/ProcessorSummary/ProcessorMetrics"
        },
        "LogicalProcessorCount": 104,
        "Model": "Intel(R) Xeon(R) Platinum 8470",
        "Status": {
            "HealthRollup": "OK",
            "Health": "OK",
            "State": "Enabled"
        }
    },
    "VirtualMedia": {
        "@odata.id": "/redfish/v1/Systems/1/VirtualMedia"
    },
    "Actions": {
        "#ComputerSystem.Reset": {
            "ResetType@Redfish.AllowableValues": [
                "On",
                "Nmi",
                "GracefulShutdown",
                "GracefulRestart",
                "ForceOn",
                "ForceOff",
                "ForceRestart"
            ],
            "target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset",
            "title": "Reset",
            "@Redfish.ActionInfo": "/redfish/v1/Systems/1/ResetActionInfo"
        },
        "Oem": {
            …
        }
    },
    "Status": {
        "HealthRollup": "Critical",
        "Health": "Critical",
        "State": "Enabled"
    },
    "SubModel": "7D7A",
    "PCIeDevices": [
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_4"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_2"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_1"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_5"
        }
    ],
    "PowerState": "On",
    "PCIeDevices@odata.count": 4,
    "Boot": {
        "BootOrderPropertySelection": "BootOrder",
        "BootOrder": [
            "Boot0005",
            "Boot0000",
            "Boot0001",
            "Boot0002",
            "Boot0003",
            "Boot0004"
        ],
        "AutomaticRetryConfig": "RetryAttempts",
        "AutomaticRetryAttempts": 50,
        "BootOptions": {
            "@odata.id": "/redfish/v1/Systems/1/BootOptions"
        },
        "BootSourceOverrideTarget": "None",
        "BootSourceOverrideMode": "UEFI",
        "BootSourceOverrideTarget@Redfish.AllowableValues": [
            "None",
            "Pxe",
            "Cd",
            "Usb",
            "Hdd",
            "BiosSetup",
            "Diags",
            "UefiTarget"
        ],
        "BootSourceOverrideEnabled": "Disabled",
        "BootSourceOverrideEnabled@Redfish.AllowableValues": [
            "Once",
            "Disabled"
        ],
        "UefiTargetBootSourceOverride": null
    },
    "BiosVersion": "USE103V",
    "Storage": {
        "@odata.id": "/redfish/v1/Systems/1/Storage"
    }
}

Give documentation feedback

GET – Server properties

Request URL​

Request body​

Response body​

Status code​

Example​

Request URL

Request body

Response body

Status code

Example