GET – Service root properties
Use the GET method to retrieve properties in Service Root (/redfish/v1/) for Redfish service.
Request URL
https://<BMC_IPADDR>/redfish/v1/
Request body
None
Response body
The response is a JSON object that contains the following parameters:
Field | Type | Description | |||
---|---|---|---|---|---|
Id | String | “RootService”. | |||
Name | String | “Root Service”. | |||
Description | String | This resource is used to represent a service root for a Redfish implementation. | |||
Vendor | String | “Lenovo” | |||
SessionService | Link | A reference link to session service resource. | |||
Managers | Link | A reference link to a collection of managers. | |||
RedfishVersion | String | Version of the implemented Redfish service. | |||
UUID | String | Unique identifier for the service instance. | |||
Chassis | Link | A reference link to chassis resource. | |||
Tasks | Link | A reference link to a collection of tasks. | |||
EventService | Link | A reference link to event service resource. | |||
JsonSchemeas | Link | A reference link to Json Schema resource. | |||
JobService | Link | A reference link to job service resource. | |||
AccountService | Link | A reference link to account service resource. | |||
CertificateService | Link | A reference link to certificate service resource. | |||
Systems | Link | A reference link to a collection of systems. | |||
Registries | Link | A reference link to a collection of registries. | |||
UpdateService | Link | A reference link to update service resource. | |||
TelemetryService | Link | A reference link to telemetry service resource. | |||
Links | Object | Expanded. | |||
Sessions | Link | A reference link to a collection of sessions. | |||
ProtocolFeaturesSupported | Object | Expanded. | |||
ExcerptQuery | Boolean | Indicates whether the 'excerpt' query parameter is supported. | |||
FilterQuery | Boolean | Indicates whether the $filter query parameter is supported. | |||
OnlyMemberQuery | Boolean | Indicates whether the 'only' query parameter is supported. | |||
SelectQuery | Boolean | Indicates whether the $select query parameter is supported. | |||
ExpandQuery | Object | Expanded. | |||
ExpandAll | Boolean | Indicates whether the $expand support of asterisk (expand all entries) is supported. | |||
Levels | Boolean | Indicates whether the expand support of the $levels qualifier is supported by the service. | |||
Links | Boolean | Indicates whether the $expand support of tilde (expand only entries in the Links section) is supported. | |||
MaxLevels | Integer | Indicates the maximum number value of the $levels qualifier in $expand operations. | |||
NoLinks | Boolean | Indicates whether the $expand support of period (only expand entries not in the Links section) is supported. | |||
DeepOperations | Object | Expanded. | |||
DeepPATCH | Boolean | An indication of whether the service supports the deep PATCH operation. | |||
DeepPOST | Boolean | An indication of whether the service supports the deep POST operation. | |||
MaxLevels | Number | The maximum levels of resources allowed in deep operations. |
Status code
HTTP Status Code | Error Message ID |
---|---|
500 | InternalError |
Example
The following example JSON response is returned:
{
"Tasks": {
"@odata.id": "/redfish/v1/TaskService"
},
"Chassis": {
"@odata.id": "/redfish/v1/Chassis"
},
"Id": "RootService",
"ProtocolFeaturesSupported": {
"ExpandQuery": {
"Levels": true,
"NoLinks": true,
"Links": true,
"ExpandAll": true,
"MaxLevels": 2
},
"OnlyMemberQuery": true,
"DeepOperations": {
"DeepPOST": false,
"DeepPATCH": false,
"MaxLevels": 2
},
"FilterQuery": true,
"ExcerptQuery": true,
"SelectQuery": true
},
"Links": {
"Sessions": {
"@odata.id": "/redfish/v1/SessionService/Sessions"
}
},
"RedfishVersion": "1.10.0",
"EventService": {
"@odata.id": "/redfish/v1/EventService"
},
"JsonSchemas": {
"@odata.id": "/redfish/v1/JsonSchemas"
},
"Systems": {
"@odata.id": "/redfish/v1/Systems"
},
"TelemetryService": {
"@odata.id": "/redfish/v1/TelemetryService"
},
"UpdateService": {
"@odata.id": "/redfish/v1/UpdateService"
},
"Registries": {
"@odata.id": "/redfish/v1/Registries"
},
"CertificateService": {
"@odata.id": "/redfish/v1/CertificateService"
},
"UUID": "3D03A592-79E7-11EA-9029-B1651358D6FA",
"Vendor": "Lenovo",
"Name": "Root Service",
"JobService": {
"@odata.id": "/redfish/v1/JobService"
},
"Description": "This resource is used to represent a service root for a Redfish implementation.",
"@odata.type": "#ServiceRoot.v1_7_0.ServiceRoot",
"SessionService": {
"@odata.id": "/redfish/v1/SessionService"
},
"@odata.id": "/redfish/v1/",
"@odata.etag": "\"9d900d0444cd31da3490c\"",
"AccountService": {
"@odata.id": "/redfish/v1/AccountService"
},
"Managers": {
"@odata.id": "/redfish/v1/Managers"
}
}