Download full document:

ssl hsmKey

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

Type of HSM.

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. Applies only to THALES HSM.

Maximum value: 63

serialNum

Serial number of the partition on which the key is present. Applies only to SafeNet HSM.

Maximum value: 16

password

Password for a partition. Applies only to SafeNet HSM.

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.

hsmType

Type of the HSMKEY.

Possible values: THALES, SAFENET

Default value: THALES

serialNum

SerialNum of a partition on which Safent HSMKey is present.

Maximum value: 16

password

Password of a partition on which SafeNet HSMkey is present.

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

SerialNum of a partition on which Safenet key is present.

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