Product Documentation

ssl hsmKey

Sep 12, 2016

The following operations can be performed on "ssl hsmKey":

add | rm | show

add ssl hsmKey

Add HSM Key.

Synopsys

add ssl hsmKey <hsmKeyName> [-hsmType ( THALES | SAFENET )] [-key <string> | -serialNum <string>] {-password }

Arguments

hsmKeyName

hsmType

Here 0 means Thales and 1 means safenet.

Possible values: THALES, SAFENET

Default value: THALES

key

Name of and, optionally, path to the HSM key file. /var/opt/nfast/kmdata/local/ is the default path

Maximum value: 63

serialNum

Slot number of the safenet HSM, you want the key to be assigned too.

Maximum value: 16

password

Password for the partition on HSM you want the key to be assigned.

Example

add ssl hsmkey rsa1 key_simple_rsa1

rm ssl hsmKey

Removes the specified HSM key, from the HSM Appliance.

Synopsys

rm ssl hsmKey <hsmKeyName> [-hsmType ( THALES | SAFENET )] [-serialNum <string>] {-password }

Arguments

hsmKeyName

Name of the HSMKEY to be removed

hsmType

Type of the HSMKEY to be removed

Possible values: THALES, SAFENET

Default value: THALES

serialNum

Slot for Safent HSMKey to be removed.

Maximum value: 16

password

Password for slot for key to be removed.

Example

rm hsmkey key_simple_rsa1

show ssl hsmKey

Displays lists of all the HSM Keys Added on the NetScaler appliance.

Synopsys

show ssl hsmKey [<hsmKeyName>]

Arguments

hsmKeyName

Name of the HSM Key for which to show detailed information.

Outputs

hsmType

Type of the HSM key

serialNum

Slotnumber for the Safenet key

devno

count

stateflag

Example

An example of output of 'show ssl hsmkey' command is as shown below: sh ssl hsmkey  1 SSL HSM key: 1) SSL HSM Key Name: key_simple_rsa1