Pending Device List REST Service

Use Pending Device List REST Service to obtain a list of all the pending devices.

Operation
GET
URL
For all devices:
https://host:port/SKLM/rest/v1/pendingDevices
For a specific device:
https://host:port/SKLM/rest/v1/pendingDevices?usage=deviceGroupName

By default, Guardium® Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM® Security Guardium Key Lifecycle Manager installation, you can modify this default port.

Request

Request Parameters
Parameter Description
host Specify the IP address or host name of the IBM Security Guardium Key Lifecycle Manager server.
port Specify the port number on which the IBM Security Guardium Key Lifecycle Manager server listens for requests.
deviceGroupName Optional. Specify a device group. You can specify one of the following values:
LTO
Specifies the LTO device group.
3592
Specifies the 3592 device group.
DS5000
Specifies the DS5000 device group.
DS5000_TCT
Specifies the DS5000_TCT device group.
DS8000®
Specifies the DS8000 device group.
BRCD_ENCRYPTOR
Specifies the BRCD_ENCRYPTOR device group that is in the LTO device family.
ONESECURE
Specifies the ONESECURE device group that is in the DS5000 device family.
ETERNUS_DX
Specifies the ETERNUS_DX device group that is in the DS5000 device family.
XIV®
Specifies the IBM Spectrum® Accelerate (previously known as XIV) device group.
GPFS
Specifies the IBM Spectrum Scale (previously known as GPFS) device group.
PEER_TO_PEER
Specifies the PEER_TO_PEER device group.
GENERIC
Specifies a device family that uses the Key Management Interoperability Protocol to interact withIBM Security Guardium Key Lifecycle Manager. The GENERIC device group enables management of KMIP objects.
userdevicegroup
Specifies a user-defined group that is based on a supported device family.
Request Headers
Header name Value
Content-Type application/json
Accept application/json
Authorization SKLMAuth userAuthId=<authIdValue>
Accept-Language Any valid locale that is supported by IBM Security Guardium Key Lifecycle Manager. For example, en or de.

Response

Response Headers
Header name Value and description
Status Code
200 OK
The request was successful. The response body contains the requested representation.
400 Bad Request
The authentication information was not provided in the correct format.
401 Unauthorized
The authentication credentials were missing or incorrect.
404 Not Found Error
The processing of the request fails.
500 Internal Server Error
The processing of the request fails because of an unexpected condition on the server.
Content-Type application/json
Content-Language Locale for the response message.
Success response body

JSON object with the following specification:

JSON property name Description
Description Describes the type of device or its purpose.
Serial Number Returns the serial number as an ASCII string.
Device UUID Returns the unique ID of the device.
Device group Returns the device group type.
Pending Date Returns the date from when the devices are pending.
Device Text Returns the unique text that describes a DS5000 storage server. The text ranges up to 96 bytes, but it must be greater than 0.
World wide name Returns the device name, which is a nonsecure address, which is used in combination with other device information, such as a serial number. You can use this name to define devices and device paths.
Sym alias Returns an alias to identify an existing key group for an LTO tape drive. The attribute is also used for the DS5000 storage server to change or associate a new device key container.
Key alias 1 Returns the default key alias for a certificate that is used by a 3592 tape drive or a DS8000Turbo drive. For other device groups, returns NULL.
Key alias 2 Returns the key alias for a certificate that is used by a 3592 tape drive or a DS8000Turbo drive. For other device groups, returns NULL.
Error Response Body

JSON object with the following specification.

JSON property name Description
code Returns the application error code.
message Returns a message that describes the error.

Example

Service request to obtain a list of all the pending devices
GET https://localhost:port/SKLM/rest/v1/pendingDevices
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Success response
[{"Description":null,"Serial Number":"LTO_device02",
"Device uuid":"DEVICE-1276d48-3c64b590-ea71-4a1b-bd3a-40fbfbb60759",
"Device group":"LTO",
"Pending Date":"12\/20\/18, 6:30:57 AM India Standard Time",
"Device Text":"","World wide name":"4B4D49504E414D45",
"Sym alias":null,"Key alias 1":null,"Key alias 2":null}]
Error response
Status Code : 400 Bad Request
Content-Language: en
{"code":"CTGKM6002E","message":"CTGKM6002E Bad Request: Invalid user 
authentication ID or invalid request format."}