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: XCC-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	This should be 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.
	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
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”

Status code

HTTP Status Code	Error Message ID
500	InternalError

Example

The following example JSON response is returned:

{
    "SerialNumber": "NARVIR073",
    "Id": "1",
    "IndicatorLED": "Off",
    "PowerState": "On",
    "ProcessorSummary": {
        "Status": {
            "HealthRollup": "OK",
            "Health": "OK",
            "State": "Enabled"
        },
        "Metrics": {
            "@odata.id": "/redfish/v1/Systems/1/ProcessorSummary/ProcessorMetrics"
        },
        "Count": 1,
        "Model": "Genuine Intel(R) CPU 0000%@",
        "LogicalProcessorCount": 48
    },
    "NetworkInterfaces": {
        "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces"
    },
    "Storage": {
        "@odata.id": "/redfish/v1/Systems/1/Storage"
    },
    "PartNumber": null,
    "SubModel": "7Z59",
    "Bios": {
        "@odata.id": "/redfish/v1/Systems/1/Bios"
    },
    "UUID": "55833bf4-5bbb-11e7-997f-0a94ef402c57",
    "Name": "ComputerSystem",
    "HostWatchdogTimer": {
        "WarningAction": "None",
        "WarningAction@Redfish.AllowableValues": [
            "None"
        ],
        "Status": {
            "State": "Disabled"
        },
        "TimeoutAction": "PowerCycle",
        "TimeoutAction@Redfish.AllowableValues": [
            "PowerCycle"
        ],
        "FunctionEnabled": false
    },
    "Oem": {
        "Lenovo": {
            "ScheduledPowerActions": {
                "@odata.id": "/redfish/v1/Systems/1/Oem/Lenovo/ScheduledPowerActions"
            },
            "FrontPanelUSB": {
                "InactivityTimeoutMins": 5,
                "IDButton": "On",
                "PortSwitchingTo": "Server",
                "FPMode": "Shared"
            },
            "Sensors": {
                "@odata.id": "/redfish/v1/Chassis/1/Oem/Lenovo/Sensors"
            },
            "SystemStatus": "BootingOSOrInUndetectedOS",
            "NumberOfReboots": 22,
            "HistorySysPerf": {
                "@odata.id": "/redfish/v1/Systems/1/Oem/Lenovo/HistorySysPerf"
            },
            "@odata.type": "#LenovoComputerSystem.v1_0_0.LenovoSystemProperties",
            "TotalPowerOnHours": 219,
            "Metrics": {
                "@odata.id": "/redfish/v1/Systems/1/Oem/Lenovo/Metrics"
            },
            "BootSettings": {
                "@odata.id": "/redfish/v1/Systems/1/Oem/Lenovo/BootSettings"
            }
        }
    },
    "@odata.type": "#ComputerSystem.v1_9_0.ComputerSystem",
    "Manufacturer": "Lenovo",
    "@odata.etag": "\"42a3dfa9254124eb4ca7a70e77fb8ce7\"",
    "Actions": {
        "#ComputerSystem.Reset": {
            "title": "Reset",
            "target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset",
            "@Redfish.ActionInfo": "/redfish/v1/Systems/1/ResetActionInfo",
            "ResetType@Redfish.AllowableValues": [
                "On",
                "Nmi",
                "GracefulShutdown",
                "GracefulRestart",
                "ForceOn",
                "ForceOff",
                "ForceRestart"
            ]
        },
        "Oem": {
            "#LenovoComputerSystem.BootToBIOSSetup": {
                "title": "BootToBIOSSetup",
                "target": "/redfish/v1/Systems/1/Actions/Oem/LenovoComputerSystem.BootToBIOSSetup"
            },
            "#LenovoComputerSystem.CustomizedReset": {
                "target": "/redfish/v1/Systems/1/Actions/Oem/LenovoComputerSystem.CustomizedReset",
                "title": "CustomizedReset",
                "ResetType@Redfish.AllowableValues": [
                    "On"
                ]
            }
        }
    },
    "EthernetInterfaces": {
        "@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces"
    },
    "Boot": {
        "BootSourceOverrideEnabled@Redfish.AllowableValues": [
            "Once",
            "Disabled"
        ],
        "BootSourceOverrideTarget@Redfish.AllowableValues": [
            "None",
            "Pxe",
            "Cd",
            "Usb",
            "Hdd",
            "BiosSetup",
            "Diags",
            "UefiTarget"
        ],
        "UefiTargetBootSourceOverride": null,
        "BootSourceOverrideTarget": "None",
        "BootSourceOverrideEnabled": "Disabled",
        "BootSourceOverrideMode": "UEFI"
    },
    "@odata.id": "/redfish/v1/Systems/1",
    "AssetTag": "",
    "PCIeFunctions": [
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot_13/PCIeFunctions/slot_13.00"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot_13/PCIeFunctions/slot_13.01"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_1/PCIeFunctions/ob_1.02"
        }
    ],
    "SystemType": "Physical",
    "BiosVersion": "M5E101Q",
    "HostName": "Narvi-SR860V2-1",
    "MemorySummary": {
        "Status": {
            "HealthRollup": "OK",
            "Health": "OK",
            "State": "Enabled"
        },
        "Metrics": {
            "@odata.id": "/redfish/v1/Systems/1/MemorySummary/MemoryMetrics"
        },
        "TotalSystemMemoryGiB": 16
    },
    "Processors": {
        "@odata.id": "/redfish/v1/Systems/1/Processors"
    },
    "PCIeFunctions@odata.count": 3,
    "SecureBoot": {
        "@odata.id": "/redfish/v1/Systems/1/SecureBoot"
    },
    "PCIeDevices": [
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot_13"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_1"
        }
    ],
    "TrustedModules": [
        {
            "Status": {
                "State": "Absent"
            },
            "InterfaceType": "TPM2_0",
            "FirmwareVersion": "7.2.1.0",
            "InterfaceTypeSelection": "BiosSetting"
        }
    ],
    "PCIeDevices@odata.count": 2,
    "SKU": "7Z59CTO1WW",
    "Model": "ThinkSystem SR860",
    "Description": "This resource is used to represent a computing system for a Redfish implementation.",
    "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"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/4"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/5"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/6"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/7"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/8"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/9"
            }
        ],
        "Chassis": [
            {
                "@odata.id": "/redfish/v1/Chassis/1"
            }
        ],
        "PoweredBy": [
            {
                "@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/0"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/1"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/2"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/3"
            }
        ],
        "ManagedBy": [
            {
                "@odata.id": "/redfish/v1/Managers/1"
            }
        ]
    },
    "LogServices": {
        "@odata.id": "/redfish/v1/Systems/1/LogServices"
    },
    "Memory": {
        "@odata.id": "/redfish/v1/Systems/1/Memory"
    },
    "Status": {
        "HealthRollup": "OK",
        "Health": "OK",
        "State": "Enabled"
    }
}

Give documentation feedback

GET – Server properties

Request URL​

Request body​

Response body​

Status code​

Example​

Request URL

Request body

Response body

Status code

Example