Prerequisites for user management in AWS CloudHSM Management Utility
Before you use AWS CloudHSM Management Utility (CMU) to manage hardware security module (HSM) users in AWS CloudHSM, you must complete these prerequisites. The following topics describe getting started with the CMU.
Sections
Get the IP address of an HSM in AWS CloudHSM
To use CMU, you must use the configure tool to update the local configuration. CMU
creates its own connection to the cluster and this connection is not cluster aware. To track cluster information, CMU maintains a local
configuration file. This means that each time you use
CMU, you should first update the configuration file by running the configure command line tool with the --cmu
parameter. If you are using Client SDK 3.2.1 or earlier, you must use a different parameter
than --cmu
. For more information, see Using CMU with Client SDK 3.2.1 and earlier.
The --cmu
parameter requires you to add the IP address of an HSM in your
cluster. If you have multiple HSMs, you can use any IP address. This ensures CMU can
propagate any changes you make across the entire cluster. Remember that CMU uses its local
file to track cluster information. If the cluster has changed since the last time you used
CMU from a particular host, you must add those changes to the local configuration file
stored on that host. Never add or remove an HSM while you're using CMU.
To get an IP address for an HSM (console)
Open the AWS CloudHSM console at https://console.aws.amazon.com/cloudhsm/home
. -
To change the AWS Region, use the Region selector in the upper-right corner of the page.
-
To open the cluster detail page, in the cluster table, choose the cluster ID.
-
To get the IP address, on the HSMs tab, choose one of the IP addresses listed under ENI IP address.
To get an IP address for an HSM (AWS CLI)
-
Get the IP address of an HSM by using the describe-clusters command from the AWS CLI. In the output from the command, the IP address of the HSMs are the values of
EniIp
.$
aws cloudhsmv2 describe-clusters
{ "Clusters": [ { ... } "Hsms": [ { ... "EniIp": "10.0.0.9", ... }, { ... "EniIp": "10.0.1.6", ...
Using CMU with Client SDK 3.2.1 and earlier
With Client SDK 3.3.0, AWS CloudHSM added support for the --cmu
parameter, which
simplifies the process of updating the configuration file for CMU. If you're using a
version of CMU from Client SDK 3.2.1 or earlier, you must continue to use the
-a
and -m
parameters to update the configuration file. For
more information about these parameters, see Configure
Tool.
Download CloudHSM Management Utility
The latest version of CMU is available for HSM user management tasks whether you are using Client SDK 5 and Client SDK 3.
To download and install CMU
-
Download and install CMU.