meta data for this page
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
documentation:redfish_api:service_root [2017/03/30 08:58] – bil | documentation:redfish_api:service_root [2017/10/13 12:51] (current) – removed vor | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Service Root ====== | ||
- | This object represents the root Redfish service. | ||
- | |||
- | Redfish Schema Version: [[http:// | ||
- | |||
- | ===== GET ===== | ||
- | |||
- | ==== Request ==== | ||
- | |||
- | < | ||
- | GET /redfish/v1 | ||
- | Content-Type: | ||
- | </ | ||
- | |||
- | === Authorisation === | ||
- | |||
- | No authorisation reqired. | ||
- | |||
- | ==== Response ==== | ||
- | |||
- | ^ Attribute ^ Type ^ Nullable ^ Description ^ | ||
- | | Id | String | No | Uniquely identifies the resource within the collection of like resources. | | ||
- | | Name | String | No | The name of the resource or array element. | | ||
- | | Description | String | No | Provides a description of this resource. | | ||
- | | RedfishVersion | String | No | The version of the Redfish service in format Major.Minor.Errata | | ||
- | | UUID | String | No | Unique identifier for a service instance. \\ The format of this string is a 32-byte value in the form 8-4-4-4-12. \\ If SSDP is used, this value is an exact match of the UUID value returned in a 200OK from an SSDP M-SEARCH request during discovery. Client software should only treat the overall value as a universally unique identifier and should not interpret any sub-fields within the UUID. | | ||
- | | AccountService | Object | No | Link to the [[documentation: | ||
- | | SessionService | Object | No | Link to the [[documentation: | ||
- | | Managers | Object | No | Link to a collection of [[documentation: | ||
- | | Chassis | Object | No | Link to a collection of [[documentation: | ||
- | | Systems | Object | No | Link to a collection of [[documentation: | ||
- | | EthernetSwitches | Object | No | Link to a collection of [[documentation: | ||
- | | PcieSwitches | Object | No | Link to a collection of [[documentation: | ||
- | | ComposedNodes | Object | No | Link to a collection of [[documentation: | ||
- | | Oem | Array | No | Collection of [[# | ||
- | | Links | Object | No | [[# | ||
- | |||
- | |||
- | === OEM === | ||
- | |||
- | ^ Attribute ^ Type ^ Nullable ^ Description ^ | ||
- | | RECS.Box | Object | | OEM extension [[# | ||
- | |||
- | == RECS.Box == | ||
- | |||
- | ^ Attribute ^ Type ^ Nullable ^ Description ^ | ||
- | | ApiVersion | String | No | Version of the RECS%%|%%Box Redfish API in Format Major.Minor.Errata | | ||
- | |||
- | === Links === | ||
- | |||
- | ^ Attribute ^ Type ^ Nullable ^ Description ^ | ||
- | | Sessions | Object | | Link to a collection of active [[documentation: | ||
- | |||
- | |||
- | === Example response data === | ||
- | |||
- | <codedoc code: | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | ===== PUT ===== | ||
- | |||
- | This Operation is not supported on this resource. | ||
- | |||
- | ===== PATCH ===== | ||
- | |||
- | This Operation is not supported on this resource. | ||
- | |||
- | ===== POST ===== | ||
- | |||
- | This Operation is not supported on this resource. | ||
- | |||
- | ===== DELETE ===== | ||
- | |||
- | This Operation is not supported on this resource. |