Secrets Manager インスタンス管理 CLI

IBM Cloud® Secrets Manager のインスタンス管理コマンドラインインターフェイス（CLI）を使用すると、コマンドラインから Secrets Manager のVault Dedicatedインスタンスを管理できます。

現行バージョン: 2.0.7

「Vault Dedicated」プランは現在、パブリックベータ版として提供されています。 ベータ版機能は、評価およびテストを目的として提供されており、一般に利用可能な機能に比べて制限があります。

開始前に

作業を開始する前に、 IBM Cloud CLI をインストールし、次に以下のコマンドを実行して、 Secrets Manager インスタンス管理用CLIプラグインをインストールしてください

ibmcloud plugin install secrets-manager-instance-management

IBM Cloud CLI およびプラグインに対する更新が使用可能になると、コマンド・ラインで通知されます。 最新のコマンドを利用できるように、CLIを常に最新の状態に保ってください。 ibmcloud plugin list を実行すると、インストールされているすべてのプラグインの現行バージョンを表示できます。

Secrets Manager インスタンスをターゲットにする

Secrets Manager Vault Dedicatedインスタンスをターゲットにするには、以下のいずれかのオプションを使用してください。

  • ibmcloud secrets-manager-instance-management config set コマンドを実行します。

    ibmcloud secrets-manager-instance-management config set service-url https://{instance_ID}.{region}.secrets-manager.cloud.ibm.com

  • Secrets Manager のコントロールプレーン・サービス・エンドポイント URL を含む環境変数をエクスポートします。

    export SECRETS_MANAGER_INSTANCE_MANAGEMENT_URL=https://{instance_ID}.{region}.secrets-manager.cloud.ibm.com

  • コマンド内でサービスエンドポイントを設定します。

    ibmcloud secrets-manager-instance-management instance --service-url https://{instance_ID}.{region}.secrets-manager.cloud.ibm.com

{instance_ID} および {region} を、お使いの Secrets Manager Vault Dedicated サービスインスタンスに適用される値に置き換えてください。 インスタンス固有のエンドポイント URL を見つけるには、Secrets Manager UI の 「エンドポイント」 ページからエンドポイント URL をコピーします。 詳しくは、エンドポイント URL の表示を参照してください。

グローバル

コマンド

ibmcloud secrets-manager-instance-management docs

Webブラウザでプラグインのドキュメントを開きます。

ibmcloud secrets-manager-instance-management docs
例
ibmcloud secrets-manager-instance-management docs

オプション

--region (文字列)
Vault専用インスタンスをプロビジョニングしたリージョン。 利用可能な地域：us-south、eu-de。
--output (文字列)
出力形式を「json」、「yaml」、または「table」から選択します。 デフォルトは「table」です。
-j, --jmes-query (文字列)
出力をカスタマイズするにはJMESPathクエリーを指定します。
--service-url (文字列)
APIの基本エンドポイント URL を指定します。
-q, --quiet
冗長メッセージを抑制します。
-v, --version
プラグインのバージョンを表示します。

例

ibmcloud secrets-manager-instance-management \
    --region=us-south \
    --output=json \
    --jmes-query="[:10]" \
    --service-url="https://myservice.cloud.ibm.com" \
    --quiet

この例は、すべてのサブコマンドで利用できるグローバルオプションを示すものであり、それ自体が有効なコマンドではありません。

構成

グローバルパラメータも永続的な設定に保存できるため、プラグインが呼び出されるたびに手動で指定する必要がなくなります。 各パラメータは、 config コマンドおよびそのサブコマンドを使用して設定できます。

ibmcloud secrets-manager-instance-management config

ibmcloud secrets-manager-instance-management config set

特定のオプションの新しい構成値を設定します。 set コマンドの各サブコマンドは、グローバルオプションに対応しています。 各サブコマンドは、そのオプションに保存する値の文字列表現である単一の引数を受け取ります。

ibmcloud secrets-manager-instance-management config set <option> <value>

例

ibmcloud secrets-manager-instance-management config set service-url \
    'https://{region}.secrets-manager.cloud.ibm.com'

ibmcloud secrets-manager-instance-management config get

特定のオプションについて、現在設定されている値を印刷します。 get コマンドの各サブコマンドは、グローバルオプションに対応しています。

ibmcloud secrets-manager-instance-management config get <option>

例

ibmcloud secrets-manager-instance-management config get service-url

ibmcloud secrets-manager-instance-management config unset

特定のオプションに対して現在設定されている値を設定解除します。 unset コマンドの各サブコマンドは、グローバルオプションに対応しています。

このサービスで利用可能なサブコマンドは、 service-url、. です。

ibmcloud secrets-manager-instance-management config unset <option>

例

ibmcloud secrets-manager-instance-management config unset service-url

ibmcloud secrets-manager-instance-management config list

現在設定されているすべての構成値をリストします。

ibmcloud secrets-manager-instance-management config list

例

ibmcloud secrets-manager-instance-management config list

トークン

管理用トークンを管理します。

ibmcloud secrets-manager-instance-management admin-token-create

Vault Dedicated クラスターへの認証用に、Vault 管理者トークンを生成します。 このトークンの有効期間は1時間で、管理者権限が付与されます。 初期設定およびクラスタ管理にのみ使用し、その後直ちに権限を取り消してください。

ibmcloud secrets-manager-instance-management admin-token-create --id ID [--region REGION] [-j, --jmes-query JMES-QUERY] [--output OUTPUT] [-q, --quiet]

コマンド・オプション

--id (文字列)

Secrets Manager インスタンスID。 必須。

長さは 36 文字でなければなりません。 その値は、正規表現「 /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/ 」に一致する必要があります。

例

要求の例

ibmcloud secrets-manager-instance-management admin-token-create --id bfc50c2e-d66d-4f37-9ccf-9713f8325b39

ibmcloud secrets-manager-instance-management admin-tokens-delete

すべてのアクティブなVault管理者トークンを取り消します。 これにより、既存のすべての管理者トークンが直ちに無効化されます。

ibmcloud secrets-manager-instance-management admin-tokens-delete --id ID [--region REGION] [-j, --jmes-query JMES-QUERY] [--output OUTPUT] [-q, --quiet]

コマンド・オプション

--id (文字列)

Secrets Manager インスタンスID。 必須。

長さは 36 文字でなければなりません。 その値は、正規表現「 /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/ 」に一致する必要があります。

例

要求の例

ibmcloud secrets-manager-instance-management admin-tokens-delete --id bfc50c2e-d66d-4f37-9ccf-9713f8325b39

インスタンス

インスタンスの詳細。

ibmcloud secrets-manager-instance-management instance-details

クラスタの状態、エンドポイント、キー管理サービスなど、サービスインスタンスの詳細を取得します。

ibmcloud secrets-manager-instance-management instance-details --id ID [--region REGION] [-j, --jmes-query JMES-QUERY] [--output OUTPUT] [-q, --quiet]

コマンド・オプション

--id (文字列)

Secrets Manager インスタンスID。 必須。

長さは 36 文字でなければなりません。 その値は、正規表現「 /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/ 」に一致する必要があります。

例

要求の例

ibmcloud secrets-manager-instance-management instance-details --id bfc50c2e-d66d-4f37-9ccf-9713f8325b39

出力例

レスポンスの例

{
  "id" : "12345678-abcd-1234-abcd-1234567890ab",
  "name" : "Example Instance",
  "href" : "https://us-south.secrets-manager.cloud.ibm.com/v2/instances/12345678-abcd-1234-abcd-1234567890ab",
  "instance_crn" : "crn:v1:bluemix:public:secrets-manager:us-south:a/a1b2c3d4e5f61234567890abcdef1234:12345678-abcd-1234-abcd-1234567890ab::",
  "plan" : "dedicated",
  "vault_cluster" : {
    "status" : "healthy",
    "version" : "1.21.2+ent.hsm"
  },
  "endpoints" : {
    "public" : {
      "vault_api" : "https://12345678-abcd-1234-abcd-1234567890ab.us-south.secrets-manager.appdomain.cloud",
      "vault_ui" : "https://12345678-abcd-1234-abcd-1234567890ab.us-south.secrets-manager.appdomain.cloud/ui"
    },
    "private" : {
      "vault_api" : "https://private.12345678-abcd-1234-abcd-1234567890ab.us-south.secrets-manager.appdomain.cloud",
      "vault_ui" : "https://private.12345678-abcd-1234-abcd-1234567890ab.us-south.secrets-manager.appdomain.cloud/ui"
    }
  },
  "encryption" : {
    "mode" : "customer_managed",
    "provider" : "key_protect",
    "key_crn" : "crn:v1:bluemix:public:kms:us-south:a/a1b2c3d4e5f61234567890abcdef1234:abcd1234-ab12-ab12-ab12-abcdef123456:key:12ab34cd-12ab-12ab-12ab-123456abcdef"
  }
}