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

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

"HpiLOSSO" Resource Type

Resource Instances

/rest/v1/Managers/{item}/SecurityService/SSO

See Resource Map for more details.

This is the schema definition for the HP SSO Trusted Server.

"HpiLOSSO" defines the following properties:

"ManagerTrustedCertificates[]/Certificate"

This property is a member of HpiLOSSO

Contains PEM formatted X509 certificate (Base64 encoded).
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.

"ManagerTrustedCertificates[]/SerialNumber"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-resource-type)
Contains the Serial number for the SSO records.
JSON type:
Integer

HTTP Operations

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

"ManagerTrustedCertificates[]/ServerName"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-resource-type)
The Server name (or certificate subject).
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.

"ManagerTrustedCertificates[]/Status"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-resource-type)
JSON type:
String containing one of the following supported values: "OK" "Degraded" "Failed"

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.

"SSOsettings/AdminPrivilege/LoginPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-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:

{"SSOsettings": {"AdminPrivilege": {"LoginPriv": true}}}

The property "SSOsettings/AdminPrivilege/LoginPriv" on resource type HpiLOSSO 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.

"SSOsettings/AdminPrivilege/PowerandResetPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-resource-type)
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:

{"SSOsettings": {"AdminPrivilege": {"PowerandResetPriv": true}}}

The property "SSOsettings/AdminPrivilege/PowerandResetPriv" on resource type HpiLOSSO 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.

"SSOsettings/AdminPrivilege/RemoteConsolePriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-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:

{"SSOsettings": {"AdminPrivilege": {"RemoteConsolePriv": true}}}

The property "SSOsettings/AdminPrivilege/RemoteConsolePriv" on resource type HpiLOSSO 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.

"SSOsettings/AdminPrivilege/UserConfigPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-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:

{"SSOsettings": {"AdminPrivilege": {"UserConfigPriv": true}}}

The property "SSOsettings/AdminPrivilege/UserConfigPriv" on resource type HpiLOSSO 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.

"SSOsettings/AdminPrivilege/VirtualMediaPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-resource-type)
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:

{"SSOsettings": {"AdminPrivilege": {"VirtualMediaPriv": true}}}

The property "SSOsettings/AdminPrivilege/VirtualMediaPriv" on resource type HpiLOSSO 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.

"SSOsettings/AdminPrivilege/iLOConfigPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-resource-type)
iLO 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:

{"SSOsettings": {"AdminPrivilege": {"iLOConfigPriv": true}}}

The property "SSOsettings/AdminPrivilege/iLOConfigPriv" on resource type HpiLOSSO 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.

"SSOsettings/OperatorPrivilege/LoginPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-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:

{"SSOsettings": {"OperatorPrivilege": {"LoginPriv": true}}}

The property "SSOsettings/OperatorPrivilege/LoginPriv" on resource type HpiLOSSO 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.

"SSOsettings/OperatorPrivilege/PowerandResetPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-resource-type)
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:

{"SSOsettings": {"OperatorPrivilege": {"PowerandResetPriv": true}}}

The property "SSOsettings/OperatorPrivilege/PowerandResetPriv" on resource type HpiLOSSO 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.

"SSOsettings/OperatorPrivilege/RemoteConsolePriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-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:

{"SSOsettings": {"OperatorPrivilege": {"RemoteConsolePriv": true}}}

The property "SSOsettings/OperatorPrivilege/RemoteConsolePriv" on resource type HpiLOSSO 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.

"SSOsettings/OperatorPrivilege/UserConfigPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-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:

{"SSOsettings": {"OperatorPrivilege": {"UserConfigPriv": true}}}

The property "SSOsettings/OperatorPrivilege/UserConfigPriv" on resource type HpiLOSSO 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.

"SSOsettings/OperatorPrivilege/VirtualMediaPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-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:

{"SSOsettings": {"OperatorPrivilege": {"VirtualMediaPriv": true}}}

The property "SSOsettings/OperatorPrivilege/VirtualMediaPriv" on resource type HpiLOSSO 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.

"SSOsettings/OperatorPrivilege/iLOConfigPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-resource-type)
iLO 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:

{"SSOsettings": {"OperatorPrivilege": {"iLOConfigPriv": true}}}

The property "SSOsettings/OperatorPrivilege/iLOConfigPriv" on resource type HpiLOSSO 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.

"SSOsettings/SSOTrustMode"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-resource-type)
Represents the SSO Trust Mode.
JSON type:
String containing one of the following supported values: "TrustNone" "TrustAll" "TrustbyName" "TrustbyCert"

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:

{"SSOsettings": {"SSOTrustMode": "TrustbyName"}}

The property "SSOsettings/SSOTrustMode" on resource type HpiLOSSO 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.

"SSOsettings/UserPrivilege/LoginPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-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:

{"SSOsettings": {"UserPrivilege": {"LoginPriv": true}}}

The property "SSOsettings/UserPrivilege/LoginPriv" on resource type HpiLOSSO 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.

"SSOsettings/UserPrivilege/PowerandResetPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-resource-type)
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:

{"SSOsettings": {"UserPrivilege": {"PowerandResetPriv": true}}}

The property "SSOsettings/UserPrivilege/PowerandResetPriv" on resource type HpiLOSSO 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.

"SSOsettings/UserPrivilege/RemoteConsolePriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-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:

{"SSOsettings": {"UserPrivilege": {"RemoteConsolePriv": true}}}

The property "SSOsettings/UserPrivilege/RemoteConsolePriv" on resource type HpiLOSSO 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.

"SSOsettings/UserPrivilege/UserConfigPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-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:

{"SSOsettings": {"UserPrivilege": {"UserConfigPriv": true}}}

The property "SSOsettings/UserPrivilege/UserConfigPriv" on resource type HpiLOSSO 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.

"SSOsettings/UserPrivilege/VirtualMediaPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-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:

{"SSOsettings": {"UserPrivilege": {"VirtualMediaPriv": true}}}

The property "SSOsettings/UserPrivilege/VirtualMediaPriv" on resource type HpiLOSSO 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.

"SSOsettings/UserPrivilege/iLOConfigPriv"

This property is a member of [HpiLOSSO](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiLOSSO-Resource-Type)#hpilosso-resource-type)
iLO 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:

{"SSOsettings": {"UserPrivilege": {"iLOConfigPriv": true}}}

The property "SSOsettings/UserPrivilege/iLOConfigPriv" on resource type HpiLOSSO 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.

POST Action "ImportCertificate"

Import the HP SSO Certificate.

Parameter "CertType"

"CertType" must be one of the following value(s):

"DirectImportCert"
"ImportCertUri"
iLO directly imports the Certificate.
iLO imports the certificate from the HP SSO compliant application over the network.

Parameter "CertInput"

"CertInput" must be one of the following value(s):

"<text>"

Example

HTTP POST to resource with request JSON:

{ "Action": "ImportCertificate", "CertType": "DirectImportCert", "CertInput": "<text>"}

POST Action "ImportDNSName"

Add DNS Name to the record list.

Parameter "DNSName"

"DNSName" must be one of the following value(s):

"<string>"

Example

HTTP POST to resource with request JSON:

{ "Action": "ImportDNSName", "DNSName": "<string>"}

POST Action "DeleteAllSSORecords"

Delete all the SSO records.

Example

HTTP POST to resource with request JSON:

{ "Action": "DeleteAllSSORecords"}

POST Action "DeleteSSORecordbyNumber"

Delete SSO record by record number.

Parameter "RecordNumber"

"RecordNumber" must be one of the following value(s):

<integer>

Example

HTTP POST to resource with request JSON:

{ "Action": "DeleteSSORecordbyNumber", "RecordNumber": <integer>}
⚠️ **GitHub.com Fallback** ⚠️