apps hsm

Note:  Starting in release 6.14.00, Entrust/nCipher HSM integration is deprecated. Gen2 DSSL HSMs (nCipher v1.0) and Gen3 HSMs using nCipher 12.6 (`nshield_12_60`) are no longer supported, and upgrades are blocked if any nCipher HSM configuration is present.

Use the apps hsm command to configure a Hardware Security Module (HSM) appliance.

The apps hsm command has the following syntax:

apps hsm <alias <alias>>
  

hsm-ip <HSM server IP address> hsm-port <port number> type luna-hsm server-username <name> server-password <*****> partition-label <name> partition-password <*****>

 

The following table describes the arguments for the apps hsm command:

Argument

Description

alias <alias>
hsm-ip <HSM server IP address> hsm-port <port number> type luna-hsm server-username <name> server-password <*****> partition-label <name> partition-password <*****>

Configures an HSM appliance as follows

● alias—Specifies an alias of the HSM.
● hsm-ip—Specifies the IP address of the HSM server. Only IPv4 addresses are supported.
● hsm-port—Specifies the HSM port number.
● type luna-hsm—Specifies the HSM type which is Thales-Luna.
● server-username— Specifies the HSM servers administration username.
● server-password— Specifies the HSM servers administration password.
● partition label—Specifies the user partition label configured by the administrator.
● partition password—Specifies the user partition password configured by the administrator.

Examples:

(config) # apps hsm alias hsm1 hsm-ip 10.115.72.15 hsm-port 1792 type luna-hsm server-username admin server-password ******* partition-label partition1 partition-password *******

(config) # apps hsm alias hsm2 hsm-ip 10.115.74.36 hsm-port 1792 type luna-hsm server-username admin server-password ******* partition-label partition1 partition-password *******

Note:  The server-password and partition-password should be encrypted using the keychain password in the keystore.

Related Commands

The following table summarizes other commands related to the apps hsm command:

Task

Command

Displays a specified HSM.

# show apps hsm alias hsm1

Displays all HSM.

# show apps hsm all

Deletes a specified HSM.

(config) # no apps hsm alias hsm1

Deletes all HSM.

(config) # no apps hsm all