设置 CLI

您可以使用 IBM Key Protect CLI 插件来帮助您创建、导入和管理加密密钥。

要了解更多关于使用 Key Protect CLI 插件，请查看 Key Protect CLI 参考文档

安装 Key Protect CLI 插件

在设置 Key Protect CLI 插件之前，请先安装 IBM Cloud CLI。

要安装 CLI，请执行以下操作：

安装 IBM Cloud CLI。

安装 CLI 后，可以运行 ibmcloud 命令来与云服务进行交互。
登录到 IBM Cloud。
```
ibmcloud login
```
如果登录失败，请运行 ibmcloud login --sso 命令重试。该 --sso 参数在使用联合 ID 登录时是必需的。如果使用此选项，请转至 CLI 输出中列出的链接以生成一次性密码。
要开始管理加密密钥，请安装 Key Protect CLI 插件。
```
ibmcloud plugin install key-protect -r "IBM Cloud"
```
将区域设置为以特定 Key Protect 端点为目标。
```
ibmcloud kp region-set -i <INSTANCE_ID>
```
将 <INSTANCE_ID> 替换为表示 Key Protect的实例标识。在供应 Key Protect 服务中了解有关实例 (包括选择区域) 的更多信息。

系统将提示您从列表中进行选择，如结果中所示。
```
Select a Region:
    1. au-syd
    2. eu-de
    3. eu-gb
    4. jp-osa
    5. jp-tok
    6. us-east
    7. us-south
    8. staging (us-south)
    Enter a number:
```

设置实例端点：

export KP_TARGET_ADDR=<KEY_PROTECT_INSTANCE_ENDPOINT>

将 <KEY_PROTECT_INSTANCE_ENDPOINT> 替换为实例 ID 的端点。例如：

export KP_TARGET_ADDR=https://fadedbee-0000-0000-0000-1234567890ab.api.us-south.kms.appdomain.cloud

您可以在 IBM Cloud UI 控制台中找到特定实例的 Key Protect 的实例端点。

可选：验证是否已成功安装插件。
```
ibmcloud plugin list
```

更新 Key Protect CLI 插件

对于最佳实践，您可以选择定期更新 CLI 以使用新功能。

要更新 CLI，请执行以下操作：

使用以下命令登录到 IBM Cloud IBM Cloud CLI。
```
ibmcloud login
```
如果登录失败，请运行 ibmcloud login --sso 命令重试。该 --sso 参数在使用联合 ID 登录时是必需的。如果使用此选项，请转至 CLI 输出中列出的链接以生成一次性密码。
从插件存储库中安装更新。
```
ibmcloud plugin update key-protect
```

可选：验证是否已成功更新插件。

ibmcloud plugin list

结果应显示插件的版本和状态以及有关插件的属性，例如是否支持 "专用端点"。


Plugin Name                             Version   Status             Private endpoints supported   
cloud-functions[wsk/functions/fn]       1.0.49    Update Available   false   
cloud-object-storage                    1.2.4     Update Available   false   
container-registry                      0.1.541   Update Available   true   
container-service[kubernetes-service]   1.0.233   Update Available   false   
key-protect                             0.6.8                        true   
sdk-gen                                 0.1.12                       false

卸载 Key Protect CLI 插件

使用以下命令登录到 IBM Cloud IBM Cloud CLI。
```
ibmcloud login
```
如果登录失败，请运行 ibmcloud login --sso 命令重试。该 --sso 参数在使用联合 ID 登录时是必需的。如果使用此选项，请转至 CLI 输出中列出的链接以生成一次性密码。
从插件存储库中安装更新。
```
ibmcloud plugin uninstall key-protect
```
可选：验证是否已成功卸载插件。
```
ibmcloud plugin list
```