All Products
Search
Document Center

Key Management Service:getAttribute

Last Updated:Nov 13, 2024

This topic explains the use of the getAttribute command to retrieve key attributes on HSM.

Feature description

The getAttribute command retrieves the attribute values of a key and saves them to a file. For detailed information on key attributes, see Key Attribute Constants.

Important

Prior to executing this command, ensure you have initiated the key_mgmt_tool and logged on to HSM as a CU.

Syntax

Enter parameters as per the following syntax. For descriptions of the parameters, refer to Parameters.

getAttribute -o <key handle> 
             -a <attribute constant> 
             -out <file>
Important

Parameters must be entered in the sequence outlined in the syntax.

Example

Below is an example demonstrating how to obtain all attributes of a key with handle 6 and record them in the file attr_6.

Command:  getAttribute -o 6 -a 512 -out attr_6

Attribute size: 554, count: 24
Written to: attr_6 file

       	Cfm3GetAttribute returned: 0x00 : HSM Return: SUCCESS

Parameters

Parameter Name

Description

Required

Valid Values

-o

Specifies the key handle.

Yes

No Special Requirements

-a

Specifies the attribute constant of the key.

Yes

Refer to Key Attribute Constants for attribute details.

-out

Specifies the file name for saving the output data.

Yes

No Special Requirements