GET – BMC management properties

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

Request URL

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

Request body

None

Response body

Field				Type	Description
Id				String	Always set to 1.
Name				String	“Manager”.
Actions				Object	Expanded.
	#Manager.Reset			Object	Expanded.
		ResetType@Redfish.AllowableValues		Array	Items: string Item count: 2
			ResetType@Redfish.AllowableValues[0]	String	“GracefulRestart”. It indicates bmc will be restart in a graceful way.
			ResetType@Redfish.AllowableValues[1]	String	“ForceRestart”. It indicates bmc will be restart right away.
	#Manager.ResetToDefaults			Object	Expanded
		ResetType@Redfish.AllowableValues		Array	Items: string Item count: 1
			ResetType@Redfish.AllowableValues[0]	String	“ResetAll”. Reset all settings to factory defaults.
AutoDSTEnabled				Boolean	true, false
CommandShell				Object	Expanded.
	ServiceEnabled			Boolean	True, if SSH is enabled. False, if SSH is disabled.
	MaxConcurrentSessions			Integer	2
	ConnectTypesSupported			Array	SSH. Currently only SSH is supported.
DateTime				String	The current DateTime (with offset) for the manager, used to set or read time.
DateTimeLocalOffset				String	The time offset from UTC that the DateTime property is set to in format: +06:00 .
Description				String	This resource is used to represent a management subsystem for a Redfish implementation.
GraphicalConsole				Object	Expanded.
	ServiceEnabled			Boolean	True, if FOD key is installed.
	MaxConcurrentSessions			Integer	6.
	ConnectTypesSupported			Array	Items: string. Item count: 1.
		ConnectTypesSupported[0]		String	“KVMIP”.
ManagerType				String	This property represents the type of manager that this resource represents. This property represents the type of manager that this resource represents. The value is “BMC (A controller which provides management functions for a single computer system)”.
Model				String	The model information of this Manager as defined by the manufacturer. The value is “Lenovo XClarity Controller”.
EthernetInterfaces				Link	A link to a URI reference to collection of Ethernet interface. This is a reference to a collection of NICs that this manager uses for network communication.
HostInterfaces				Link	A link to a URI reference to collection of host interface. This is a reference to a collection of NICs that host uses for network communication.
LogServices				Link	A link to a URI reference to collection of log service which is a collection of Logs used by the manager.
NetworkProtocol				Link	A link to a URI reference to collection of network protocol which is a reference to network services and their settings that the manager controls.
SerialInterfaces				Link	A link to a URI reference to collection of serial interface that this manager uses for serial and console communication.
VirtualMedia				Link	A link to a URI reference to collection of virtual media which are for the use of this manager.
FirmwareVersion				String	Firmware version of this Manager.
Links				Object	References to resources that are related to, but not contained by (subordinate to) this resource.
	ManagerForChassis			Array	An array of references to the chassis that this manager has control over."
		ManagerForChassis[0]		Link	The value of this property is a URI reference to a resource of chassis.
	ManagerForChassis@odata.count			Int	1
	ManagerForServers			Array	An array of references to the systems that this manager has control over.
		ManagerForServers[0]		Link	The value of this property is a URI reference to a resource of computer system.
	ManagerForServers@odata.count			Int	1
	ActiveSoftwareImage			Link	The value of this property is a URI reference to a resource of firmware inventory.
	SoftwareImages			Array	Items: link Item count: 2
		SoftwareImages[N]		Link	The value of this property is a URI reference to a resource of firmware inventory.
	SoftwareImages.@odata.count			Int	2
PowerState				Object	The value of this property indicates power state. It is always “On”.
SerialConsole				Object	Expanded.
	ConnectTypesSupported			Array	Items: string. Item count: 2.
		ConnectTypesSupported[0]		String	“IPMI”.
		ConnectTypesSupported[1]		String	“SSH”.
	MaxConcurrentSessions			Integer	2.
	ServiceEnabled			Boolean	True, if SSH is enabled. False, if SSH is disabled.
ServiceEntryPointUUID				String	The value of this property indicates UUID of service entry point.
Status				Object	Expanded.
	State			String	The value of this property indicates state of manager. It is always “Enabled”.
UUID				String	The value of this property indicates UUID of manager.

Status code

HTTP Status Code	Error Message ID
500	InternalError

Example

The following example JSON response is returned:

{
    "DateTimeLocalOffset": "+00:00",
    "Id": "1",
    "AutoDSTEnabled": false,
    "ManagerType": "BMC",
    "NetworkProtocol": {
        "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol"
    },
    "Links": {
        "ActiveSoftwareImage": {
            "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/BMC-Primary"
        },
        "SoftwareImages": [
            {
                "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/BMC-Primary"
            },
            {
                "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/BMC-Backup"
            }
        ],
        "ManagerForServers@odata.count": 1,
        "ManagerForChassis": [
            {
                "@odata.id": "/redfish/v1/Chassis/1"
            }
        ],
        "ManagerForServers": [
            {
                "@odata.id": "/redfish/v1/Systems/1"
            }
        ],
        "ManagerForChassis@odata.count": 1,
        "SoftwareImages@odata.count": 2
    },
    "LogServices": {
        "@odata.id": "/redfish/v1/Systems/1/LogServices"
    },
    "SerialConsole": {
        "MaxConcurrentSessions": 2,
        "ConnectTypesSupported": [
            "IPMI",
            "SSH"
        ],
        "ServiceEnabled": true
    },
    "CommandShell": {
        "MaxConcurrentSessions": 2,
        "ConnectTypesSupported": [
            "SSH"
        ],
        "ServiceEnabled": true
    },
    "HostInterfaces": {
        "@odata.id": "/redfish/v1/Managers/1/HostInterfaces"
    },
    "VirtualMedia": {
        "@odata.id": "/redfish/v1/Managers/1/VirtualMedia"
    },
    "SerialInterfaces": {
        "@odata.id": "/redfish/v1/Managers/1/SerialInterfaces"
    },
    "DateTime": "2021-08-26T16:48:53+00:00",
    "Actions": {
        "#Manager.ResetToDefaults": {
            "@Redfish.ActionInfo": "/redfish/v1/Managers/1/ResetToDefaultsActionInfo",
            "target": "/redfish/v1/Managers/1/Actions/Manager.ResetToDefaults",
            "title": "ResetToDefaults",
            "ResetType@Redfish.AllowableValues": [
                "ResetAll"
            ]
        },
        "#Manager.Reset": {
            "@Redfish.ActionInfo": "/redfish/v1/Managers/1/ResetActionInfo",
            "target": "/redfish/v1/Managers/1/Actions/Manager.Reset",
            "title": "Reset",
            "ResetType@Redfish.AllowableValues": [
                "GracefulRestart",
                "ForceRestart"
            ]
        }
    },
    "FirmwareVersion": "TGBT23K 1.50 2021-07-30",
    "UUID": "3D03A592-79E7-11EA-9029-B1651358D6FA",
    "Status": {
        "State": "Enabled"
    },
    "PowerState": "On",
    "Name": "Manager",
    "Description": "This resource is used to represent a management subsystem for a Redfish implementation.",
    "ServiceEntryPointUUID": "3D03A592-79E7-11EA-9029-B1651358D6FA",
    "Oem": {
        "Lenovo": {
            "ServiceAdvisor": "/redfish/v1/Managers/1/Oem/Lenovo/ServiceAdvisor",
            "AgentlessCapabilities": [
                "RaidLink",
                "OOB_PCIe",
                "RaidLinkConfig",
                "RaidLinkAlert",
                "OOB_PCIe_Config",
                "OOB_Option_Firmware_Update",
                "PreStandardPLDM",
                "StandardPLDM",
                "Storlib",
                "M2"
            ],
            "RemoteControl": {
                "@odata.id": "/redfish/v1/Managers/1/Oem/Lenovo/RemoteControl"
            },
            "ServerProfile": {
                "@odata.id": "/redfish/v1/Managers/1/Oem/Lenovo/ServerProfile"
            },
            "RecipientsSettings": {
                "RetryCount": 5,
                "RetryInterval": 0.5,
                "RntryRetryInterval": 0.5
            },
            "Configuration": {
                "@odata.id": "/redfish/v1/Managers/1/Oem/Lenovo/Configuration"
            },
            "FoD": {
                "@odata.id": "/redfish/v1/Managers/1/Oem/Lenovo/FoD"
            },
            "KCSEnabled": true,
            "Security": {
                "@odata.id": "/redfish/v1/Managers/1/Oem/Lenovo/Security"
            },
            "@odata.type": "#LenovoManager.v1_0_0.LenovoManagerProperties",
            "DateTimeService": {
                "@odata.id": "/redfish/v1/Managers/1/Oem/Lenovo/DateTimeService"
            },
            "release_name": "whitley_gp_21c",
            "Watchdogs": {
                "@odata.id": "/redfish/v1/Managers/1/Oem/Lenovo/Watchdogs"
            },
            "RemoteMap": {
                "@odata.id": "/redfish/v1/Managers/1/Oem/Lenovo/RemoteMap"
            },
            "ServiceData": {
                "@odata.id": "/redfish/v1/Managers/1/Oem/Lenovo/ServiceData"
            },
            "SecureKeyLifecycleService": {
                "@odata.id": "/redfish/v1/Managers/1/Oem/Lenovo/SecureKeyLifecycleService"
            },
            "OPSettings": {
                "ClientID": null,
                "AuthorizationServerUri": null,
                "SSOState": false,
                "PubKey": null,
                "UserInfoUri": ""
            },
            "Recipients": {
                "@odata.id": "/redfish/v1/Managers/1/Oem/Lenovo/Recipients"
            }
        }
    },
    "@odata.type": "#Manager.v1_8_0.Manager",
    "GraphicalConsole": {
        "MaxConcurrentSessions": 6,
        "ConnectTypesSupported": [
            "KVMIP"
        ],
        "ServiceEnabled": true
    },
    "@odata.id": "/redfish/v1/Managers/1",
    "@odata.etag": "\"19824603b212f31d5e3a26\"",
    "Model": "Lenovo XClarity Controller",
    "EthernetInterfaces": {
        "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces"
    }
}

Give documentation feedback

GET – BMC management properties

Request URL​

Request body​

Response body​

Status code​

Example​

Request URL

Request body

Response body

Status code

Example