AWS CloudHSM
User Guide

loginHSM and logoutHSM

You can use the loginHSM and logoutHSM commands in cloudhsm_mgmt_util to log in and out of each HSM in a cluster. Any user of any type can use these commands.

Before you run these cloudhsm_mgmt_util commands, you must start cloudhsm_mgmt_util.

If you add or delete HSMs, update the configuration files that the AWS CloudHSM client and the command line tools use. Otherwise, the changes that you make might not be effective on all HSMs in the cluster.

User Type

The following users can run these commands.

  • Precrypto officer (PRECO)

  • Crypto officer (CO)

  • Crypto user (CU)

  • Appliance user (AU)

Syntax

Because these commands do not have named parameters, you must enter the arguments in the order specified in the syntax diagrams.

loginHSM <user type> <user name> <password>
logoutHSM

Examples

These examples show how to use loginHSM and logoutHSM to log in and out of all HSMs in a cluster.

Example : Log In to the HSMs in a Cluster

This command logs in to all HSMs in a cluster with the credentials of a CO user named admin and a password of co12345. The output shows that the command was successful and that the user has connected to the HSMs (which, in this case, are server 0 and server 1).

aws-cloudhsm>loginHSM CO admin co12345 loginHSM success on server 0(10.0.2.9) loginHSM success on server 1(10.0.3.11)

Example : Log Out of an HSM

This command logs out of the HSMs that you are currently logged in to (which, in this case, are server 0 and server 1). The output shows that the command was successful and that the user has disconnected from the HSMs.

aws-cloudhsm>logoutHSM logoutHSM success on server 0(10.0.2.9) logoutHSM success on server 1(10.0.3.11)

Arguments

Because these commands do not have named parameters, you must enter the arguments in the order specified in the syntax diagrams.

loginHSM <user type> <user name> <password>
<user type>

Specifies the type of user who is logging in to the HSMs. For more information, see User Type above.

Required: Yes

<user name>

Specifies the user name of the user who is logging in to the HSMs.

Required: Yes

<password>

Specifies the password of the user who is logging in to the HSMs.

Required: Yes

Related Topics