GET – Service Root
Use the GET method to retrieve properties in Service Root (/redfish/v1/) for Redfish service.
Request
GET https://{{IP}}/redfish/v1/
Content-Type: application/json
Response
The response of the request will be in JSON format. The properties are mentioned in the following.
Name | Type | Read-only | Description | |||
|---|---|---|---|---|---|---|
ODataAttributes | Refer to OData Support | |||||
Oem | Object | OEM Extension (Optional), Refer to Resource Complex Types | ||||
Id(M) | String | True | Refer to Resource Type Definitions | |||
Name(M) | String | True | ||||
Description | String | True | ||||
UUID | String | True | ||||
RedfishVersion | String | True | The value of this string shall represent the version of the Redfish service. The format of this string shall be of the format major-version.minor-version.errata in compliance with the Protocol Version Section of the Redfish specification. | |||
Product | String | True | The product name associated with this Redfish service. | |||
ProtocolFeaturesSupported | Object | True | Contains information about protocol features supported by the service. | |||
Name | Type | Read -only | Description | |||
ExcerptQuery | Boolean | True | This indicates whether the 'excerpt' query parameter is supported. | |||
ExpandQuery | Object | True | Contains information about the use of $expand in the service. Refer to Expand Query Properties | |||
FilterQuery | Boolean | True | This indicates whether the $filter query parameter is supported. | |||
OnlyMemberQuery | Boolean | True | This indicates whether the 'only' query parameter is supported. | |||
SelectQuery | Boolean | True | This indicates whether the $select query parameter is supported. | |||
Systems(N) | Object | True | Link to a collection of Systems | |||
Chassis(N) | Object | True | Link to a collection of Chassis | |||
Managers(N) | Object | True | Link to a collection of Managers | |||
Tasks(N) | Object | True | Link to Task Service | |||
AccountService(N) | Object | True | Link to the Account Service. | |||
EventService(N) | Object | True | Link to the Event Service. | |||
SessionService(N) | Object | True | Link to the Session Service. | |||
Registries(N) | Object | True | Link to a collection of Registries. | |||
JsonSchemas(N) | Object | True | Link to a collection of Json-Schema files. | |||
UpdateService(N) | Object | True | Link to the Update Service. | |||
CompositionService | Object | True | Link to the Composition Service. | |||
TelemetryService | Object | True | Link to the Telemetry Service. | |||
Vendor | String | True | The vendor or manufacturer associated with this Redfish service. | |||
CertificateService | Object | True | Link to the Certificate Service. | |||
Links(M) | Object | True | The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource. | |||
Name | Type | Read- only | Description | |||
Oem | Object | False | OEM Extension (Optional), Refer to Resource Complex Types | |||
Session | Array | True | Link to a collection of Sessions | |||
Name | Type | Read -only | Description |
ExpandAll | Boolean | True | This indicates whether the $expand support of asterisk (expand all entries) is supported. |
Levels | Boolean | True | This indicates whether the expand support of the $levels qualifier is supported by the service. |
Links | Boolean | True | This indicates whether the $expand support of tilde (expand only entries in the Links section) is supported. |
MaxLevels | Boolean | True | This indicates the maximum number value of the $levels qualifier in $expand operations. |
NoLinks | Boolean | True | This indicates whether the $expand support of period (expand only entries not in the Links section) is supported. |
Name | Type | Read -only | Description | |||
Ami | Object | True | Contains information related to AMI features supported by the service. | |||
Name | Type | Read-only | Description | |||
@odata.type | String | True | Refer to OData Support | |||
Configurations | Object | True | A reference to AMI Oem Configurations URI. Note Links will be available only when | |||
InventoryDataStatus | Object | True | A reference to the InventoryData Status URI. Note Links will be available only when AMI OEM Host Interface feature is enabled. | |||
RtpVersion | String | True | This indicates the Redfish Technology Pack version. | |||