iLO 4 REST API Data Model (HpiLOFederationGroup Resource Type) - shamimur/hp-proliant-sdk GitHub Wiki

HP RESTful API Data Model Reference for iLO 4—Redfish 1.0 Conformance (Cont)

"HpiLOFederationGroup" Resource Type

Resource Instances

/rest/v1/Managers/{item}/FederationGroups/{item}

See Resource Map for more details.

"HpiLOFederationGroup" defines the following properties:

"Key"

This property is a member of HpiLOFederationGroup

The password used by the Federation Group.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Key": "<string-value>"}

The property "Key" on resource type HpiLOFederationGroup may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Privileges/LoginPriv"

This property is a member of [HpiLOFederationGroup](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOFederationGroup-Resource-Type)#hpilofederationgroup-resource-type)
Login privileges.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Privileges": {"LoginPriv": true}}

The property "Privileges/LoginPriv" on resource type HpiLOFederationGroup may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Privileges/RemoteConsolePriv"

This property is a member of [HpiLOFederationGroup](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOFederationGroup-Resource-Type)#hpilofederationgroup-resource-type)
Remote console privileges.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Privileges": {"RemoteConsolePriv": true}}

The property "Privileges/RemoteConsolePriv" on resource type HpiLOFederationGroup may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Privileges/UserConfigPriv"

This property is a member of [HpiLOFederationGroup](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOFederationGroup-Resource-Type)#hpilofederationgroup-resource-type)
User configuration privileges.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Privileges": {"UserConfigPriv": true}}

The property "Privileges/UserConfigPriv" on resource type HpiLOFederationGroup may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Privileges/VirtualMediaPriv"

This property is a member of [HpiLOFederationGroup](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOFederationGroup-Resource-Type)#hpilofederationgroup-resource-type)
Virtual media privileges.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Privileges": {"VirtualMediaPriv": true}}

The property "Privileges/VirtualMediaPriv" on resource type HpiLOFederationGroup may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Privileges/VirtualPowerAndResetPriv"

This property is a member of [HpiLOFederationGroup](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOFederationGroup-Resource-Type)#hpilofederationgroup-resource-type)
Virtual power and reset privileges.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Privileges": {"VirtualPowerAndResetPriv": true}}

The property "Privileges/VirtualPowerAndResetPriv" on resource type HpiLOFederationGroup may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Privileges/iLOConfigPriv"

This property is a member of [HpiLOFederationGroup](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOFederationGroup-Resource-Type)#hpilofederationgroup-resource-type)
The management processor configuration privileges.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Privileges": {"iLOConfigPriv": true}}

The property "Privileges/iLOConfigPriv" on resource type HpiLOFederationGroup may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"HpiLOFederationPeers" Resource Type

Resource Instances

/rest/v1/Managers/{item}/FederationPeers/{item}

See Resource Map for more details.

"HpiLOFederationPeers" defines the following properties:

"Peers[]/HttpErrorCode"

This property is a member of [HpiLOFederationGroup](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOFederationGroup-Resource-Type)#hpilofederationgroup-resource-type)
Error code for success or failure.
JSON type:
Integer

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Peers[]/ManagerIPAddress"

This property is a member of [HpiLOFederationGroup](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOFederationGroup-Resource-Type)#hpilofederationgroup-resource-type)
Manager IP address of the federation peer.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Peers[]/Time"

This property is a member of [HpiLOFederationGroup](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOFederationGroup-Resource-Type)#hpilofederationgroup-resource-type)
Time when the federation peer was added.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Peers[]/URL"

This property is a member of [HpiLOFederationGroup](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOFederationGroup-Resource-Type)#hpilofederationgroup-resource-type)
URL of the federation peer.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Peers[]/UUID"

This property is a member of [HpiLOFederationGroup](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOFederationGroup-Resource-Type)#hpilofederationgroup-resource-type)
UUID peers that are part of the federation group.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
⚠️ **GitHub.com Fallback** ⚠️