GET – Capabilities
Capabilities Indicates the properties to be included in a composed system.
Request URI
GET https://{{ip}}/redfish/v1/Systems/Capabilities
Content-Type: application/json
Response
The response of the request will be in JSON format. The properties are mentioned in the following tables.
Name | Type | Read only | Description | |||||||||||||||||||||||||||||||||||||
| (OData Attributes) | Refer to OData Support | |||||||||||||||||||||||||||||||||||||||
Id | String | True | Refer to Resource Type Definitions | |||||||||||||||||||||||||||||||||||||
Name(M) | String | True | ||||||||||||||||||||||||||||||||||||||
Description | String | True | ||||||||||||||||||||||||||||||||||||||
Links(M) | Object | True | The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but no contained by (subordinate to), this resource | |||||||||||||||||||||||||||||||||||||
Name | Type | Read Only | Description | |||||||||||||||||||||||||||||||||||||
ResourceBlocks | Array | False | An array of references to the Resource Blocks. | |||||||||||||||||||||||||||||||||||||
HostName | String | False | The value of this property shall be the host name for the system, as reported by the operating system or hypervisor. This value typically provided to the Manager by a service running in the host operating system. Note Northbound API is supported but still requires host interface and host agent support from host agent and in-band communication channel and platform specific porting needed. | |||||||||||||||||||||||||||||||||||||
Boot | Object | False | This object shall contain properties which describe boot information for the current resource. Changes to this object do not alter the BIOS persistent boot order configuration. Refer to List of Property Annotation and Description.
| |||||||||||||||||||||||||||||||||||||
Property Annotation | Description |
Redfish.RequiredOnCreate | The client must provide the given property in the body of the create (POST) request. |
Redfish.OptionalOnCreate | The client may provide the property in the body of the create (POST) request. |
Redfish.SetOnlyOnCreate | If the client has a specific value needed for the property, it must be provided in the body of the create (POST) request; this property is likely a "Read Only" property after the resource's creation. |
Redfish.UpdatableAfterCreate | The client is allowed to update the property after the resource is created. |
Redfish.AllowableValues | The client is allowed to use any of the specifie values in the body of the create (POST) reque for the given property. |