Skip to main content

GET – SecureKeyLifecycleService properties

Use the GET method to retrieve properties in SecureKeyLifecycleService resource for Redfish service.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/Managers/1/Oem/ Lenovo/SecureKeyLifecycleService

Request body​

None

Response body​

FieldTypeDescription

Id

String

“SecureKeyLifecycleService”

Description

String

This resource is used to represent a secure key lifecycle service for a Redfish implementation.

Name

String

“SecureKeyLifecycleService”

KeyRepoServers[N]

Object

Expanded

Note
When the tier level is lower than 2, this object will not be presented.
 

HostName

String

A remote server address. It can be an IPv4 address, an IPv6 address, a hostname, or a FQDN.

 

Port

Number

A remote server port. A valid value is from 1 to 65535.

DeviceGroup

String

A string with a maximum length of 16 bytes.

Note
When the tier level is lower than 2, this property will not be presented.

ClientCertificate

Link

The value of this property is a URI reference to a collection of certificates.

ServerCertificate

Link

The value of this property is a URI reference to a collection of certificates.

Protocol

String

Server protocol. Value: SKLM or KMIP. ST250/SR250/ST50 platform only support SKLM.

Note
when the tier level is lower than 2, this property will not be presented.

Protocol@Redfish.AllowableValues

Array

Items: string

Item count: N

 

Prtocol@Redfish.AllowableValues[N]

String

Expand

This property is “SKLM” and “KMIP”. ST250/SR250/ST50 platform only support “SKLM”.

EKMSLocalCachedKeySettings

Object

Expanded

Note
This object will not be presented on edge platform.
 

LocalCachedKeyEnabled

Boolean

Local cached key enabled status

 

CacheExpirationTime

Number

Cache expiration time

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "Name": "SecureKeyLifecycleService",
    "EKMSLocalCachedKeySettings": {
        "LocalCachedKeyEnabled": false,
        "CacheExpirationIntervalHours": 1
    },
    "@odata.id": "/redfish/v1/Managers/1/Oem/Lenovo/SecureKeyLifecycleService",
    "ServerCertificate": {
        "@odata.id": "/redfish/v1/Managers/1/Oem/Lenovo/SecureKeyLifecycleService/ServerCertificate"
    },
    "Description": "This resource is used to represent a secure key lifecycle service for a Redfish implementation.",
    "Protocol": "SKLM",
    "DeviceGroup": "TKLM_DEV_GROUP",
    "@odata.type": "#LenovoSecureKeyLifecycle.v1_0_0.LenovoSecureKeyLifecycle",
    "Protocol@Redfish.AllowableValues": [
        "SKLM",
        "KMIP"
    ],
    "@odata.etag": "\"71103de0be6a24f03b3\"",
    "@odata.context": "/redfish/v1/$metadata#LenovoSecureKeyLifecycle.LenovoSecureKeyLifecycle",
    "ClientCertificate": {
        "@odata.id": "/redfish/v1/Managers/1/Oem/Lenovo/SecureKeyLifecycleService/ClientCertificate"
    },
    "KeyRepoServers": [
        {
            "Port": 5696,
            "HostName": ""
        },
        {
            "Port": 5696,
            "HostName": ""
        },
        {
            "Port": 5696,
            "HostName": ""
        },
        {
            "Port": 5696,
            "HostName": ""
        }
    ],
    "Id": "SecureKeyLifecycleService"
}