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

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

"HpESKM" Resource Type

Resource Instances

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

See Resource Map for more details.

ESKM (Enterprise Security Key Manager) object enables user to connect to an operational key manager, change redundancy settings, view the key manager connection settings, test the connection, and view key management events.

"HpESKM" defines the following properties:

"ESKMEvents[]/Event"

This property is a member of HpESKM

ESKM event description.
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.

"ESKMEvents[]/Timestamp"

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

"KeyManagerConfig/AccountGroup"

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

{"KeyManagerConfig": {"AccountGroup": "<string-value>"}}

The property "KeyManagerConfig/AccountGroup" on resource type HpESKM 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.

"KeyManagerConfig/AccountName"

This property is a member of [HpESKM](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpESKM-Resource-Type)#hpeskm-resource-type)
Account name on ESKM.
JSON type:
String

HTTP Operations

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

"KeyManagerConfig/ESKMLocalCACertificateName"

This property is a member of [HpESKM](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpESKM-Resource-Type)#hpeskm-resource-type)
This is the name of Local CA (Certificate Authority) in ESKM that is used to sign the ESKM server certificate. iLO will retrieve this certificate from the ESKM server.
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:

{"KeyManagerConfig": {"ESKMLocalCACertificateName": "<string-value>"}}

The property "KeyManagerConfig/ESKMLocalCACertificateName" on resource type HpESKM 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.

"KeyManagerConfig/ImportedCertificateIssuer"

This property is a member of HpESKM

Imported certificate issuer.
JSON type:
String

HTTP Operations

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

"KeyManagerConfig/ImportedCertificateSubject"

This property is a member of [HpESKM](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpESKM-Resource-Type)#hpeskm-resource-type)
Imported certificate subject.
JSON type:
String

HTTP Operations

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

"KeyManagerConfig/LoginName"

This property is a member of [HpESKM](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpESKM-Resource-Type)#hpeskm-resource-type)
ESKM administrator account login name. This property always returns null on GET.
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:

{"KeyManagerConfig": {"LoginName": "<string-value>"}}

The property "KeyManagerConfig/LoginName" on resource type HpESKM 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.

"KeyManagerConfig/Password"

This property is a member of HpESKM

ESKM administrator account password. This property always returns null on GET.
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:

{"KeyManagerConfig": {"Password": "<string-value>"}}

The property "KeyManagerConfig/Password" on resource type HpESKM 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.

"KeyServerRedundancyReq"

This property is a member of HpESKM

If true encryption keys will be maintained on both the configured key servers. When this option is disabled, iLO will not verify that encryption keys are copied to both of the configured key servers.
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:

{"KeyServerRedundancyReq": true}

The property "KeyServerRedundancyReq" on resource type HpESKM 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.

"PrimaryKeyServerAddress"

This property is a member of HpESKM

Primary key server IP address or FQDN. Set to null to clear the value.
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:

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

The property "PrimaryKeyServerAddress" on resource type HpESKM 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.

"PrimaryKeyServerPort"

This property is a member of HpESKM

Primary key server port number. Set to null to clear the value.
JSON type:
Integer

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:

{"PrimaryKeyServerPort": <integer-value>}

The property "PrimaryKeyServerPort" on resource type HpESKM 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.

"SecondaryKeyServerAddress"

This property is a member of HpESKM

Secondary key server IP address or FQDN. Set to null to clear the value.
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:

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

The property "SecondaryKeyServerAddress" on resource type HpESKM 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.

"SecondaryKeyServerPort"

This property is a member of HpESKM

Secondary key server port number. Set to null to clear the value.
JSON type:
Integer

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:

{"SecondaryKeyServerPort": <integer-value>}

The property "SecondaryKeyServerPort" on resource type HpESKM 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 "TestESKMConnections"

Test ESKM connections.

Example

HTTP POST to resource with request JSON:

{ "Action": "TestESKMConnections"}

POST Action "ClearESKMLog"

Clears ESKM log.

Example

HTTP POST to resource with request JSON:

{ "Action": "ClearESKMLog"}
⚠️ **GitHub.com Fallback** ⚠️