CLI を使用した鍵管理操作の実行-標準プランのみ

IBM Cloud® Hyper Protect Crypto Services 標準プランは、 IBM Key Protect コマンド・ライン・インターフェース (CLI) プラグインと統合されているため、 IBM Key Protect CLI プラグインを使用して、暗号化 ルート鍵A symmetric wrapping key that is used for encrypting and decrypting other keys that are stored in a data service. および標準鍵を作成、インポート、および管理することができます。

現在、CLI での鍵管理操作の実行は、標準プランでのみサポートされています。 UI または API を使用して、 Unified Key Orchestrator で Hyper Protect Crypto Services の鍵管理操作を引き続き実行できます。

Key Protect インスタンス (略してサービス・インスタンス) を介して Hyper Protect Crypto Services CLI を使用する前に、以下の手順を実行する必要があります。

1. IBM Key Protect CLI プラグインをインストールします。

2. 次のようにして、ワークステーションで KP_PRIVATE_ADDR 環境変数を設定します。

   • Linux オペレーティング・システムまたは macOSでは、以下のコマンドを実行します。

     export KP_PRIVATE_ADDR=<URL>
     

     このコマンドの URL は、Key management endpoint URL です。 「概要」>「接続」>**「キー管理エンドポイント URL」**によって、プロビジョンされたサービス・インスタンスのダッシュボードからエンドポイントを取得できます。 あるいは、API 呼び出しを使用して動的に API エンドポイント URL を取得 することもできます。 以下に例を示します。

     export KP_PRIVATE_ADDR="https://<INSTANCE_ID>.api.us-south.hs-crypto.appdomain.cloud"
     

     Hyper Protect Crypto Services でサポートされている地域については、地域とロケーションを参照してください。

   • Windows オペレーティング・システムでは、 「コントロールパネル」 の検索ボックスに environment variable と入力して、「環境変数」ウィンドウを見つけます。 KP_PRIVATE_ADDR 環境変数を作成し、プロビジョンされた UI の 「管理」 タブに表示されるエンドポイントに値を設定します。 例えば、 https://<INSTANCE_ID>.api.us-south.hs-crypto.appdomain.cloud のようになります。

   このエンドポイント URL は API で取得することもできます。 詳しくは、 Hyper Protect Crypto Services 鍵管理サービスの API リファレンス資料を確認してください。

   パブリック・エンドポイントとプライベート・エンドポイントのどちらを使用するかによって、対応するエンドポイント URL を選択し、KP_PRIVATE_ADDR 環境変数の値を設定します。

3. 次のようにして、ワークステーションで KP_INSTANCE_ID 環境変数を設定します。

   • Linux オペレーティング・システムまたは macOSでは、以下のコマンドを実行します。

     export KP_INSTANCE_ID=<instance_ID>
     

     このコマンドでは、プロビジョンされた UI の 「管理」 タブに instance_ID が表示されます。 instance_ID は、Universally Unique Identifier (UUID) 形式です。

   • Windowsの場合、 「コントロールパネル」 の検索ボックスに environment variable と入力して、「環境変数」ウィンドウを見つけます。 KP_INSTANCE_ID 環境変数を作成し、プロビジョン済みの Hyper Protect Crypto Services のダッシュボードの**「管理」**タブに表示されるインスタンス ID の値を設定します。

   または、ibmcloud kp コマンドの -i <instance_ID> オプションを使用して、インスタンス ID を設定することもできます。

4. 鍵管理操作を実行するための具体的なコマンドを実行します。 コマンドの完全なリストについては、鍵管理の CLI リファレンスを参照してください。

5. Key Protect CLI プラグインを最新バージョンにアップグレードして、新機能を使用可能にします。

6. (オプション) プラグインが不要になったら、Key Protect CLI プラグインをアンインストールします。