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
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. Allowable values: On Nmi GracefulShutdown GracefulRestart ForceOn ForceOff ForceRestart
AssetTag				String	The asset tag of the system
Bios				Link	A reference to the BIOS settings associated with this system.
BiosVersion				String	The version of the system BIOS.
Boot				Object	Describes boot information for the current resource. Changes to this object do not alter the BIOS persistent boot order configuration
	AutomaticRetryConfig			String	“Disabled” or “RetryAttempts”
	AutomaticRetryConfig@Redfish.AllowableValues			Array	“Disabled” or “RetryAttempts”
	BootSourceOverrideEnabled			String	Describes the state of the Boot Source Override feature
	BootSourceOverrideMode			String	The BIOS Boot Mode (UEFI only) to be used when BootSourceOverrideTarget boot source is booted from
	BootSourceOverrideTarget			String	The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is “Once”.
	BootSourceOverrideTarget @Redfish.AllowableValues			Array String	“None”, “Pxe”, “Hdd”, “Cd”, “Diags”, “BiosSetup”, “Usb”, or “UefiTarget”
	UefiTargetBootSourceOverride			String	The UEFI Device Path of the device to boot from when BootSourceOverrideSupported is UefiTarget.
	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.
	TrustedModuleRequiredToBoot			Boolean	The Trusted Module boot requirement.
	StopBootOnFault			String	If the boot should stop on a fault.
Description				String	This resource is used to represent a computing system for a Redfish implementation.
EthernetInterfaces				Link	A reference to the collection of Ethernet interfaces associated with this system.
GraphicalConsole				Object	Expanded.
	ConnectTypesSupported			Array String	KVMIP
	MaxConcurrentSessions			Integer	4
	ServiceEnabled			Boolean	True
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	Enabled
	TimeoutAction			String	ResetSystem
Id				String	“1”
LastResetTime				String	The date and time when the system was last reset or rebooted.
Links				Object	An object for reference links.
	Chassis			Array	An array of references to the chassis in which this system is contained.
	ManagedBy			Array	An array of references to Managers responsible for this system.
LogServices				Link	A reference to the collection of Log Services associated with this system.
Manufacturer				String	The manufacturer tag of the system
Memory				Link	A reference to the collection of memory device associated with this system.
MemorySummary				Object	This object describes the memory of the system in general detail.
	TotalSystemMemoryGiB			Number	The total installed, operating system-accessible memory (RAM), measured in GiB.
	Status			Object	Reflect the memory summary status.
		State		String	“Enabled”.
		Health		String	This represents the health state of this resource in the absence of its dependent resources.
Model				String	Model of the system
Name				String	ComputerSystem
NetworkInterfaces				Link	A reference to the collection of network interfaces associated with this system.
PCIeDevices				Array	An array of references to pci devices in which this system is contained.
PartNumber				String	null
PCIeFunctions				Array	An array of references to pci functions in which this system is contained.
	PCIeFunctions[]			Link	Link to PCIeFunction
PowerRestorePolicy				String	The desired power state of the system when power is restored after a power loss.
PowerState				String	Current power state of the system.
ProcessorSummary				Object	This object describes the central processors of the system in general detail.
	CoreCount			Number	The number of cores in the system.
	Count			Number	Calculate. Add up all CoreCount.
	Status			Object	Reflect the processor summary status.
		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.
SerialConsole				Object	Expanded.
	IPMI			Number	Expanded.
		ServiceEnabled		Boolean	False
	SSH			Object	Expanded.
		HotKeySequenceDisplay		String	The hotkey sequence available for the user to exit the serial console session.
		Port		Integer	The port assigned to the service.
		ServiceEnabled		Boolean	An indication of whether the service is enabled for this system.
SerialNumber				String	Serial number of the system
Status				Object	Expanded.
	State			String	Enabled
	HealthRollup			String	OK
	Health			String	This represents the health state of this resource in the absence of its dependent resources.
Storage				Link	A reference to the collection of storage device with this system.
SystemType				String	The type of computer system represented by this resource
UUID				String	The universal unique identifier (UUID) for this system
SecureBoot				Link	A reference to the SecureBoot settings associated with this system.
SubModel				String	Sub model of the system
SKU				String	The manufacturer SKU for this system.
VirtualMedia				Link	A reference to the virtual media services for this system.
@Redfish.Settings				Object	Expanded.
	Messages			Array	Items: object Item count: 0 or 1
		Messages[N]		Object	Expanded. Indicate a “RebootRequired” message when successful to modify the Boot/BootOrder of Pending resource.
			MessageId	String	“ExtendedError.1.2. RebootRequired”
	SettingsObject			Link	/redfish/v1/Systems/1/Pending
	SupportedApplyTimes			Array	Items: string Item count: 1
		SupportedApplyTimes[0]		String	“OnReset”
	Time			String	Indicate the time at which the Settings resource was last applied, otherwise the value is null.
IndicatorLED				String	The indicator light state for the indicator light associated with this system

Status code

HTTP Status Code	Error Message ID
500	InternalError

Example

The following example JSON response is returned:

{
    "@Redfish.Settings": {
        "@odata.type": "#Settings.v1_3_0.Settings",
        "Messages": [],
        "SettingsObject": {
            "@odata.id": "/redfish/v1/Systems/1/Pending"
        },
        "SupportedApplyTimes": [
            "OnReset"
        ],
        "Time": null
    },
    "@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem",
    "@odata.etag": "\"38AA1EF7\"",
    "@odata.id": "/redfish/v1/Systems/1",
    "@odata.type": "#ComputerSystem.v1_16_0.ComputerSystem",
    "Actions": {
        "#ComputerSystem.Reset": {
            "@Redfish.ActionInfo": "/redfish/v1/Systems/1/ResetActionInfo",
            "target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset",
            "title": "Reset"
        },
        "Oem": {
            ...
            }
        }
    },
    "AssetTag": "",
    "Bios": {
        "@odata.id": "/redfish/v1/Systems/1/Bios"
    },
    "BiosVersion": "IHE109B",
    "Boot": {
        "AutomaticRetryConfig": "RetryAttempts",
        "AutomaticRetryConfig@Redfish.AllowableValues": [
            "Disabled",
            "RetryAttempts"
        ],
        "BootOptions": {
            "@odata.id": "/redfish/v1/Systems/1/BootOptions"
        },
        "BootOrder": [
            "Boot000A",
            "Boot0001",
            "Boot0002",
            "Boot0003"
        ],
        "BootSourceOverrideEnabled": "Disabled",
        "BootSourceOverrideMode": "UEFI",
        "BootSourceOverrideTarget": "None",
        "BootSourceOverrideTarget@Redfish.AllowableValues": [
            "None",
            "Pxe",
            "Hdd",
            "Cd",
            "Diags",
            "BiosSetup",
            "Usb",
            "UefiTarget"
        ],
        "StopBootOnFault": "Never",
        "TrustedModuleRequiredToBoot": "Disabled",
        "UefiTargetBootSourceOverride": null
    },
    "Description": "This resource is used to represent a computing system                     for a Redfish implementation.",
    "EthernetInterfaces": {
        "@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces"
    },
    "GraphicalConsole": {
        "ConnectTypesSupported": [
            "KVMIP"
        ],
        "MaxConcurrentSessions": 4,
        "ServiceEnabled": true
    },
    "HostWatchdogTimer": {
        "FunctionEnabled": false,
        "Status": {
            "State": "Enabled"
        },
        "TimeoutAction": "ResetSystem"
    },
    "Id": "1",
    "IndicatorLED": "Off",
    "LastResetTime": "2024-12-04T02:40:29+00:00",
    "Links": {
        "Chassis": [
            {
                "@odata.id": "/redfish/v1/Chassis/1"
            }
        ],
        "ManagedBy": [
            {
                "@odata.id": "/redfish/v1/Managers/1"
            }
        ]
    },
    "LogServices": {
        "@odata.id": "/redfish/v1/Systems/1/LogServices"
    },
    "Manufacturer": "Lenovo",
    "Memory": {
        "@odata.id": "/redfish/v1/Systems/1/Memory"
    },
    "MemorySummary": {
        "Status": {
            "Health": "OK",
            "State": "Enabled"
        },
        "TotalSystemMemoryGiB": 256
    },
    "Model": "ThinkSystem SR650 V4",
    "Name": "ComputerSystem",
    "NetworkInterfaces": {
        "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces"
    },
    "Oem": {
        ...
        }
    },
    "PCIeDevices": [
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot14_0xb40000"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot3_0xb0000"
        }
    ],
    "PCIeDevices@odata.count": 2,
    "PCIeFunctions": [
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot3_0xb0000/PCIeFunctions/slot_3.00"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot3_0xb0000/PCIeFunctions/slot_3.01"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot14_0xb40000/PCIeFunctions/slot_14.00"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot14_0xb40000/PCIeFunctions/slot_14.01"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot14_0xb40000/PCIeFunctions/slot_14.02"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot14_0xb40000/PCIeFunctions/slot_14.03"
        }
    ],
    "PartNumber": "SB27C00442",
    "PowerRestorePolicy": "LastState",
    "PowerState": "On",
    "ProcessorSummary": {
        "Count": 2,
        "Status": {
            "Health": "OK"
        }
    },
    "Processors": {
        "@odata.id": "/redfish/v1/Systems/1/Processors"
    },
    "SKU": "7DGCCTO1WW",
    "SecureBoot": {
        "@odata.id": "/redfish/v1/Systems/1/SecureBoot"
    },
    "SerialConsole": {
        "IPMI": {
            "ServiceEnabled": false
        },
        "SSH": {
            "HotKeySequenceDisplay": "Press ~. to exit console",
            "Port": 22,
            "ServiceEnabled": true
        }
    },
    "SerialNumber": "BHSFW2U005",
    "Status": {
        "Health": "OK",
        "HealthRollup": "OK",
        "State": "Enabled"
    },
    "Storage": {
        "@odata.id": "/redfish/v1/Systems/1/Storage"
    },
    "SubModel": "7DGC",
    "SystemType": "Physical",
    "UUID": "FE57AA52-E969-4448-9C0B-045179900052",
    "VirtualMedia": {
        "@odata.id": "/redfish/v1/Systems/1/VirtualMedia"
    }
}

Give documentation feedback

GET – Server properties

Request URL​

Request body​

Response body​

Status code​

Example​

Request URL

Request body

Response body

Status code

Example