Name
nbhsmcmd — configures Hardware Security Modules in NetBackup
SYNOPSIS
-configure
-list
-update -key -tokenpin -tokenmodule path_of_PKCS_module
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/
On Windows systems, the directory path to this command is install_pathNetBackup\bin\
DESCRIPTION
Use the nbhsmcmd command to configure Hardware Security Modules (HSM) in NetBackup.
OPTIONS
- -configure
This option enables a user to configure the Hardware Security Module in NetBackup.
- -key
Use this option to update the NetBackup configuration to use the specified key with the Hardware Security Module. You are prompted to provide the answers that are related to the key when you use this option.
You can only use this option with the -update option.
- -list
This option enables the user to retrieve the NetBackup configuration of Hardware Security Module.
- -tokenmodule
Use this option to update the NetBackup configuration to use the specified PKCS library path for the Hardware Security Module. You can specify the path as a command line argument.
You can only use this option with the -update option.
- -tokenpin
Use this option to update the NetBackup configuration to use the pin that is specified for the Hardware Security Module. You are prompted to enter a pin for the HSM when you use this option.
You can only use this option with the -update option.
- -update -key -tokenpin -tokenmodule path_of_PKCS_module
This option enables the user to update the Hardware Security Module configuration. You must use the -key, -tokenpin, and -tokenmodule options with the -update option.
EXAMPLES
Example 1: Configure the Hardware Security Module.
nbhsmcmd -configure Enter the PKCS#11 library path that you have received from the Hardware Security Module: user/lib/libhsm.so Enter the token label of the Hardware Security Module: HSM_TEST_TOKEN Enter the token pin of the Hardware Security Module: XXXX Enter the identifier for the Hardware Security Module key: TEST_BACKUP Enter the key label of the Hardware Security Module: HSM_KEY_1 Enter the key algorithm name: AES-GCM The Hardware Security Module is successfully configured.
Example 2: User updates the pin of the Hardware Security Module.
nbhsmcmd -update -tokenpin Enter the token pin of the Hardware Security Module: abc@hsm123 The Hardware Security Module is successfully updated.
Example 3: User updates the PKCS-11 implementation library path of the Hardware Security Module.
nbhsmcmd -update -tokenmodule /opt/softhsm3/lib/softhsm/libsofthsm2.so The Hardware Security Module is successfully updated.