ServiceRoot
Schema Definition
This object represents the root Redfish service.Properties
| Property | Type | Nullable | Required | Permission | Description |
|---|---|---|---|---|---|
| @odata.context | String | read-only | The OData description of a payload. Format: uri | ||
| @odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
| @odata.type | String | read-only | The type of a resource. | ||
| Chassis { | Reference(ChassisCollection) | read-only | This is a link to a collection of Chassis. | ||
| @odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
| } | |||||
| Description | String | Yes | read-only | Provides a description of this resource and is used for commonality in the schema definitions. | |
| Id | String | GET | read-only | Uniquely identifies the resource within the collection of like resources. | |
| JsonSchemas { | Reference(JsonSchemaFileCollection) | read-only | This is a link to a collection of Json-Schema files. | ||
| @odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
| } | |||||
| Links { | Object | GET | read-write | Contains references to other resources that are related to this resource. | |
| Oem { } | Object | read-write | Oem extension object. | ||
| } | |||||
| Name | String | GET | read-only | The name of the resource or array element. | |
| Oem { | Object | read-write | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. | ||
| EID_47597 { | Object | read-write | RECS|Box ServiceRoot extension | ||
| APIVersion | String | read-only | The version of the RECS|Box extension. Pattern: ^\d+\.\d+\.\d+$ | ||
| Baseboards { | Reference(BaseboardCollection) | read-only | This is a link to a collection of Baseboards. | ||
| @odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
| } | |||||
| ComposedNodes { | Reference(ComposedNodeCollection) | read-only | This is a link to a collection of ComposedNodes. | ||
| @odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
| } | |||||
| PCIeDevices { | Reference(PCIeDeviceCollection) | read-only | This is a link to a collection of PCIeDevices. | ||
| @odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
| } | |||||
| Switches { | Reference(SwitchCollection) | read-only | This is a link to a collection of Ethernet- and PCIeSwitches. | ||
| @odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
| } | |||||
| } | |||||
| } | |||||
| RedfishVersion | String | read-only | The version of the Redfish service. Pattern: ^\d+\.\d+\.\d+$ | ||
| Systems { | Reference(ComputerSystemCollection) | read-only | This is a link to a collection of Systems. | ||
| @odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
| } | |||||
| UUID | Guid | Yes | read-only | Unique identifier for a service instance. When SSDP is used, this value should be an exact match of the UUID value returned in a 200OK from an SSDP M-SEARCH request during discovery. Pattern: ([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}) |
Operations
GET
Request
GET /redfish/v1
Content-Type: application/json
Content-Type: application/json
Response
{
"@odata.context": "uri",
"@odata.id": "/redfish/v1",
"@odata.type": "String",
"Chassis": {
"@odata.id": "/redfish/v1/Chassis"
},
"Description": "String",
"Id": "String",
"JsonSchemas": {
"@odata.id": "/redfish/v1/JsonSchemas"
},
"Links": {
"Oem": { }
}
"Name": "String",
"Oem": {
"EID_47597": {
"APIVersion": "String",
"Baseboards": {
"@odata.id": "/redfish/v1/Baseboards"
},
"ComposedNodes": {
"@odata.id": "/redfish/v1/ComposedNodes"
},
"PCIeDevices": {
"@odata.id": "/redfish/v1/PCIeDevices"
},
"Switches": {
"@odata.id": "/redfish/v1/Switches"
}
}
}
"RedfishVersion": "String",
"Systems": {
"@odata.id": "/redfish/v1/Systems"
},
"UUID": "00000000-0000-0000-0000-000000000000"
}
"@odata.context": "uri",
"@odata.id": "/redfish/v1",
"@odata.type": "String",
"Chassis": {
"@odata.id": "/redfish/v1/Chassis"
},
"Description": "String",
"Id": "String",
"JsonSchemas": {
"@odata.id": "/redfish/v1/JsonSchemas"
},
"Links": {
"Oem": { }
}
"Name": "String",
"Oem": {
"EID_47597": {
"APIVersion": "String",
"Baseboards": {
"@odata.id": "/redfish/v1/Baseboards"
},
"ComposedNodes": {
"@odata.id": "/redfish/v1/ComposedNodes"
},
"PCIeDevices": {
"@odata.id": "/redfish/v1/PCIeDevices"
},
"Switches": {
"@odata.id": "/redfish/v1/Switches"
}
}
}
"RedfishVersion": "String",
"Systems": {
"@odata.id": "/redfish/v1/Systems"
},
"UUID": "00000000-0000-0000-0000-000000000000"
}
POST
This operation is not supported on this resource and will result in the following response:
HTTP/1.1 405 Method Not Allowed
PATCH
This operation is not supported on this resource and will result in the following response:
HTTP/1.1 405 Method Not Allowed
DELETE
This operation is not supported on this resource and will result in the following response:
HTTP/1.1 405 Method Not Allowed