Device Group Attribute Update REST Service

Use the Device Group Attribute Update REST Service to update the attributes of a device group, such as myLTO.

Operation
PUT
URL
https://host:port/SKLM/rest/v1/deviceGroupAttributes

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 hostname 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.
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.
Request body

JSON object with the following specification:

JSON property name Description
name Required. Specify a unique device group, such as LTO, with the following values:
LTO
Specifies the LTO device group.
3592
Specifies the 3592 device group.
DS5000
Specifies the DS5000 device group.
DS8000®
Specifies the DS8000 device group.
GPFS
Specifies the IBM Spectrum® Scale (previously known as GPFS) device group.
PEER_TO_PEER
Specifies the PEER_TO_PEER device group.
DS8000_TCT
Specifies the DS8000_TCT device group that is in the GPFS device family.
name
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.
GENERIC
Specifies a device family that uses KMIP to interact with IBM Security Guardium Key Lifecycle Manager. The GENERIC device group enables management of KMIP objects.

Do not use the REST interface to add a device to the GENERIC device group or to change a GENERIC device group attribute.

ETERNUS_DX
Specifies the ETERNUS_DX device group that is in the DS5000 device family.
XIV®
Specifies the XIV device group that is in the DS5000 device family.
userdevicegroup
Specifies a user-defined group that is based on a supported device family.
attributes Required. Specify one or more user-defined attribute-value pairs. Use Device Group Attribute List REST Service to view the current value. You have the following choices:
drive.default.alias1
Specifies the system default certificate that a 3592 device uses if the device is not associated with another certificate.
drive.default.alias2
Specifies the system partner certificate that a 3592 device uses if the device is not associated with another certificate.
enableKMIPDelete
Enables or disables KMIP delete requests. The klmAdminDeviceGroup permission permits administration, such as (create, view, delete) of a device group. Disabling this attribute when you create a device group prevents KMIP clients from deleting keys in the device group. The default is disabled (false). Use Device Group Attribute Update REST Service to modify this attribute.
symmetricKeySet
Specifies a key group to be used for a device group.
shortName
Specifies a short label that is usually a drive type, such as LTO. This label is used for any additional attributes that are required by an original equipment manufacturer.
longName
Specifies an extended descriptive name of a drive type, such as my division LTO. For example, this information might include business information.
 
AddNewCertsToPending
Specifies whether to add a certificate to the list of pending certificates that you can accept or reject before key serving occurs, or to add a certificate automatically to the certificate table for immediate key service upon request. The attribute applies to the GPFS and PEER_TO_PEER device groups and their extended device groups.
device.enableMachineAffinity
Specifies whether a specific device group is enabled to store the association of a device to an existing machine identifier in the IBM Security Guardium Key Lifecycle Manager database. Valid values are true or false.
device.AutoPendingAutoDiscovery
Adds a device that contacts IBM Security Guardium Key Lifecycle Manager to a list of pending devices that you can accept or reject before key serving occurs. Or, adds a device automatically to the drive table for immediate key service upon request. The attribute applies only to predefined base device families, and not to user-defined device groups. You have the following choices:
0 (manual)
Both the auto pending and auto discovery functions are off.
1(auto accept)
The auto discovery function is on, and the auto pending function is off.
2 (auto pending)
The auto pending function is on.

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
code Returns the code that is specified by the status property.
status Returns the status to indicate whether the device group attribute update task is successful.
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.

Examples

Service request to update an attribute
PUT http://localhost/SKLM/rest/v1/deviceGroupAttributes
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
{"name":"3592","attributes":"longName 3592"}
Success response
Status Code: 200 OK
{"code": "0","status": "Succeeded"}
Service request to update an attribute when an invalid parameter is specified
PUT http://localhost/SKLM/rest/v1/deviceGroupAttributes
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
{"Name":"3592","attributes":"longName 3592 device, shortName 3592"}
Error response
Status Code: 400 Bad Request
{"code":"CTGKM0630E","message":"CTGKM0630E Validation error: \
"Invalid name \" for parameter \"Name\"."}