Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

createLoginKey

Prev Next

VPC環境で利用できます。

サーバインスタンス(VM)に SSH接続する際に使用する認証キー(Login Key)を作成します。秘密鍵は、レスポンス結果に最初に発行された後に再度確認することができないため、安全に別途保存してください。

構文

createLoginKey構文は次の通りです。

./ncloud vserver createLoginKey \
    [--keyName <key-name>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

createLoginKeyの実行時に指定できるオプションについて説明します。

任意オプション

createLoginKeyの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション タイプ 必須の有無 説明
--keyName String Optional 認証キー名
  • 未入力時、自動作成
  • 英字の小文字、数字、記号の-を組み合わせて3~30文字以内で入力
  • 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用

共通オプション

vserverコマンドで共通して使用するオプションについては、Server (VPC)のオプションをご参照ください。

認証キーの作成リクエストが成功すると、認証キーの名前と秘密鍵が返されます。

コマンド

コマンドの例は次の通りです。

./ncloud vserver createLoginKey \
    --keyName test-login-key-01 \
    --regionCode KR \
    --output json

出力

出力の例は次の通りです。

{
  "createLoginKeyResponse": {
    "keyName": "test-login-key-01",
    "privateKey": "-----BEGIN RSA PRIVATE KEY-----\n<private-key-redacted>\n-----END RSA PRIVATE KEY-----\n",
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}