All Products
Search
Document Center

Key Management Service:setAttribute

Last Updated:Nov 11, 2024

This topic explains the process of using the setAttribute command to transform a session-specific key into a persistent key within HSM.

Feature description

The setAttribute command is designed to convert a temporary session key into a persistent key, ensuring its retention until deletion. This is accomplished by modifying the key's token property (OBJ_ATTR_TOKEN) from false (0) to true (1).

Important

Ensure you have initiated the key_mgmt_tool and logged on to the HSM as a CU before executing this command.

Syntax

Enter the parameters as per the following syntax. For detailed parameter information, see Parameters.

setAttribute -o <object handle> 
             -a 1
Important

It is crucial to input the parameters in the sequence outlined by the syntax.

Example

Below is an example of converting key number 21 into a permanent key.

Command:  setAttribute -o 21 -a 1
       		This attribute is defined as a boolean value.
       		Enter the boolean attribute value (0 or 1):1

       	Cfm3SetAttribute returned: 0x00 : HSM Return: SUCCESS

       	Cluster Status:
       	Node id 0 status: 0x00000000 : HSM Return: SUCCESS

Parameters

Parameter name

Description

Required

Valid values

-o

Specifies the handle of the session key.

Yes

CU

-a

Specifies the constant for changing the property (OBJ_ATTR_TOKEN).

Yes

1