login (ログイン)

クラスターの各 HSM でログインおよびログアウトを行うには、CloudHSM CLI の login コマンドを使用します。

注記

ログイン試行回数が 5 回を超えると、アカウントがロックアウトされます。アカウントのロックを解除するには、管理者は、cloudhsm_cli の user change-password コマンドを使用してパスワードをリセットする必要があります。

ログインとログアウトのトラブルシューティングを行うには

クラスター内に複数の HSM がある場合は、アカウントがロックアウトされるまでのログイン試行回数の上限が増える可能性があります。これは、CloudHSM クライアントがさまざまな HSM 間で負荷を分散するためです。したがって、ログイン試行は毎回同じ HSM で開始されない場合があります。この機能をテストしている場合は、アクティブな HSM が1つだけのクラスターでテストすることをお勧めします。

2018 年 2 月より前にクラスターを作成した場合、ロックアウトされるまでのログイン試行回数は 20 回です。

ユーザーのタイプ

これらのコマンドは、次のユーザーが実行できます。

• 非アクティブ管理者

• 管理

• Crypto user (CU)

Syntax

aws-cloudhsm > help login
Login to your cluster  
        
USAGE:
    cloudhsm-cli login [OPTIONS] --username <USERNAME> --role <ROLE> [COMMAND]
    
Commands:
  mfa-token-sign  Login with token-sign mfa
  help            Print this message or the help of the given subcommand(s)

OPTIONS:
        --cluster-id <CLUSTER_ID>
          Unique Id to choose which of the clusters in the config file to run the operation against. If not provided, will fall back to the value provided when interactive mode was started, or error

        --username <USERNAME>
            Username to access the Cluster
        
        --role <ROLE>
            Role the user has in the Cluster
            
           Possible values:
           - crypto-user: A CryptoUser has the ability to manage and use keys
           - admin:       An Admin has the ability to manage user accounts

        --password <PASSWORD>
           Optional: Plaintext user's password. If you do not include this argument you will be prompted for it

  -h, --help
          Print help (see a summary with '-h')
       

例

このコマンドは、admin1 という名前の管理者ユーザーの認証情報を使用して、クラスター内のすべての HSM にログインします。

aws-cloudhsm > login --username admin1 --role admin
Enter password:
{
  "error_code": 0,
  "data": {
    "username": "admin1",
    "role": "admin"
  }
}

引数

<CLUSTER_ID>

このオペレーションを実行するクラスターの ID。

必須: 複数のクラスターが設定されている場合。

<USERNAME>

ユーザーのわかりやすい名前を指定します。最大長は 31 文字です。許可されている唯一の特殊文字はアンダースコア (_) です。このコマンドではユーザー名の大文字と小文字は区別されません。ユーザー名は常に小文字で表示されます。

必須: はい

<ROLE>

このユーザーに割り当てられるロールを指定します。このパラメータは必須です。有効な値は admin、crypto-user です。

ユーザーのロールを取得するには、user list コマンドを使用します。HSM のユーザー タイプの詳細については、「HSM ユーザーについて」を参照してください。

<PASSWORD>

HSM にログインしているユーザーのパスワードを指定します。

関連トピック

• CloudHSM CLI の使用開始

• クラスターのアクティブ化