meta data for this page
  •  

This is an old revision of the document!


Service Root

This object represents the root Redfish service.

Redfish Schema Version: v1.1.1

GET

Request

GET /redfish/v1
Content-Type: applicaton/json

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 Account Service
SessionService Object No Link to the Session Service
Managers Object No Link to a collection of Managers
Chassis Object No Link to a collection of Chassis
Systems Object No Link to a collection of Systems
EthernetSwitches Object No Link to a collection of Ethernet Switches
PcieSwitches Object No Link to a collection of Pcie Switches
ComposedNodes Object No Link to a collection of Composed Nodes
Oem Array No Collection of OEM extensions
Links Object No Links to other resources that are related to this resource

OEM

Attribute Type Nullable Description
RECS.Box Object OEM extension RECS.Box
RECS.Box
Attribute Type Nullable Description
ApiVersion String No Version of the RECS|Box Redfish API in Format Major.Minor.Errata
Attribute Type Nullable Description
Sessions Object Link to a collection of active Sessions

Example response data

{
	@odata.context: /redfish/v1/$metadata#ServiceRoot.ServiceRoot,
	@odata.id: /redfish/v1/, 
	@odata.type: #ServiceRoot.v1_1_1.ServiceRoot,
	Id: RootService,
	Name: Root Service,
	Description: This object represents the root Redfish service.,
	RedfishVersion: 1.1.0, 
	UUID: fc9a2b8c-0e75-40d5-900d-7401c4b0d444,
	AccountService: { 
		@odata.id: /redfish/v1/AccountService	},
	SessionService: { 
		@odata.id: /redfish/v1/SessionService	}, 
	Managers: { 
		@odata.id: /redfish/v1/Managers	}, 
	Chassis: { 
		@odata.id: /redfish/v1/Chassis	}, 
	Systems: { 
		@odata.id: /redfish/v1/Systems	}, 
	EthernetSwitches: { 
		@odata.id: /redfish/v1/EthernetSwitches	},
	PcieSwitches: { 
		@odata.id: /redfish/v1/PcieSwitches	}, 
	ComposedNodes: { 
		@odata.id: /redfish/v1/ComposedNodes	}, 
	Oem: { 
		RECS.Box: { 
			@odata.type: #RECS.Box.Oem.ServiceRoot, 
			ApiVersion: 0.01.00, 
		} 
	}, 
	Links: {
		Sessions : {
			@odata.id: /redfish/v1/SessionService/Sessions		}
	}
}

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.