IBM Cloud Hyper Protect Crypto Services CLI

Hyper Protect Crypto Services 提供了多个 IBM Cloud® CLI 插件，供您针对服务实例执行操作: 密钥管理 CLI 插件，可信密钥条目 (TKE) CLI 插件，证书管理器 CLI 插件和 Unified Key Orchestrator (UKO) CLI 插件。

Hyper Protect Crypto Services 密钥管理 CLI 插件

Hyper Protect Crypto Services 与 Key Protect CLI 插件集成，以便您可以使用 Key Protect CLI 插件来管理 Hyper Protect Crypto Services 实例中的根密钥和标准密钥。

有关如何为 Hyper Protect Crypto Services设置 Key Protect CLI 插件，请参阅使用 CLI 执行密钥管理操作。
有关完整的密钥管理 CLI 参考，请参阅 Key Protect CLI 命令参考。

Hyper Protect Crypto Services 可信密钥条目 CLI 插件

您可以使用 TKE CLI 插件来管理分配给帐户的加密单元。

安装 TKE CLI 插件

要安装 TKE CLI 插件，请执行以下步骤：

安装 IBM Cloud CLI。

IBM Cloud CLI 需要 Java™ 1.8.0。使用 IBM Cloud CLI 运行命令的前缀为 ibmcloud。
使用以下命令安装最新的 TKE 插件：
```
ibmcloud plugin install tke
```
当 IBM Cloud CLI 和插件的更新可用时，将在命令行上通知您。请确保 CLI 保持最新，以便您可以使用最新的命令。您可以通过运行 ibmcloud plugin list来查看所有已安装插件的当前版本。
在工作站上设置 CLOUDTKEFILES 环境变量。指定要在其中创建和保存工作站文件和签名工作站文件的目录。如果该目录不存在，请予以创建。
- 在 Linux™ 操作系统或 MacOS上，将以下行添加到 .bash_profile 文件:
```
export CLOUDTKEFILES=<path>
```
  例如，您可以将 path 指定为 /Users/tke-files。
- 在 Windows™ 操作系统上的 控制面板中，在搜索框中输入 environment variable 以找到 "环境变量" 窗口。创建 CLOUDTKEFILES 环境变量，并将值设置为密钥文件的路径。例如，C:\users\tke-files。

TKE CLI 插件命令

表 1. 描述 TKE CLI 插件命令
命令名	说明	示例
`tke auto-init`	自动初始化服务实例。	`ibmcloud tke auto-init`
`tke auto-mk-rotate`	使用恢复 HSM 中随机生成的主密钥值自动轮换主密钥。	`ibmcloud tke auto-mk-rotate`
`tke auto-recover`	自动将当前主密钥值从恢复 HSM 复制到同一资源组中的其他加密单元。	`ibmcloud tke auto-recover`
`tke`	管理 IBM Cloud中的加密单元。	`ibmcloud tke`
`tke cryptounit-add`	将加密单元添加到要使用的加密单元集。	`ibmcloud tke cryptounit-add`
`tke cryptounit-admin-add`	向选定加密单元添加加密单元管理员。	`ibmcloud tke cryptounit-admin-add`
`tke cryptounit-admin-rm`	从选定加密单元中除去加密单元管理员。	`ibmcloud tke cryptounit-admin-rm`
`tke cryptounit-admins`	列出安装在选定加密单元中的管理员。	`ibmcloud tke cryptounit-admins`
`tke cryptounit-compare`	比较选定加密单元的配置设置。	`ibmcloud tke cryptounit-compare`
`tke cryptounit-cp-btc`	在所选加密单元中启用与比特币 (BTC) 相关的功能。	`ibmcloud tke cryptounit-cp-btc`
`tke cryptounit-cp-eddsa`	在所选加密单元中启用 Edwards-曲线数字签名算法 (EdDSA) 功能。	`ibmcloud tke cryptounit-cp-eddsa`
`tke cryptounit-cp-sig-other`	在所选加密单元中启用非椭圆曲线 DSA ，非爱德华兹曲线 DSA 数字签名函数。	`ibmcloud tke cryptounit-cp-sig-other`
`tke cryptounit-exit-impr`	使选定加密单元退出印记模式。 (不推荐使用。请改为使用 `cryptounit-thrhld-set` 。)	`ibmcloud tke cryptounit-exit-impr`
`tke cryptounit-mk`	显示选定加密单元的主密钥寄存器。	`ibmcloud tke cryptounit-mk`
`tke cryptounit-mk-clrcur`	清除当前主密钥寄存器。	`ibmcloud tke cryptounit-mk-clrcur`
`tke cryptounit-mk-clrnew`	清除新的主密钥寄存器。	`ibmcloud tke cryptounit-mk-clrnew`
`tke cryptounit-mk-commit`	落实新的主密钥寄存器。	`ibmcloud tke cryptounit-mk-commit`
`tke cryptounit-mk-load`	装入新的主密钥寄存器。	`ibmcloud tke cryptounit-mk-load`
`tke cryptounit-mk-rotate`	在密钥管理密钥库中重新打包根密钥和加密密钥之后，将新主密钥寄存器中的主密钥提升到当前主密钥寄存器。	`ibmcloud tke cryptounit-mk-rotate`
`tke cryptounit-mk-setimm`	在主密钥寄存器上立即设置。	`ibmcloud tke cryptounit-mk-setimm`
`tke cryptounit-rm`	从要使用的加密单元集除去加密单元。	`ibmcloud tke cryptounit-rm`
`tke cryptounit-thrhld-set`	设置所选加密单元的签名阈值。	`ibmcloud tke cryptounit-thrhld-set`
`tke cryptounit-thrhlds`	显示所选加密单元的签名阈值。	`ibmcloud tke cryptounit-thrhlds`
`tke cryptounit-zeroize`	使选定加密单元归零。	`ibmcloud tke cryptounit-zeroize`
`tke cryptounits`	显示当前资源组的加密单元。	`ibmcloud tke cryptounits`
`tke failover-enable`	在供应服务实例后启用或添加故障转移加密单元。	`ibmcloud tke failover-enable`
`tke mk-add`	创建并保存新的 EP11 主密钥部件。	`ibmcloud tke mk-add`
`tke mk-rm`	从此工作站中除去 EP11 主密钥部件。	`ibmcloud tke mk-rm`
`tke mks`	列示存储在此工作站上的 EP11 主密钥部件。	`ibmcloud tke mks`
`tke sigkey-add`	生成并保存新的签名密钥。	`ibmcloud tke sigkey-add`
`tke sigkey-rm`	从此工作站中除去签名密钥。	`ibmcloud tke sigkey-rm`
`tke sigkey-sel`	选择要用于对命令进行签名的签名密钥。	`ibmcloud tke sigkey-sel`
`tke sigkeys`	列出存储在此工作站上的签名密钥。	`ibmcloud tke sigkeys`
`tke help`, `tke h`	显示帮助。	`ibmcloud tke help`

有关每个命令的更多信息，请在 TKE CLI 插件中运行以下命令：

ibmcloud tke help <command_name>

Hyper Protect Crypto Services 证书管理器 CLI 插件

您可以使用证书管理器 CLI 插件来管理 GREP11 或 PKCS #11 API 连接中的第二层认证的证书和管理员签名密钥。

安装证书管理器 CLI 插件

要安装证书管理器 CLI 插件，请执行以下步骤:

安装 IBM Cloud CLI。

IBM Cloud CLI 需要 Java™ 1.8.0。使用 IBM Cloud CLI 运行命令的前缀为 ibmcloud。
使用以下命令安装最新的证书管理器插件:
```
ibmcloud plugin install hpcs-cert-mgr
```
当 IBM Cloud CLI 和插件的更新可用时，将在命令行上通知您。请确保 CLI 保持最新，以便您可以使用最新的命令。您可以通过运行 ibmcloud plugin list来查看所有已安装插件的当前版本。

Certificate manager CLI 插件命令

以下列出了所有可用的证书管理器 CLI 命令及其相应的用法。使用 -h 或 --help 以获取帮助信息。

hpcs-cert-mgr adminkey get

使用此命令可检索证书管理员的管理员签名密钥。

ibmcloud hpcs-cert-mgr adminkey get --crn HPCS_CRN [--private]

命令选项

-- crn HPCS_CRN

必需。 Hyper Protect Crypto Services 实例的 crn 。您可以使用 ibmcloud resource service-instances --long 命令来检索 crn。

--private

可选。如果使用此选项，那么证书管理器服务器 URL 将指向专用网络。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您登录到 IBM Cloud的地理区域的缩写。在这种情况下，您需要使用专用网络来连接服务实例。

示例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

ibmcloud hpcs-cert-mgr adminkey get --crn ${HPCS_CRN}

输出

该命令返回类似于以下示例的输出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
+------------+--------+
| PROPERTIES | VALUES |
+------------+--------+
| PublicKey  |        |
+------------+--------+

command completed successfully.

hpcs-cert-mgr 管理密钥集

使用此命令为证书管理员创建用于连接到证书管理器服务器的管理员签名密钥。

ibmcloud hpcs-cert-mgr adminkey set --crn HPCS_CRN [--private]

命令选项

-- crn HPCS_CRN

必需。 Hyper Protect Crypto Services 实例的 crn 。您可以使用 ibmcloud resource service-instances --long 命令来检索 crn。

--private

可选。如果使用此选项，那么证书管理器服务器 URL 将指向专用网络。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您登录到 IBM Cloud的地理区域的缩写。在这种情况下，您需要使用专用网络来连接服务实例。

示例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

ibmcloud hpcs-cert-mgr adminkey set --crn ${HPCS_CRN}

输出

该命令返回类似于以下示例的输出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
+------------+-----------------------------------------------------------------------------------+
| KEYTYPE    | FILE                                                                              |
+------------+-----------------------------------------------------------------------------------+
| PrivateKey | /Users/username/.hpcs-cert-mgr-cfg/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.priv  |
| PublicKey  | /Users/username/.hpcs-cert-mgr-cfg/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.pub   |
+------------+-----------------------------------------------------------------------------------+

An automatically generated keypair is stored locally and configured to node remotely, please keep the keypair carefully!!!

command completed successfully.

hpcs-cert-mgr adminkey 更新

使用此命令来刷新和更新证书管理员的管理员签名密钥。

ibmcloud hpcs-cert-mgr adminkey update --crn HPCS_CRN --admin-priv-key ADMIN_PRIV_KEY [--private]

命令选项

-- crn HPCS_CRN

必需。 Hyper Protect Crypto Services 实例的 crn 。您可以使用 ibmcloud resource service-instances --long 命令来检索 crn。

--admin-priv-key ADMIN_PRIV_KEY

必需。本地工作站上存储的现有专用密钥的文件路径。专用密钥用于向实例证书管理器服务器签署此命令操作。

--private

可选。如果使用此选项，那么证书管理器服务器 URL 将指向专用网络。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您登录到 IBM Cloud的地理区域的缩写。在这种情况下，您需要使用专用网络来连接服务实例。

示例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

export ADMIN_PRIV_KEY=/Users/admin1/.hpcs-cert-mgr-cfg/44de77d2-599b-0089-2f0f-bad8d1c94a7c.priv

ibmcloud hpcs-cert-mgr adminkey update --crn ${HPCS_CRN} --admin-priv-key ${ADMIN_PRIV_KEY}

输出

该命令返回类似于以下示例的输出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
+------------+-----------------------------------------------------------------------------------+
| KEYTYPE    | FILE                                                                              |
+------------+-----------------------------------------------------------------------------------+
| PrivateKey | /Users/username/.hpcs-cert-mgr-cfg/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.priv  |
| PublicKey  | /Users/username/.hpcs-cert-mgr-cfg/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.pub   |
+------------+-----------------------------------------------------------------------------------+

An automatically generated keypair is stored locally and configured to node remotely, please keep the keypair carefully!!!

command completed successfully.

hpcs-cert-mgr adminkey 删除

使用此命令可删除证书管理员的管理员签名密钥。

ibmcloud hpcs-cert-mgr adminkey delete --crn HPCS_CRN --admin-priv-key ADMIN_PRIV_KEY [--private]

命令选项

-- crn HPCS_CRN

必需。 Hyper Protect Crypto Services 实例的 crn 。您可以使用 ibmcloud resource service-instances --long 命令来检索 crn。

--admin-priv-key ADMIN_PRIV_KEY

必需。存储在本地工作站上的当前专用密钥的文件路径。专用密钥用于向实例证书管理器服务器签署此命令操作。

--private

可选。如果使用此选项，那么证书管理器服务器 URL 将指向专用网络。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您登录到 IBM Cloud的地理区域的缩写。在这种情况下，您需要使用专用网络来连接服务实例。

示例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

export ADMIN_PRIV_KEY=/Users/admin1/.hpcs-cert-mgr-cfg/44de77d2-599b-0089-2f0f-bad8d1c94a7c.priv

ibmcloud hpcs-cert-mgr adminkey delete --crn ${HPCS_CRN} --admin-priv-key ${ADMIN_PRIV_KEY}

输出

该命令返回类似于以下示例的输出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
command completed successfully.

hpcs-cert-mgr 证书获取

使用此命令可在实例证书管理器服务器上检索客户机证书。

ibmcloud hpcs-cert-mgr cert get --crn HPCS_CRN --cert-id CERT_ID [--cert-store-file CERT_FILE] [--private]

命令选项

-- crn HPCS_CRN

必需。 Hyper Protect Crypto Services 实例的 crn 。您可以使用 ibmcloud resource service-instances --long 命令来检索 crn。

-- cert-id CERT_ID

必需。要检索的客户机证书的字符串标识。

--cert-store-file CERT_FILE

可选。用于存储检索到的证书的文件路径。如果指定此选项，那么将在本地工作站上创建该文件并存储证书内容。

--private

可选。如果使用此选项，那么证书管理器服务器 URL 将指向专用网络。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您登录到 IBM Cloud的地理区域的缩写。在这种情况下，您需要使用专用网络来连接服务实例。

示例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

ibmcloud hpcs-cert-mgr cert get --crn ${HPCS_CRN} --cert-id testcert --cert-store-file c/b/cert.pem

输出

该命令返回类似于以下示例的输出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
------------------ The returned certification ------------------
-----BEGIN CERTIFICATE-----
MIIFazCCA10gAwIBAgIUVW/gPwBtOKHEwCL.........
............................................
............................................
................................FkQF0tfc6cg=
-----END CERTIFICATE-----

command completed successfully.

hpcs-cert-mgr 证书集

使用此命令为实例证书管理器服务器设置客户机证书。

ibmcloud hpcs-cert-mgr cert set --crn HPCS_CRN --admin-priv-key ADMIN_PRIV_KEY --cert-id CERT_ID --cert CERT_FILE [--private]

命令选项

-- crn HPCS_CRN

必需。 Hyper Protect Crypto Services 实例的 crn 。您可以使用 ibmcloud resource service-instances --long 命令来检索 crn。

--admin-priv-key ADMIN_PRIV_KEY

必需。存储在本地工作站上的当前专用密钥的文件路径。专用密钥用于向实例证书管理器服务器签署此命令操作。

-- cert-id CERT_ID

必需。要分配给证书以方便标识的字符串标识。

-- 证书 CERT_FILE

必需。存储在工作站上的证书文件。建议使用 IBM Cloud Certificate Manager 来订购和管理应用程序和服务的 SSL/TLS 证书。

--private

可选。如果使用此选项，那么证书管理器服务器 URL 将指向专用网络。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您登录到 IBM Cloud的地理区域的缩写。在这种情况下，您需要使用专用网络来连接服务实例。

示例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

export CERT=/Users/admin1/cert.pem

export ADMIN_PRIV_KEY=/Users/admin1/.hpcs-cert-mgr-cfg/44de77d2-599b-0089-2f0f-bad8d1c94a7c.priv

ibmcloud hpcs-cert-mgr cert set --crn ${HPCS_CRN} --admin-priv-key ${ADMIN_PRIV_KEY} --cert-id testcert --cert ${CERT}

输出

该命令返回类似于以下示例的输出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
command completed successfully.

hpcs-cert-mgr 证书列表

使用此命令可列出由实例证书管理器服务器的管理员管理的所有证书。

ibmcloud hpcs-cert-mgr cert list --crn HPCS_CRN [--private]

命令选项

-- crn HPCS_CRN

必需。 Hyper Protect Crypto Services 实例的 crn 。您可以使用 ibmcloud resource service-instances --long 命令来检索 crn。

--private

可选。如果使用此选项，那么证书管理器服务器 URL 将指向专用网络。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您登录到 IBM Cloud的地理区域的缩写。在这种情况下，您需要使用专用网络来连接服务实例。

示例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

ibmcloud hpcs-cert-mgr cert list --crn ${HPCS_CRN}

输出

该命令返回类似于以下示例的输出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
+------------+----------------------------------------+
| CERTID     | CERT                                   |
| testcert   | -----BEGIN CERTIFICATE-----            |
|            | MIIFazCCA10gAwIBAgIUVW/gPwBtOKHEwCL....|
|            |........................................|
|            |............................FkQF0tfc6cg=|
|            | -----END CERTIFICATE-----              |
|            |                                        |
| testcert2  | -----BEGIN CERTIFICATE-----            |
|            | MIIFazCCA10gAwIBAgIUVW/gPwBtOKHEwCL....|
|            |........................................|
|            |............................FkQF0tfc6cg=|
|            | -----END CERTIFICATE-----              |
|            |                                        |
+------------+----------------------------------------+

command completed successfully.

hpcs-cert-mgr 证书删除

使用此命令可删除实例证书管理器服务器的客户机证书。

ibmcloud hpcs-cert-mgr cert delete --crn HPCS_CRN --admin-priv-key ADMIN_PRIV_KEY --cert-id CERT_ID [--private]

命令选项

-- crn HPCS_CRN

必需。 Hyper Protect Crypto Services 实例的 crn 。您可以使用 ibmcloud resource service-instances --long 命令来检索 crn。

--admin-priv-key ADMIN_PRIV_KEY

必需。存储在本地工作站上的当前专用密钥的文件路径。专用密钥用于向实例证书管理器服务器签署此命令操作。

-- cert-id CERT_ID

必需。要删除的证书的字符串标识。

--private

可选。如果使用此选项，那么证书管理器服务器 URL 将指向专用网络。例如: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443。 region 是您登录到 IBM Cloud的地理区域的缩写。在这种情况下，您需要使用专用网络来连接服务实例。

示例

export HPCS_CRN=crn:v1:staging:public:xxx:yyy:zzz

export ADMIN_PRIV_KEY=/Users/admin1/.hpcs-cert-mgr-cfg/44de77d2-599b-0089-2f0f-bad8d1c94a7c.priv

ibmcloud hpcs-cert-mgr cert delete --crn ${HPCS_CRN} --admin-priv-key ${ADMIN_PRIV_KEY} --cert-id testcert

输出

该命令返回类似于以下示例的输出:

connecting to server [cert-mgr.us-south.hs-crypto.cloud.ibm.com:443]...
command completed successfully.

Hyper Protect Crypto Services Unified Key Orchestrator CLI 插件

您可以使用 Unified Key Orchestrator CLI 插件通过 Unified Key Orchestrator 套餐来管理 Hyper Protect Crypto Services 实例的保险库文件，密钥库和受管密钥。

安装 Unified Key Orchestrator CLI 插件

要安装 Unified Key Orchestrator CLI 插件，请执行以下步骤:

安装 IBM Cloud CLI。

IBM Cloud CLI 需要 Java™ 1.8.0。使用 IBM Cloud CLI 运行命令的前缀为 ibmcloud。
使用以下命令安装最新的 Unified Key Orchestrator CLI 插件:
```
ibmcloud plugin install hpcs
```
当 IBM Cloud CLI 和插件的更新可用时，将在命令行上通知您。请确保 CLI 保持最新，以便您可以使用最新的命令。您可以通过运行 ibmcloud plugin list来查看所有已安装插件的当前版本。
在工作站上设置 UKO_URL 环境变量。
```
export UKO_URL=<UKO_endpoint_URL>
```
将 <UKO_endpoint_URL> 替换为实例 UKO 端点 URL。您可以通过概述 > 连接 > Unified Key Orchestrator 端点 URL在供应的服务实例 UI 仪表板上获取端点 URL。或者，您可以动态检索 API 端点 URL。

Unified Key Orchestrator CLI 插件命令

以下列出了所有可用的 Unified Key Orchestrator CLI 命令及其相应用法。使用 -h 或 --help 以获取帮助信息。

hpcs uko 受管密钥

列出实例中的所有受管密钥。可以按以下参数进行排序 :name ， algorithm ， state ， activation_date ， deactivation_date ， created_at ， updated_at ， size 和 vault.id。

如果未设置 --all-pages 选项，那么该命令将仅检索集合的单个页面。

ibmcloud hpcs uko managed-keys [--vault-id VAULT-ID] [--algorithm ALGORITHM] [--state STATE] [--limit LIMIT] [--offset OFFSET] [--sort SORT] [--label LABEL] [--activation-date ACTIVATION-DATE] [--activation-date-min ACTIVATION-DATE-MIN] [--activation-date-max ACTIVATION-DATE-MAX] [--deactivation-date DEACTIVATION-DATE] [--deactivation-date-min DEACTIVATION-DATE-MIN] [--deactivation-date-max DEACTIVATION-DATE-MAX] [--expiration-date EXPIRATION-DATE] [--expiration-date-min EXPIRATION-DATE-MIN] [--expiration-date-max EXPIRATION-DATE-MAX] [--created-at CREATED-AT] [--created-at-min CREATED-AT-MIN] [--created-at-max CREATED-AT-MAX] [--updated-at UPDATED-AT] [--updated-at-min UPDATED-AT-MIN] [--updated-at-max UPDATED-AT-MAX] [--size SIZE] [--size-min SIZE-MIN] [--size-max SIZE-MAX] [--referenced-keystores-type REFERENCED-KEYSTORES-TYPE] [--referenced-keystores-name REFERENCED-KEYSTORES-NAME] [--instances-keystore-type INSTANCES-KEYSTORE-TYPE]

命令选项

-- vault-id ([]字符串)

可选。保险库文件的通用唯一标识 (UUID)。您可以使用 ibmcloud hpcs uko managed-keys 命令来检索 UUID。长度必须为 36 个字符。列表项必须与正则表达式 /^[-0-9a-z]+$/匹配。

-- algorithm ([]字符串)

可选。返回的密钥的算法。可以设置的值为 aes， rsa， hmac和 ec。

-- state ([]字符串)

可选。返回的密钥将处于的状态。缺省值为 ["pre_activation","active"]。可以设置的值为: pre_activation， active， deactivated和 destroyed。

-- limit (int64)

可选。要检索的密钥数。最大值为 1000。最小值为 1。缺省值为 20。

-- offset (int64)

可选。要跳过的密钥数。最小值为 0。

-- sort ([]字符串)

可选。排序顺序。缺省值为 ["-updated_at"]。列表项必须与正则表达式 /^-?[a-z0-9_.\\[\\],-]+$/匹配。

-- label (字符串)

可选。密钥的标签。该值必须与正则表达式 /.+/匹配。

-- Activation-date (字符串)

可选。仅返回其激活日期与参数匹配的受管密钥。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--Activation-date-min (字符串)

可选。仅返回其激活日期等于或晚于参数值的受管密钥。此查询参数不能与 activation_date 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--Activation-date-max (字符串)

可选。仅返回其激活日期等于或早于参数值的受管密钥。此查询参数不能与 activation_date 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--deactivation-date (字符串)

可选。仅返回其取消激活日期与参数匹配的受管密钥。此查询参数不能与 expiration_date 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--deActivation-date-min (字符串)

可选。仅返回其取消激活日期等于或晚于参数值的受管密钥。此查询参数不能与 deactivation_date， expiration_date， expiration_date_min和 expiration_date_max 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--deActivation-date-max (字符串)

可选。仅返回其取消激活日期等于或早于参数值的受管密钥。此查询参数不能与 deactivation_date， expiration_date， expiration_date_min和 expiration_date_max 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

-- expiration-date (字符串)

可选。仅返回其取消激活日期与参数匹配的受管密钥。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--expiration-date-min (字符串)

可选。仅返回其取消激活日期等于或晚于参数值的受管密钥。此查询参数不能与 deactivation_date， expiration_date， deactivation_date_min和 deactivation_date_max 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--expiration-date-max (字符串)

可选。仅返回其取消激活日期等于或早于参数值的受管密钥。此查询参数不能与 deactivation_date， expiration_date， deactivation_date_min和 deactivation_date_max 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

-- created-at (字符串)

可选。仅返回创建时间与参数匹配的受管密钥。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--created-at-min (字符串)

可选。仅返回创建时间等于或晚于参数值的受管密钥。此查询参数不能与 created_at 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--created-at-max (字符串)

可选。仅返回创建时间在参数值或之前的受管密钥。此查询参数不能与 created_at 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

-- updated-at (字符串)

可选。仅返回更新时间与参数匹配的受管密钥。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--updated-at-min (字符串)

可选。仅返回更新时间在参数值之后的受管密钥。此查询参数不能与 updated_at 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--updated-at-max (字符串)

可选。仅返回更新时间在参数值之前的受管密钥。此查询参数不能与 updated_at 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

-- size (int64)

可选。密钥的大小。

-- size-min (int64)

可选。密钥的最小大小。此查询参数不能与 size 查询参数结合使用。

-- size-max (int64)

可选。密钥的最大大小。此查询参数不能与 size 查询参数结合使用。

--引用的密钥库类型 ([]字符串)

可选。引用的密钥库的类型。可以设置的值为 aws_kms， azure_key_vault， ibm_cloud_kms和 google_kms。

--引用的-keystores-name ([]字符串)

可选。引用的密钥库的名称。列表项必须与正则表达式 /[^,]+/匹配。

--instances-keystore-type ([]字符串)

可选。其中一个实例支持的密钥库类型。可以设置的值为 aws_kms， azure_key_vault， ibm_cloud_kms和 google_kms。

-- all-pages (bool)

可选。调用多个请求以显示受管密钥的集合的所有页面。

示例

ibmcloud hpcs uko managed-keys --output json

输出

该命令返回类似于以下示例的输出:

{
  "total_count": 3,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0"
  },
  "last": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0"
  },
  "managed_keys": [
    {
      "id": "8cacc6c9-a4ac-43b7-88c0-cf94765f4bf9",
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "template": {
        "id": "4411f1ae-62cc-484e-9910-65d2e8f258bb",
        "name": "Azure-Example"
      },
      "description": "Azure key description",
      "label": "AZURE-EXAMPLE-KEY",
      "state": "active",
      "size": "2048",
      "algorithm": "rsa",
      "verification_patterns": [
        {
          "method": "PUB-HASH-SHA-1",
          "value": "9EBB4E22E6926F1F6B39EF5126B0F603D821D4D0"
        }
      ],
      "activation_date": "2027-04-18",
      "expiration_date": "2028-06-29",
      "tags": [
        {
          "name": "first-tag",
          "value": "in-Azure"
        }
      ],
      "created_at": "2022-03-09T11:37:24Z",
      "updated_at": "2022-03-09T11:37:27Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "referenced_keystores": [],
      "instances": [
        {
          "id": "3235c1b2-c62b-46e8-a5ce-acd7a8b2c52e",
          "label_in_keystore": "AZURE-EXAMPLE-KEY",
          "keystore": {
            "group": "Production",
            "type": "azure_key_vault"
          }
        }
      ],
      "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/8cacc6c9-a4ac-43b7-88c0-cf94765f4bf9"
    },
    {
      "id": "3dab42dc-6941-4841-8d27-4dabcc5aa09e",
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "template": {
        "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
        "name": "IBM-CLOUD-EXAMPLE-TEMPLATE"
      },
      "description": "IBM CLOUD key template description",
      "label": "IBM CLOUD KEY",
      "state": "active",
      "size": "256",
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method": "enc-zer",
          "value": "DDFA4A"
        }
      ],
      "activation_date": "2027-04-18",
      "expiration_date": "2028-06-29",
      "tags": [
        {
          "name": "first-tag",
          "value": "for-ibm"
        }
      ],
      "created_at": "2022-03-09T11:26:01Z",
      "updated_at": "2022-03-09T11:26:04Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "referenced_keystores": [],
      "instances": [
        {
          "id": "ea7b6b27-d71b-4fe9-bbfe-309c7ca713a6",
          "label_in_keystore": "IBM CLOUD KEY",
          "type": "secret_key",
          "keystore": {
            "group": "Production",
            "type": "ibm_cloud_kms"
          }
        }
      ],
      "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
    },
    {
      "id": "c2d8d0ee-c333-414f-8e64-af47320e5a46",
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "template": {
        "id": "2014f3ba-87ea-4125-aa9f-95141ede04cf",
        "name": "AWS-KMS-TEMPLATE"
      },
      "description": "AWS KMS key template description",
      "label": "AWS-KMS-KEY",
      "state": "active",
      "size": "256",
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method": "enc-zero",
          "value": "DDD779"
        }
      ],
      "activation_date": "2027-04-18",
      "expiration_date": "2028-06-29",
      "tags": [
        {
          "name": "first-tag",
          "value": "for-AWS-KMS"
        }
      ],
      "created_at": "2022-03-09T11:55:36Z",
      "updated_at": "2022-03-09T11:55:39Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "referenced_keystores": [],
      "instances": [
        {
          "id": "acf9af98-a459-4ef1-9c64-6cd987187cb5",
          "label_in_keystore": "AWS-KMS-KEY",
          "type": "secret_key",
          "keystore": {
            "group": "Production",
            "type": "aws_kms"
          }
        }
      ],
      "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/c2d8d0ee-c333-414f-8e64-af47320e5a46"
    }
  ]
}

hpcs uko managed-key-create

根据提供的模板创建新密钥。该模板必须存在于实例中，然后才能运行此命令。

ibmcloud hpcs uko managed-key-create --uko-vault UKO-VAULT --template-name TEMPLATE-NAME --vault VAULT --label LABEL [--tags TAGS] [--description DESCRIPTION]

命令选项

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索 UUID。

-- template-name (字符串)

必需。创建密钥时要使用的密钥模板的名称。长度必须在 1 到 30 个字符之间。该值必须与正则表达式 /^[A-Za-z][A-Za-z0-9-]+$/匹配。

-- vault (VaultReferenceInCreationRequest)

必需。要在其中创建受管密钥的保险库文件的标识。

-- label (字符串)

必需。密钥的标签。长度必须在 1 到 255 个字符之间。该值必须与正则表达式 /^[A-Za-z0-9._ \/-]+$/匹配。

-- tags ([Tag \ ])

可选。与密钥关联的 "键/值" 对。长度必须介于 0 与 128 项之间。

--description (字符串)

可选。受管密钥的描述。长度必须在 0 到 200 个字符之间。该值必须与正则表达式 /(.|\\n)*/匹配。

示例

ibmcloud hpcs uko managed-key-create \
  --uko-vault=5295ad47-2ce9-43c3-b9e7-e5a9482c362b \
  --template-name=IBM-CLOUD-EXAMPLE-TEMPLATE \
  --vault='{"id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b"}' \
  --label='IBM CLOUD KEY' \
  --tags='[{"name": "first-tag", "value": "for-IBM-CLOUD"}]' \
  --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-26T14:18:10Z
{
  "id": "3dab42dc-6941-4841-8d27-4dabcc5aa09e",
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "template": {
    "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
    "name": "IBM-CLOUD-EXAMPLE-TEMPLATE"
  },
  "description": "IBM CLOUD key template description",
  "label": "IBM CLOUD KEY",
  "state": "active",
  "size": "256",
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method": "enc-zero",
      "value": "DDFA4A"
    }
  ],
  "activation_date": "2027-04-18",
  "expiration_date": "2028-06-29",
  "tags": [
    {
      "name": "first-tag",
      "value": "for-ibm"
    }
  ],
  "created_at": "2022-03-09T11:26:01Z",
  "updated_at": "2022-03-09T11:26:04Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "referenced_keystores": [],
  "instances": [
    {
      "id": "ea7b6b27-d71b-4fe9-bbfe-309c7ca713a6",
      "label_in_keystore": "IBM CLOUD KEY",
      "type": "secret_key",
      "keystore": {
        "group": "Production",
        "type": "ibm_cloud_kms"
      }
    }
  ],
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
}

hpcs uko managed-key-delete

从保险库文件中按密钥标识删除受管密钥。在运行此命令之前，请确保密钥处于 已销毁 状态。

ibmcloud hpcs uko managed-key-delete --id ID --uko-vault UKO-VAULT --if-match IF-MATCH

命令选项

-- id (字符串)

必需。密钥的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 命令来检索密钥 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索保险库文件 UUID。

-- if-match (字符串)

必需。更新的前置条件，即 GET 请求的头中的 ETag 值。您可以使用 ibmcloud hpcs uko managed-key 命令来检索 ETag。

示例

ibmcloud hpcs uko managed-key-delete \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --uko-vault=eb66ebbd-7230-4cde-89bf-17282cda5faa \
  --if-match=2022-05-27T10:15:38Z

输出

该命令返回类似于以下示例的输出:
```
...
OK
```

hpcs uko 受管密钥

通过指定密钥标识来检索受管密钥及其详细信息。

ibmcloud hpcs uko managed-key --id ID --uko-vault UKO-VAULT

命令选项

-- id (字符串)

必需。密钥的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 命令来检索密钥 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索保险库文件 UUID。

示例

ibmcloud hpcs uko managed-key \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --uko-vault=eb66ebbd-7230-4cde-89bf-17282cda5faa \
  --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-26T14:18:10Z
{
  "id": "3dab42dc-6941-4841-8d27-4dabcc5aa09e",
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "template": {
    "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
    "name": "IBM-CLOUD-EXAMPLE-TEMPLATE"
  },
  "description": "IBM CLOUD key template description",
  "label": "IBM CLOUD KEY",
  "state": "active",
  "size": "256",
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method": "enc-zero",
      "value": "DDFA4A"
    }
  ],
  "activation_date": "2027-04-18",
  "expiration_date": "2028-06-29",
  "tags": [
    {
      "name": "first-tag",
      "value": "for-ibm"
    }
  ],
  "created_at": "2022-03-09T11:26:01Z",
  "updated_at": "2022-03-09T11:26:04Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "referenced_keystores": [],
  "instances": [
    {
      "id": "ea7b6b27-d71b-4fe9-bbfe-309c7ca713a6",
      "label_in_keystore": "IBM CLOUD KEY",
      "type": "secret_key",
      "keystore": {
        "group": "Production",
        "type": "ibm_cloud_kms"
      }
    }
  ],
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
}

hpcs uko managed-key-update

更新受管密钥的属性。您只能将密钥的状态与其他更改分开修改。更改密钥的状态会影响密钥库中加密操作的可用性。

ibmcloud hpcs uko managed-key-update --id ID --uko-vault UKO-VAULT --if-match IF-MATCH [--label LABEL] [--activation-date ACTIVATION-DATE] [--expiration-date EXPIRATION-DATE] [--tags TAGS] [--description DESCRIPTION]

命令选项

-- id (字符串)

必需。密钥的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 命令来检索密钥 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索保险库文件 UUID。

-- if-match (字符串)

必需。更新的前置条件，即 GET 请求的头中的 ETag 值。您可以使用 ibmcloud hpcs uko managed-key 命令来检索 ETag。

-- label (字符串)

必需。密钥的标签。长度必须在 1 到 255 个字符之间。该值必须与正则表达式 /^[A-Za-z0-9._ \/-]+$/匹配。

-- Activation-date (strfmt.Date)

可选。必须以格式 YYYY-MM-DD 提供激活日期。

-- expiration-date (strfmt.Date)

可选。必须以格式 YYYY-MM-DD 提供到期日期。

-- tags ([Tag \ ])

可选。与密钥关联的 "键/值" 对。长度必须介于 0 与 128 项之间。

--description (字符串)

可选。受管密钥的描述。长度必须在 0 到 200 个字符之间。该值必须与正则表达式 /(.|\\n)*/匹配。

示例

ibmcloud hpcs uko managed-key-update \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --uko-vault=eb66ebbd-7230-4cde-89bf-17282cda5faa \
  --if-match=2022-05-26T14:18:10Z \
  --description="updated description" \
  --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-26T14:26:39Z
{
  "id": "3dab42dc-6941-4841-8d27-4dabcc5aa09e",
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "template": {
    "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
    "name": "IBM-CLOUD-EXAMPLE-TEMPLATE"
  },
  "description": "IBM CLOUD key template description",
  "label": "IBM CLOUD KEY",
  "state": "active",
  "size": "256",
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method": "enc-zero",
      "value": "DDFA4A"
    }
  ],
  "activation_date": "2027-04-18",
  "expiration_date": "2028-06-29",
  "tags": [
    {
      "name": "first-tag",
      "value": "for-ibm"
    }
  ],
  "created_at": "2022-03-09T11:26:01Z",
  "updated_at": "2022-03-09T11:26:04Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "referenced_keystores": [],
  "instances": [
    {
      "id": "ea7b6b27-d71b-4fe9-bbfe-309c7ca713a6",
      "label_in_keystore": "IBM CLOUD KEY",
      "type": "secret_key",
      "keystore": {
        "group": "Production",
        "type": "ibm_cloud_kms"
      }
    }
  ],
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
}

hpcs uko 关联-resources-for-managed-key

获取与 IBM Cloud中的受管密钥关联的资源列表。这些云资源受您指定的密钥保护。

如果未设置 --all-pages 选项，那么该命令仅检索集合的单个页面。

ibmcloud hpcs uko associated-resources-for-managed-key --id ID --uko-vault UKO-VAULT [--limit LIMIT] [--offset OFFSET] [--sort SORT]

命令选项

-- id (字符串)

必需。密钥的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 命令来检索密钥 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索保险库文件 UUID。

-- limit (int64)

可选。要检索的资源数。该值必须介于 1 与 1000 之间。

-- offset (int64)

可选。要跳过的资源数。最小值为 0。

-- sort ([]字符串)

可选。排序顺序。缺省值为 ["name"]。列表项必须与正则表达式 /^-?[a-z0-9_.\\[\\],-]+$/匹配。

-- all-pages (bool)

可选。调用多个请求以显示关联资源的集合的所有页面。

示例

ibmcloud hpcs uko associated-resources-for-managed-key \
--id=93777bca-baef-4070-b9b5-a2e6079df1b4 \
--uko-vault=5295ad47-2ce9-43c3-b9e7-e5a9482c362b \
--output json

输出

该命令返回类似于以下示例的输出:

{
  "total_count": 3,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_key/5295ad47-2ce9-43c3-b9e7-e5a9482c362b/associated_resources?limit=20"
  },
  "last": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_key/5295ad47-2ce9-43c3-b9e7-e5a9482c362b/associated_resources?limit=20&offset=0"
  },
  "previous": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys?offset=80"
  },
  "next": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys?offset=120"
  },
  "associated_resources": [
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "managed_key": {
        "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
        "name": "My Managed Key",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "referenced_keystore": {
        "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
        "name": "My Managed Key",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "key_id_in_keystore": "93777bca-baef-4070-b9b5-a2e6079df1b4",
      "type": "com_ibm_cloud_kms_registration",
      "com_ibm_cloud_kms_registration": {
        "prevents_key_deletion": false,
        "service_name": "cloud-object-storage",
        "service_instance_name": "Cloud Object Storage-7s",
        "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/db995d8d9cc715cd99f13b0671d978b6:57da8e3a-a86d-4e01-b840-f22d36e6f23f:bucket:keyprotecttest",
        "description": "some description"
      }
    }
  ]
}

hpcs uko managed-key-ds

返回受管密钥的密钥库分发状态。

ibmcloud hpcs uko managed-key-ds --id ID --uko-vault UKO-VAULT

命令选项

-- id (字符串)

必需。密钥的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 命令来检索密钥 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索保险库文件 UUID。

示例

ibmcloud hpcs uko managed-key-ds \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --uko-vault=eb66ebbd-7230-4cde-89bf-17282cda5faa \
  --output json

输出

该命令返回类似于以下示例的输出:

{
  "status_in_keystores": [
    {
      "keystore": {
        "id": "b28bf13d-f49d-4b00-8b8d-457d38ad1e15",
        "name": "AWS KMS Keystore Name",
        "type": "aws_kms",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/keystores/b28bf13d-f49d-4b00-8b8d-457d38ad1e15"
      },
      "status": "not_present"
    }
  ]
}

hpcs uko managed-key-update-from-template

更新受管密钥以匹配最新版本的关联密钥模板。您可以在密钥模板定义的组中的目标密钥库上安装，激活或取消激活密钥。

ibmcloud hpcs uko managed-key-update-from-template --id ID --uko-vault UKO-VAULT --if-match IF-MATCH

命令选项

-- id (字符串)

必需。密钥的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 命令来检索密钥 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索保险库文件 UUID。

-- if-match (字符串)

必需。更新的前置条件，即 GET 请求的头中的 ETag 值。您可以使用 ibmcloud hpcs uko managed-key 命令来检索 ETag。

示例

ibmcloud hpcs uko managed-key-update-from-template \
  --id=22c04c00-0687-4f10-b0ac-b9f01d68ee85 \
  --uko-vault=eb66ebbd-7230-4cde-89bf-17282cda5faa \
  --if-match=2022-05-27T12:27:37Z \
  --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-27T12:29:46Z
{
  "id": "3dab42dc-6941-4841-8d27-4dabcc5aa09e",
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "template": {
    "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
    "name": "IBM-CLOUD-EXAMPLE-TEMPLATE"
  },
  "description": "IBM CLOUD key template description",
  "label": "IBM CLOUD KEY",
  "state": "active",
  "size": "256",
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method": "enc-zero",
      "value": "DDFA4A"
    }
  ],
  "activation_date": "2027-04-18",
  "expiration_date": "2028-06-29",
  "tags": [
    {
      "name": "first-tag",
      "value": "for-ibm"
    }
  ],
  "created_at": "2022-03-09T11:26:01Z",
  "updated_at": "2022-03-09T11:26:04Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "referenced_keystores": [],
  "instances": [
    {
      "id": "ea7b6b27-d71b-4fe9-bbfe-309c7ca713a6",
      "label_in_keystore": "IBM CLOUD KEY",
      "type": "secret_key",
      "keystore": {
        "group": "Production",
        "type": "ibm_cloud_kms"
      }
    }
  ],
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
}

hpcs uko managed-key-activate

激活受管密钥，并对与该受管密钥关联的密钥库组中的密钥库执行密钥安装或激活操作。

ibmcloud hpcs uko managed-key-activate --id ID --uko-vault UKO-VAULT --if-match IF-MATCH

命令选项

-- id (字符串)

必需。密钥的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 命令来检索密钥 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索保险库文件 UUID。

-- if-match (字符串)

必需。更新的前置条件，即 GET 请求的头中的 ETag 值。您可以使用 ibmcloud hpcs uko managed-key 命令来检索 ETag。

示例

ibmcloud hpcs uko managed-key-activate \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --uko-vault=eb66ebbd-7230-4cde-89bf-17282cda5faa \
  --if-match=2022-05-27T10:06:27Z \
  --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-27T10:11:06Z
{
  "id": "3dab42dc-6941-4841-8d27-4dabcc5aa09e",
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "template": {
    "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
    "name": "IBM-CLOUD-EXAMPLE-TEMPLATE"
  },
  "description": "IBM CLOUD key template description",
  "label": "IBM CLOUD KEY",
  "state": "active",
  "size": "256",
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method": "enc-zero",
      "value": "DDFA4A"
    }
  ],
  "activation_date": "2027-04-18",
  "expiration_date": "2028-06-29",
  "tags": [
    {
      "name": "first-tag",
      "value": "for-ibm"
    }
  ],
  "created_at": "2022-03-09T11:26:01Z",
  "updated_at": "2022-03-09T11:26:04Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "referenced_keystores": [],
  "instances": [
    {
      "id": "ea7b6b27-d71b-4fe9-bbfe-309c7ca713a6",
      "label_in_keystore": "IBM CLOUD KEY",
      "type": "secret_key",
      "keystore": {
        "group": "Production",
        "type": "ibm_cloud_kms"
      }
    }
  ],
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
}

hpcs uko managed-key-deactivate

取消激活受管密钥，并对与该受管密钥关联的密钥库组中的密钥库执行密钥取消激活操作。

ibmcloud hpcs uko managed-key-deactivate --id ID --uko-vault UKO-VAULT --if-match IF-MATCH

命令选项

-- id (字符串)

必需。密钥的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 命令来检索密钥 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索保险库文件 UUID。

-- if-match (字符串)

必需。更新的前置条件，即 GET 请求的头中的 ETag 值。您可以使用 ibmcloud hpcs uko managed-key 命令来检索 ETag。

示例

ibmcloud hpcs uko managed-key-deactivate \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --uko-vault=eb66ebbd-7230-4cde-89bf-17282cda5faa \
  --if-match=2022-05-27T10:13:31Z \
  --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-27T10:14:13Z
{
  "id": "3dab42dc-6941-4841-8d27-4dabcc5aa09e",
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "template": {
    "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
    "name": "IBM-CLOUD-EXAMPLE-TEMPLATE"
  },
  "description": "IBM CLOUD key template description",
  "label": "IBM CLOUD KEY",
  "state": "active",
  "size": "256",
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method": "enc-zero",
      "value": "DDFA4A"
    }
  ],
  "activation_date": "2027-04-18",
  "expiration_date": "2028-06-29",
  "tags": [
    {
      "name": "first-tag",
      "value": "for-ibm"
    }
  ],
  "created_at": "2022-03-09T11:26:01Z",
  "updated_at": "2022-03-09T11:26:04Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "referenced_keystores": [],
  "instances": [
    {
      "id": "ea7b6b27-d71b-4fe9-bbfe-309c7ca713a6",
      "label_in_keystore": "IBM CLOUD KEY",
      "type": "secret_key",
      "keystore": {
        "group": "Production",
        "type": "ibm_cloud_kms"
      }
    }
  ],
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
}

hpcs uko managed-key-destroy

销毁受管密钥并对与该受管密钥关联的密钥库组中的密钥库执行密钥销毁操作。此操作无法撤销。在运行此命令之前，请确保受管密钥处于 deactivated 状态。

ibmcloud hpcs uko managed-key-destroy --id ID --uko-vault UKO-VAULT --if-match IF-MATCH

命令选项

-- id (字符串)

必需。密钥的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 命令来检索密钥 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索保险库文件 UUID。

-- if-match (字符串)

必需。更新的前置条件，即 GET 请求的头中的 ETag 值。您可以使用 ibmcloud hpcs uko managed-key 命令来检索 ETag。

示例

ibmcloud hpcs uko managed-key-destroy \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --uko-vault=eb66ebbd-7230-4cde-89bf-17282cda5faa \
  --if-match=2022-05-27T10:14:13Z \
  --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-27T10:15:38Z
{
  "id": "3dab42dc-6941-4841-8d27-4dabcc5aa09e",
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "template": {
    "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
    "name": "IBM-CLOUD-EXAMPLE-TEMPLATE"
  },
  "description": "IBM CLOUD key template description",
  "label": "IBM CLOUD KEY",
  "state": "active",
  "size": "256",
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method": "enc-zero",
      "value": "DDFA4A"
    }
  ],
  "activation_date": "2027-04-18",
  "expiration_date": "2028-06-29",
  "tags": [
    {
      "name": "first-tag",
      "value": "for-ibm"
    }
  ],
  "created_at": "2022-03-09T11:26:01Z",
  "updated_at": "2022-03-09T11:26:04Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "referenced_keystores": [],
  "instances": [
    {
      "id": "ea7b6b27-d71b-4fe9-bbfe-309c7ca713a6",
      "label_in_keystore": "IBM CLOUD KEY",
      "type": "secret_key",
      "keystore": {
        "group": "Production",
        "type": "ibm_cloud_kms"
      }
    }
  ],
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
}

hpcs uko managed-key-sync

在密钥库中同步受管密钥。

ibmcloud hpcs uko managed-key-sync --id ID --uko-vault UKO-VAULT --if-match IF-MATCH

命令选项

-- id (字符串)

必需。密钥的 UUID。您可以使用 ibmcloud hpcs uko managed-keys 命令来检索密钥 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索保险库文件 UUID。

-- if-match (字符串)

必需。更新的前置条件，即 GET 请求的头中的 ETag 值。您可以使用 ibmcloud hpcs uko managed-key 命令来检索 ETag。

示例

ibmcloud hpcs uko managed-key-sync \
    --id=b28bf13d-f49d-4b00-8b8d-457d38ad1e15 \
    --uko-vault=eb66ebbd-7230-4cde-89bf-17282cda5faa \
    --if-match=2022-05-27T10:14:13Z \
    --output json

输出

该命令返回类似于以下示例的输出:

{
  "status_in_keystores": [
    {
      "keystore": {
        "id": "b28bf13d-f49d-4b00-8b8d-457d38ad1e15",
        "name": "AWS KMS Keystore Name",
        "type": "aws_kms",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/keystores/b28bf13d-f49d-4b00-8b8d-457d38ad1e15"
      },
      "status": "not_present"
    }
  ]
}

hpcs uko 密钥模板

列出实例中的所有密钥模板。

如果未设置 --all-pages 选项，那么该命令仅检索集合的单个页面。

ibmcloud hpcs uko key-templates [--vault-id VAULT-ID] [--key-algorithm KEY-ALGORITHM] [--sort SORT] [--limit LIMIT] [--offset OFFSET]

命令选项

-- vault-id (字符串)

可选。保险库文件的 UUID。长度必须为 36 个字符。该值必须与正则表达式 /^[-0-9a-z]+$/匹配。

-- key-algorithm (字符串)

可选。返回的密钥模板的算法。可以设置的值为 aes， rsa， hmac和 ec。

-- sort ([]字符串)

可选。排序顺序。缺省值为 ["-updated_at"]。列表项必须与正则表达式 /^-?[a-z0-9_.\\[\\],-]+$/匹配。

-- limit (int64)

可选。要检索的密钥模板数。该值必须介于 1 与 1000 之间。

-- offset (int64)

可选。要跳过的密钥数。最小值为 0。

-- all-pages (bool)

调用多个请求以显示密钥模板的集合的所有页面。

示例

ibmcloud hpcs uko key-templates --output json

输出

该命令返回类似于以下示例的输出:

{
  "total_count": 3,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/templates?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20"
  },
  "last": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/templates?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0"
  },
  "templates": [
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "id": "2014f3ba-87ea-4125-aa9f-95141ede04cf",
      "version": 0,
      "name": "AWS-KMS-TEMPLATE",
      "key": {
        "size": "256",
        "algorithm": "aes",
        "activation_date": "P5Y1M1W2D",
        "expiration_date": "P1Y2M1W4D",
        "state": "active"
      },
      "description": "AWS KMS key template description",
      "created_at": "2022-03-09T11:00:53Z",
      "updated_at": "2022-03-09T11:00:53Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "keystores": [
        {
          "group": "Production",
          "type": "aws_kms"
        }
      ],
      "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/templates/2014f3ba-87ea-4125-aa9f-95141ede04cf"
    },
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
      "version": 0,
      "name": "IBM-CLOUD-EXAMPLE-TEMPLATE",
      "key": {
        "size": "256",
        "algorithm": "aes",
        "activation_date": "P5Y1M1W2D",
        "expiration_date": "P1Y2M1W4D",
        "state": "active"
      },
      "description": "IBM CLOUD key template description",
      "created_at": "2022-03-09T11:00:47Z",
      "updated_at": "2022-03-09T11:00:47Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "keystores": [
        {
          "group": "Production",
          "type": "ibm_cloud_kms"
        }
      ],
      "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/templates/93777bca-baef-4070-b9b5-a2e6079df1b4"
    },
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "id": "4411f1ae-62cc-484e-9910-65d2e8f258bb",
      "version": 0,
      "name": "AZURE-EXAMPLE-TEMPLATE",
      "key": {
        "size": "2048",
        "algorithm": "rsa",
        "activation_date": "P5Y1M1W2D",
        "expiration_date": "P1Y2M1W4D",
        "state": "active"
      },
      "description": "AZURE key description",
      "created_at": "2022-03-09T11:00:40Z",
      "updated_at": "2022-03-09T11:00:40Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "keystores": [
        {
          "group": "Production",
          "type": "azure_key_vault"
        }
      ],
      "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/templates/4411f1ae-62cc-484e-9910-65d2e8f258bb"
    }
  ]
}

ibmcloud hpcs uko key-template-create

创建新的密钥模板。密钥模板用于组合创建密钥所需的信息。通过密钥模板，您可以轻松创建后续密钥，而无需指定任何详细信息。

ibmcloud hpcs uko key-template-create --uko-vault UKO-VAULT --vault VAULT --name NAME --key KEY --keystores KEYSTORES [--description DESCRIPTION]

命令选项

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko key-templates 命令来检索 UUID。

-- vault (VaultReferenceInCreationRequest)

必需。要在其中创建密钥模板的保险库文件的标识。

-- name (字符串)

必需。模板的名称。您需要在创建受管密钥时对其进行引用。长度必须在 1 到 30 个字符之间。该值必须与正则表达式 /^[A-Za-z][A-Za-z0-9-]*$/匹配。

-- key (KeyProperties)

必需。描述受管密钥的属性。

-- keystores ([KeystoresPropertiesCreate \ ])

必需。一个数组，用于描述要安装受管密钥的目标密钥库的类型和组。最大长度为 1 项。最小长度为 1 项。

--description (字符串)

可选。密钥模板的描述。长度必须在 0 到 200 个字符之间。该值必须与正则表达式 /(.|\\n)*/匹配。

示例

ibmcloud hpcs uko key-template-create \
    --uko-vault=5295ad47-2ce9-43c3-b9e7-e5a9482c362b \
    --vault='{"id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b"}' \
    --name=IBM-CLOUD-EXAMPLE-TEMPLATE \
    --key='{"size": "256", "algorithm": "aes", "activation_date": "P5Y1M1W2D", "expiration_date": "P1Y2M1W4D", "state": "active"}' \
    --keystores='[{"group": "Production", "type": "ibm_cloud_kms"}]' \
    --description="IBM CLOUD key template description" \
    --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-20T15:13:37Z
{
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "id": "ada4293c-07ed-4903-b3ee-419bd1a05fde",
  "version": 0,
  "name": "IBM-CLOUD-EXAMPLE-TEMPLATE",
  "key": {
    "size": "256",
    "algorithm": "aes",
    "activation_date": "P5Y1M1W2D",
    "expiration_date": "P1Y2M1W4D",
    "state": "active"
  },
  "description": "IBM CLOUD key template description",
  "created_at": "2022-03-09T15:40:52Z",
  "updated_at": "2022-03-09T15:40:52Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "keystores": [
    {
      "group": "Production",
      "type": "ibm_cloud_kms"
    }
  ],
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/templates/ada4293c-07ed-4903-b3ee-419bd1a05fde"
}

hpcs uko key-template-删除

从保险库文件中删除密钥模板。在运行此命令之前，请确保没有任何受管密钥与密钥模板相关联。

ibmcloud hpcs uko key-template-delete --id ID --uko-vault UKO-VAULT --if-match IF-MATCH

命令选项

-- id (字符串)

必需。模板的 UUID。您可以使用 ibmcloud hpcs uko key-templates 命令来检索 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko key-templates 命令来检索 UUID。

-- if-match (字符串)

必需。更新的前置条件，即 GET 请求的头中的 ETag 值。您可以使用 ibmcloud hpcs uko key-template 命令来检索 ETag。

示例

ibmcloud hpcs uko key-template-delete \
    --id=07b62c12-75a2-46c9-9259-0cecde3985d2 \
    --uko-vault=5295ad47-2ce9-43c3-b9e7-e5a9482c362b \
    --if-match=2022-05-11T14:58:26Z

输出

该命令返回类似于以下示例的输出:
```
...
OK
```

ibmcloud hpcs uko key-template

通过指定标识来检索密钥模板及其详细信息。

ibmcloud hpcs uko key-template --id ID --uko-vault UKO-VAULT

命令选项

-- id (字符串)

必需。模板的 UUID。您可以使用 ibmcloud hpcs uko key-templates 命令来检索 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko key-templates 命令来检索 UUID。

示例

ibmcloud hpcs uko key-template \
    --id=07b62c12-75a2-46c9-9259-0cecde3985d2 \
    --uko-vault=5295ad47-2ce9-43c3-b9e7-e5a9482c362b \
    --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-20T15:13:37Z
{
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "id": "ada4293c-07ed-4903-b3ee-419bd1a05fde",
  "version": 0,
  "name": "IBM-CLOUD-EXAMPLE-TEMPLATE",
  "key": {
    "size": "256",
    "algorithm": "aes",
    "activation_date": "P5Y1M1W2D",
    "expiration_date": "P1Y2M1W4D",
    "state": "active"
  },
  "description": "IBM CLOUD key template description",
  "created_at": "2022-03-09T15:40:52Z",
  "updated_at": "2022-03-09T15:40:52Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "keystores": [
    {
      "group": "Production",
      "type": "ibm_cloud_kms"
    }
  ],
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/templates/ada4293c-07ed-4903-b3ee-419bd1a05fde"
}

hpcs uko key-template-update

更新密钥模板的属性。

ibmcloud hpcs uko key-template-update --id ID --uko-vault UKO-VAULT --if-match IF-MATCH [--keystores KEYSTORES] [--description DESCRIPTION] [--key KEY]

命令选项

-- id (字符串)

必需。模板的 UUID。您可以使用 ibmcloud hpcs uko key-templates 命令来检索 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko key-templates 命令来检索 UUID。

-- if-match (字符串)

必需。更新的前置条件，即 GET 请求的头中的 ETag 值。您可以使用 ibmcloud hpcs uko key-template 命令来检索 ETag。

-- keystores ([KeystoresPropertiesUpdate \ ])

可选。一个数组，用于描述要安装受管密钥的目标密钥库的类型和组。最大长度为 1 项。最小长度为 1 项。

--description (字符串)

可选。密钥模板的更新描述。长度必须在 0 到 200 个字符之间。该值必须与正则表达式 /(.|\\n)*/匹配。

-- key (KeyProperties更新)

可选。受管密钥的属性。

示例

ibmcloud hpcs uko key-template-update \
  --id=07b62c12-75a2-46c9-9259-0cecde3985d2 \
  --uko-vault=5295ad47-2ce9-43c3-b9e7-e5a9482c362b \
  --if-match=2022-05-11T14:58:26Z \
  --description="The update of the template" \
  --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-20T15:20:06Z
{
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "id": "ada4293c-07ed-4903-b3ee-419bd1a05fde",
  "version": 0,
  "name": "IBM-CLOUD-EXAMPLE-TEMPLATE",
  "key": {
    "size": "256",
    "algorithm": "aes",
    "activation_date": "P5Y1M1W2D",
    "expiration_date": "P1Y2M1W4D",
    "state": "active"
  },
  "description": "IBM CLOUD key template description",
  "created_at": "2022-03-09T15:40:52Z",
  "updated_at": "2022-03-09T15:40:52Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "keystores": [
    {
      "group": "Production",
      "type": "ibm_cloud_kms"
    }
  ],
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/templates/ada4293c-07ed-4903-b3ee-419bd1a05fde"
}

hpcs uko 密钥库

列出实例中的所有目标密钥库。

如果未设置 --all-pages 选项，那么该命令仅检索集合的单个页面。

ibmcloud hpcs uko keystores [--type TYPE] [--name NAME] [--description DESCRIPTION] [--group GROUP] [--groups GROUPS] [--vault-id VAULT-ID] [--location LOCATION] [--limit LIMIT] [--offset OFFSET] [--sort SORT]

命令选项

-- type ([]字符串)

可选。要检索的密钥库的类型。可以设置的值为: aws_kms， azure_key_vault， ibm_cloud_kms和 google_kms。

-- name (字符串)

可选。仅返回其名称包含字符串的密钥库。长度必须在 1 到 100 个字符之间。该值必须与正则表达式 /.+/匹配。

--description (字符串)

可选。仅返回其描述包含字符串的密钥库。长度必须在 1 到 200 个字符之间。该值必须与正则表达式 /.+/匹配。

-- group (字符串)

可选。密钥库组。此查询参数不能与 groups[] 查询参数结合使用。

-- groups ([]字符串)

可选。密钥库组。

-- vault-id ([]字符串)

可选。保险库文件的 UUID。列表项必须与正则表达式 /^[-0-9a-z]+$/匹配。

-- location (字符串)

可选。密钥库位置。

-- limit (int64)

可选。要检索的密钥库数。该值必须介于 1 与 1000 之间。

-- offset (int64)

可选。要跳过的密钥数。最小值为 0。

-- sort ([]字符串)

可选。排序顺序。缺省值为 ["-updated_at"]。列表项必须与正则表达式 /^-?[a-z0-9_.\\[\\],-]+$/匹配。

--all-pages (bool)

可选。调用多个请求以显示密钥库集合的所有页面。

示例

ibmcloud hpcs uko keystores --output json

输出

该命令返回类似于以下示例的输出:

{
  "total_count": 3,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/keystores?limit=20"
  },
  "last": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/keystores?limit=20&offset=0"
  },
  "keystores": [
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "id": "5312861e-5b9b-4f40-9264-997afc2cd034",
      "name": "AWS KMS Keystore Name",
      "description": "AWS KMS keystore",
      "groups": [
        "Production-UK",
        "Production-DE"
      ],
      "type": "aws_kms",
      "created_at": "2022-03-09T10:59:44Z",
      "updated_at": "2022-03-09T10:59:44Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/keystores/5312861e-5b9b-4f40-9264-997afc2cd034",
      "aws_region": "eu_central_1",
      "aws_access_key_id": "",
      "aws_secret_access_key": ""
    },
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "id": "314d0c9c-8808-47f0-829a-e63bdbb93854",
      "name": "Azure Keystore Name ",
      "description": "The AZURE keystore for testing.",
      "groups": [
        "Azure Keystore Name "
      ],
      "type": "azure_key_vault",
      "created_at": "2022-03-09T11:00:04Z",
      "updated_at": "2022-03-09T11:00:04Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/keystores/314d0c9c-8808-47f0-829a-e63bdbb93854",
      "azure_resource_group": "EKMF-Web-Tests",
      "azure_location": "europe_north",
      "azure_service_principal_client_id": "c8e8540f-4f15-4b6b-8862-3ccdb389e35d",
      "azure_service_principal_password": "***",
      "azure_tenant": "fcf67057-50c9-4ad4-98f3-ffca64add9e9",
      "azure_subscription_id": "a9867d9b-582f-42f3-9392-26856b06b808",
      "azure_environment": "azure"
    },
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "id": "f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
      "name": "IBM Keystore Name",
      "description": "The description of the created keystore.",
      "groups": [
        "IBM Keystore Name"
      ],
      "type": "ibm_cloud_kms",
      "created_at": "2022-03-09T11:00:11Z",
      "updated_at": "2022-03-09T11:00:11Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/keystores/f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
      "ibm_api_endpoint": "https://us-south.kms.cloud.ibm.com",
      "ibm_iam_endpoint": "https://iam.bluemix.net/identity/token",
      "ibm_api_key": "",
      "ibm_instance_id": "d139ea58-a073-441b-ba4e-dcc8bae58be4",
      "ibm_variant": "hpcs",
      "ibm_key_ring": "IBM-Cloud-KMS-Internal"
    }
  ]
}

ibmcloud hpcs uko 密钥库-创建

创建内部密钥库或连接到所请求类型的外部密钥库。如果使用 dry_run 查询参数，那么不会在数据库中创建密钥库，并且仅执行测试以验证连接信息是否正确。可以按以下参数进行排序: name， created_at， updated_at和 vault.id。

ibmcloud hpcs uko keystore-create --uko-vault UKO-VAULT --keystore-body KEYSTORE-BODY [--dry-run DRY-RUN]

命令选项

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko keystores 命令来检索 UUID。

-- keystore-body (KeystoreCreation请求)

必需。要创建或连接到的密钥库的属性。

--dry-run (bool)

可选。执行测试以验证是否可以成功地与使用给定参数创建的密钥库通信。未在数据库中创建任何密钥库。缺省值为 false。

示例

ibmcloud hpcs uko keystore-create \
    --uko-vault=75d0f626-44b0-4076-80cd-8cb9e485fe73 \
    --keystore-body='{"type": "aws_kms", "vault": {"id": "75d0f626-44b0-4076-80cd-8cb9e485fe73"}, "name": "AWS KMS Keystore", "description": "AWS KMS Keystore", "groups": ["Production", "Production-DE"], "aws_access_key_id": "HSNGYJMKHGFFF", "aws_secret_access_key": "JHGSY766YUG67GFV", "aws_region": "eu_central_1"}' \
    --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-20T14:52:18Z
{
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "id": "f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
  "name": "IBM Keystore Name",
  "description": "The description of the created keystore.",
  "groups": [
    "IBM Keystore Name"
  ],
  "type": "ibm_cloud_kms",
  "created_at": "2022-03-09T11:00:11Z",
  "updated_at": "2022-03-09T11:00:11Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/keystores/f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
  "ibm_api_endpoint": "https://us-south.kms.cloud.ibm.com",
  "ibm_iam_endpoint": "https://iam.bluemix.net/identity/token",
  "ibm_api_key": "",
  "ibm_instance_id": "d139ea58-a073-441b-ba4e-dcc8bae58be4",
  "ibm_variant": "hpcs",
  "ibm_key_ring": "IBM-Cloud-KMS-Internal"
}

hpcs uko 密钥库-删除

删除内部密钥库或除去与外部密钥库的连接。除去连接后，远程平台上的外部密钥库仍然存在。

ibmcloud hpcs uko keystore-delete --id ID --uko-vault UKO-VAULT --if-match IF-MATCH

命令选项

-- id (字符串)

必需。密钥库的 UUID。您可以使用 ibmcloud hpcs uko keystores 命令来检索 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko keystores 命令来检索 UUID。

-- if-match (字符串)

必需。更新的前置条件，即 GET 请求的头中的 ETag 值。您可以使用 ibmcloud hpcs uko keystore 命令来检索 ETag。

示例

ibmcloud hpcs uko keystore-delete \
    --id=0325e05e-2b25-4f13-85b2-2d7f85e54359 \
    --uko-vault=5295ad47-2ce9-43c3-b9e7-e5a9482c362b \
    --if-match=2022-05-11T14:58:26Z

输出

该命令返回类似于以下示例的输出:
```
...
OK
```

hpcs uko 密钥库

通过指定标识来检索目标内部密钥库或外部密钥库连接及其详细信息。

ibmcloud hpcs uko keystore --id ID --uko-vault UKO-VAULT

命令选项

-- id (字符串)

必需。密钥库的 UUID。您可以使用 ibmcloud hpcs uko keystores 命令来检索 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko keystores 命令来检索 UUID。

示例

ibmcloud hpcs uko keystore \
    --id=0325e05e-2b25-4f13-85b2-2d7f85e54359 \
    --uko-vault=5295ad47-2ce9-43c3-b9e7-e5a9482c362b \
    --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-20T14:59:03Z
{
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "id": "f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
  "name": "IBM Keystore Name",
  "description": "The description of the created keystore.",
  "groups": [
    "IBM Keystore Name"
  ],
  "type": "ibm_cloud_kms",
  "created_at": "2022-03-09T11:00:11Z",
  "updated_at": "2022-03-09T11:00:11Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/keystores/f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
  "ibm_api_endpoint": "https://us-south.kms.cloud.ibm.com",
  "ibm_iam_endpoint": "https://iam.bluemix.net/identity/token",
  "ibm_api_key": "",
  "ibm_instance_id": "d139ea58-a073-441b-ba4e-dcc8bae58be4",
  "ibm_variant": "hpcs",
  "ibm_key_ring": "IBM-Cloud-KMS-Internal"
}

ibmcloud hpcs uko keystore-更新

更新内部密钥库或外部密钥库连接的属性。

ibmcloud hpcs uko keystore-update --id ID --uko-vault UKO-VAULT --if-match IF-MATCH --keystore-body KEYSTORE-BODY

命令选项

-- id (字符串)

必需。密钥库的 UUID。您可以使用 ibmcloud hpcs uko keystores 命令来检索 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko keystores 命令来检索 UUID。

-- if-match (字符串)

必需。更新的前置条件，即 GET 请求的头中的 ETag 值。您可以使用 ibmcloud hpcs uko keystore 命令来检索 ETag。

-- keystore-body (KeystoreUpdate请求)

必需。要更新的密钥库属性。

示例

ibmcloud hpcs uko keystore-update \
    --id=0325e05e-2b25-4f13-85b2-2d7f85e54359 \
    --uko-vault=5295ad47-2ce9-43c3-b9e7-e5a9482c362b \
    --if-match=2022-05-11T14:58:26Z \
    --keystore-body='{"description": "Updated description", "keystore_type": "aws_kms"}' \
    --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-20T14:59:03Z
{
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "id": "f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
  "name": "IBM Keystore Name",
  "description": "The description of the created keystore.",
  "groups": [
    "IBM Keystore Name"
  ],
  "type": "ibm_cloud_kms",
  "created_at": "2022-03-09T11:00:11Z",
  "updated_at": "2022-03-09T11:00:11Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/keystores/f6a5ccc1-7fc3-435e-9637-482e470ba8e8",
  "ibm_api_endpoint": "https://us-south.kms.cloud.ibm.com",
  "ibm_iam_endpoint": "https://iam.bluemix.net/identity/token",
  "ibm_api_key": "",
  "ibm_instance_id": "d139ea58-a073-441b-ba4e-dcc8bae58be4",
  "ibm_variant": "hpcs",
  "ibm_key_ring": "IBM-Cloud-KMS-Internal"
}

hpcs uko 关联-resources-for-target-keystore

获取与此密钥库中激活的所有密钥相关联的资源的列表。

如果未设置 --all-pages 选项，那么该命令仅检索集合的单个页面。

ibmcloud hpcs uko associated-resources-for-target-keystore --id ID --uko-vault UKO-VAULT [--limit LIMIT] [--offset OFFSET] [--sort SORT]

命令选项

-- id (字符串)

必需。密钥库的 UUID。您可以使用 ibmcloud hpcs uko keystores 命令来检索 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索保险库文件 UUID。

-- limit (int64)

可选。要检索的资源数。该值必须介于 1 与 1000 之间。

-- offset (int64)

可选。要跳过的资源数。最小值为 0。

-- sort ([]字符串)

可选。排序顺序。缺省值为 ["name"]。列表项必须与正则表达式 /^-?[a-z0-9_.\\[\\],-]+$/匹配。

-- all-pages (bool)

可选。调用多个请求以显示目标密钥库的关联资源的集合的所有页面。

示例

ibmcloud hpcs uko associated-resources-for-target-keystore \
--id=93777bca-baef-4070-b9b5-a2e6079df1b4 \
--uko-vault=5295ad47-2ce9-43c3-b9e7-e5a9482c362b \
--output json

输出

该命令返回类似于以下示例的输出:

{
  "total_count": 3,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_key/5295ad47-2ce9-43c3-b9e7-e5a9482c362b/associated_resources?limit=20"
  },
  "last": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_key/5295ad47-2ce9-43c3-b9e7-e5a9482c362b/associated_resources?limit=20&offset=0"
  },
  "previous": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys?offset=80"
  },
  "next": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys?offset=120"
  },
  "associated_resources": [
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "managed_key": {
        "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
        "name": "My Managed Key",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "referenced_keystore": {
        "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
        "name": "My Managed Key",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "key_id_in_keystore": "93777bca-baef-4070-b9b5-a2e6079df1b4",
      "type": "com_ibm_cloud_kms_registration",
      "com_ibm_cloud_kms_registration": {
        "prevents_key_deletion": false,
        "service_name": "cloud-object-storage",
        "service_instance_name": "Cloud Object Storage-7s",
        "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/db995d8d9cc715cd99f13b0671d978b6:57da8e3a-a86d-4e01-b840-f22d36e6f23f:bucket:keyprotecttest",
        "description": "some description"
      }
    }
  ]
}

hpcs uko 密钥库-状态

检索目标内部或外部密钥库的状态。

ibmcloud hpcs uko keystore-status --id ID --uko-vault UKO-VAULT

命令选项

-- id (字符串)

必需。密钥库的 UUID。您可以使用 ibmcloud hpcs uko keystores 命令来检索 UUID。

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko keystores 命令来检索 UUID。

示例

ibmcloud hpcs uko keystore-status \
    --id=0325e05e-2b25-4f13-85b2-2d7f85e54359 \
    --uko-vault=5295ad47-2ce9-43c3-b9e7-e5a9482c362b \
    --output json

输出

该命令返回类似于以下示例的输出:

{
  "last_heartbeat": "2022-01-26T00:56:01Z",
  "health_status": "ok",
  "message": "Ping executed successfully."
}

hpcs uko managed-keys-from-keystore

列出目标密钥库中激活的所有受管密钥。

如果未设置 --all-pages 选项，那么该命令仅检索集合的单个页面。

ibmcloud hpcs uko managed-keys-from-keystore --uko-vault UKO-VAULT --id ID [--algorithm ALGORITHM] [--state STATE] [--limit LIMIT] [--offset OFFSET] [--sort SORT] [--label LABEL] [--activation-date ACTIVATION-DATE] [--activation-date-min ACTIVATION-DATE-MIN] [--activation-date-max ACTIVATION-DATE-MAX] [--deactivation-date DEACTIVATION-DATE] [--deactivation-date-min DEACTIVATION-DATE-MIN] [--deactivation-date-max DEACTIVATION-DATE-MAX] [--expiration-date EXPIRATION-DATE] [--expiration-date-min EXPIRATION-DATE-MIN] [--expiration-date-max EXPIRATION-DATE-MAX] [--created-at CREATED-AT] [--created-at-min CREATED-AT-MIN] [--created-at-max CREATED-AT-MAX] [--updated-at UPDATED-AT] [--updated-at-min UPDATED-AT-MIN] [--updated-at-max UPDATED-AT-MAX] [--size SIZE] [--size-min SIZE-MIN] [--size-max SIZE-MAX]

命令选项

-- uko-vault (字符串)

必需。要进行更新的保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索 UUID。

-- id (字符串)

必需。密钥库的 UUID。您可以使用 ibmcloud hpcs uko keystores 命令来检索 UUID。

-- algorithm (字符串)

可选。返回的密钥的算法。可以设置的值为 aes， rsa， hmac和 ec。

-- state (字符串)

可选。返回的密钥将处于的状态。缺省值为 ["pre_activation","active"]。可以设置的值为: pre_activation， active， deactivated和 destroyed。

-- limit (int64)

可选。要检索的密钥数。该值必须介于 1 与 1000 之间。

-- offset (int64)

可选。要跳过的密钥数。最小值为 0。

-- sort ([]字符串)

可选。排序顺序。缺省值为 ["-updated_at"]。列表项必须与正则表达式 /^-?[a-z0-9_.\\[\\],-]+$/匹配。

-- label (字符串)

可选。密钥的标签。该值必须与正则表达式 /.+/匹配。

-- Activation-date (字符串)

可选。仅返回其激活日期与参数匹配的受管密钥。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--Activation-date-min (字符串)

可选。仅返回其激活日期等于或晚于参数值的受管密钥。此查询参数不能与 activation_date 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--Activation-date-max (字符串)

可选。仅返回其激活日期等于或早于参数值的受管密钥。此查询参数不能与 activation_date 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--deactivation-date (字符串)

可选。仅返回其取消激活日期与参数匹配的受管密钥。此查询参数不能与 expiration_date 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--deActivation-date-min (字符串)

可选。仅返回其取消激活日期等于或晚于参数值的受管密钥。此查询参数不能与 deactivation_date， expiration_date， expiration_date_min和 expiration_date_max 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--deActivation-date-max (字符串)

可选。仅返回其取消激活日期等于或早于参数值的受管密钥。此查询参数不能与 deactivation_date， expiration_date， expiration_date_min和 expiration_date_max 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

-- expiration-date (字符串)

可选。仅返回其取消激活日期与参数匹配的受管密钥。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--expiration-date-min (字符串)

可选。仅返回其取消激活日期等于或晚于参数值的受管密钥。此查询参数不能与 deactivation_date， expiration_date， deactivation_date_min和 deactivation_date_max 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--expiration-date-max (字符串)

可选。仅返回其取消激活日期等于或早于参数值的受管密钥。此查询参数不能与 deactivation_date， expiration_date， deactivation_date_min和 deactivation_date_max 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

-- created-at (字符串)

可选。仅返回创建时间与参数匹配的受管密钥。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--created-at-min (字符串)

可选。仅返回创建时间等于或晚于参数值的受管密钥。此查询参数不能与 created_at 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--created-at-max (字符串)

可选。仅返回创建时间在参数值或之前的受管密钥。此查询参数不能与 created_at 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

-- updated-at (字符串)

可选。仅返回更新时间与参数匹配的受管密钥。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--updated-at-min (字符串)

可选。仅返回更新时间在参数值之后的受管密钥。此查询参数不能与 updated_at 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

--updated-at-max (字符串)

可选。仅返回更新时间在参数值之前的受管密钥。此查询参数不能与 updated_at 查询参数结合使用。该值必须与正则表达式 /[0-9]{4}-[0-9]{2}-[0-9]{2}/匹配。

-- size (int64)

可选。密钥的大小。

-- size-min (int64)

可选。密钥的最小大小。此查询参数不能与 size 查询参数结合使用。

-- size-max (int64)

可选。密钥的最大大小。此查询参数不能与 size 查询参数结合使用。

-- all-pages (bool)

可选。调用多个请求以显示受管密钥的集合的所有页面。

示例

ibmcloud hpcs uko managed-keys-from-keystore \
  --uko-vault=eb66ebbd-7230-4cde-89bf-17282cda5faa \
  --id=f779c44d-b90e-4917-b8b0-28d4591fefda \
  --output json

输出

该命令返回类似于以下示例的输出:

{
  "total_count": 3,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0"
  },
  "last": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0"
  },
  "managed_keys": [
    {
      "id": "8cacc6c9-a4ac-43b7-88c0-cf94765f4bf9",
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "template": {
        "id": "4411f1ae-62cc-484e-9910-65d2e8f258bb",
        "name": "Azure-Example"
      },
      "description": "Azure key description",
      "label": "AZURE-EXAMPLE-KEY",
      "state": "active",
      "size": "2048",
      "algorithm": "rsa",
      "verification_patterns": [
        {
          "method": "PUB-HASH-SHA-1",
          "value": "9EBB4E22E6926F1F6B39EF5126B0F603D821D4D0"
        }
      ],
      "activation_date": "2027-04-18",
      "expiration_date": "2028-06-29",
      "tags": [
        {
          "name": "first-tag",
          "value": "in-Azure"
        }
      ],
      "created_at": "2022-03-09T11:37:24Z",
      "updated_at": "2022-03-09T11:37:27Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "referenced_keystores": [],
      "instances": [
        {
          "id": "3235c1b2-c62b-46e8-a5ce-acd7a8b2c52e",
          "label_in_keystore": "AZURE-EXAMPLE-KEY",
          "keystore": {
            "group": "Production",
            "type": "azure_key_vault"
          }
        }
      ],
      "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/8cacc6c9-a4ac-43b7-88c0-cf94765f4bf9"
    },
    {
      "id": "3dab42dc-6941-4841-8d27-4dabcc5aa09e",
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "template": {
        "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
        "name": "IBM-CLOUD-EXAMPLE-TEMPLATE"
      },
      "description": "IBM CLOUD key template description",
      "label": "IBM CLOUD KEY",
      "state": "active",
      "size": "256",
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method": "enc-zer",
          "value": "DDFA4A"
        }
      ],
      "activation_date": "2027-04-18",
      "expiration_date": "2028-06-29",
      "tags": [
        {
          "name": "first-tag",
          "value": "for-ibm"
        }
      ],
      "created_at": "2022-03-09T11:26:01Z",
      "updated_at": "2022-03-09T11:26:04Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "referenced_keystores": [],
      "instances": [
        {
          "id": "ea7b6b27-d71b-4fe9-bbfe-309c7ca713a6",
          "label_in_keystore": "IBM CLOUD KEY",
          "type": "secret_key",
          "keystore": {
            "group": "Production",
            "type": "ibm_cloud_kms"
          }
        }
      ],
      "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
    },
    {
      "id": "c2d8d0ee-c333-414f-8e64-af47320e5a46",
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "template": {
        "id": "2014f3ba-87ea-4125-aa9f-95141ede04cf",
        "name": "AWS-KMS-TEMPLATE"
      },
      "description": "AWS KMS key template description",
      "label": "AWS-KMS-KEY",
      "state": "active",
      "size": "256",
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method": "enc-zero",
          "value": "DDD779"
        }
      ],
      "activation_date": "2027-04-18",
      "expiration_date": "2028-06-29",
      "tags": [
        {
          "name": "first-tag",
          "value": "for-AWS-KMS"
        }
      ],
      "created_at": "2022-03-09T11:55:36Z",
      "updated_at": "2022-03-09T11:55:39Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "referenced_keystores": [],
      "instances": [
        {
          "id": "acf9af98-a459-4ef1-9c64-6cd987187cb5",
          "label_in_keystore": "AWS-KMS-KEY",
          "type": "secret_key",
          "keystore": {
            "group": "Production",
            "type": "aws_kms"
          }
        }
      ],
      "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/managed_keys/c2d8d0ee-c333-414f-8e64-af47320e5a46"
    }
  ]
}

hpcs uko 保险库文件

列出实例中的所有保险库文件。

如果未设置 --all-pages 选项，那么该命令仅检索集合的单个页面。

ibmcloud hpcs uko vaults [--limit LIMIT] [--offset OFFSET] [--sort SORT] [--name NAME] [--description DESCRIPTION]

命令选项

-- limit (int64)

可选。要检索的保险库文件数。最大值为 1000。最小值为 1。

-- offset (int64)

可选。要跳过的保险库文件数。最小值为 0。

-- sort ([]字符串)

可选。排序顺序。缺省值为 ["-updated_at"]。列表项必须与正则表达式 /^-?[a-z0-9_.\\[\\],-]+$/匹配。

-- name (字符串)

可选。仅返回名称以字符串开头的保险库文件。长度必须在 1 到 100 个字符之间。该值必须与正则表达式 /.+/匹配。

--description (字符串)

可选。仅返回其描述包含字符串的保险库文件。长度必须在 1 到 200 个字符之间。该值必须与正则表达式 /.+/匹配。

-- all-pages (bool)

可选。调用多个请求以显示保险库文件集合的所有页面。
示例
```
ibmcloud hpcs uko vaults --output json
```

输出

该命令返回类似于以下示例的输出:

{
  "total_count": 2,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults?limit=20&limit=20&offset=0"
  },
  "last": {
    "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults?limit=20&limit=20&offset=0&offset=0"
  },
  "vaults": [
    {
      "id": "d0564770-1422-420c-945f-10803a2e24de",
      "name": "EXAMPLE_VAULT_NAME",
      "description": "API Test Vault description update.",
      "created_on": "2022-03-07T09:39:17Z",
      "updated_on": "2022-03-07T14:31:09Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/d0564770-1422-420c-945f-10803a2e24de"
    },
    {
      "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
      "name": "Test Vault Name",
      "description": "'Test Vault Name' description.",
      "created_at": "2022-03-09T10:57:43Z",
      "updated_at": "2022-03-09T10:57:43Z",
      "created_by": "IBMid-1308197YB4",
      "updated_by": "IBMid-1308197YB4",
      "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
    }
  ]
}

hpcs uko 保险库-创建

在实例中创建具有指定名称和描述的保险库文件。

ibmcloud hpcs uko vault-create --name NAME [--description DESCRIPTION]

命令选项

-- name (字符串)

必需。要分配给保险库的人类可读名称。为保护您的隐私，请勿使用个人数据，如您的姓名或位置。长度必须在 1 到 100 个字符之间。该值必须与正则表达式 /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/匹配。

--description (字符串)

可选。保险库文件的描述。长度必须在 0 到 200 个字符之间。该值必须与正则表达式 /(.|\\n)*/匹配。

示例

ibmcloud hpcs uko vault-create \
    --name='Example Vault' \
    --description='The description of the creating vault' \
    --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-20T15:27:01Z
{
  "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
  "name": "Test Vault Name",
  "description": "Test Vault Name description.",
  "created_at": "2022-03-09T10:57:43Z",
  "updated_at": "2022-03-09T10:57:43Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
}

hpcs uko 保险库文件-删除

从实例中删除保险库文件。在运行此命令之前，请确保没有密钥或密钥库附加到保险库文件。

ibmcloud hpcs uko vault-delete --id ID --if-match IF-MATCH

命令选项

-- id (字符串)

必需。保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索 UUID。

-- if-match (字符串)

必需。更新的前置条件，即 GET 请求的头中的 ETag 值。您可以使用 ibmcloud hpcs uko vault 命令来检索 ETag。

示例

ibmcloud hpcs uko vault-delete \
    --id=a88f6e06-c903-4b9f-8ee0-45bd817bf1b6 \
    --if-match=2022-05-11T14:58:26Z

输出

该命令返回类似于以下示例的输出:
```
...
OK
```

hpcs uko 保险库文件

通过指定标识来检索保险库文件及其详细信息。

ibmcloud hpcs uko vault --id ID

命令选项

-- id (字符串)

必需。保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索 UUID。

示例

ibmcloud hpcs uko vault \
    --id=06ce6d7e-9edb-431b-8a96-e88e8a4b266b \
    --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-20T15:30:40Z
{
  "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
  "name": "Test Vault Name",
  "description": "'Test Vault Name' description.",
  "created_at": "2022-03-09T10:57:43Z",
  "updated_at": "2022-03-09T10:57:43Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
}

hpcs uko 保险库-更新

更新保险库文件的属性。

ibmcloud hpcs uko vault-update --id ID --if-match IF-MATCH [--name NAME] [--description DESCRIPTION]

命令选项

-- id (字符串)

必需。保险库文件的 UUID。您可以使用 ibmcloud hpcs uko vaults 命令来检索 UUID。

-- if-match (字符串)

必需。更新的前置条件，即 GET 请求的头中的 ETag 值。您可以使用 ibmcloud hpcs uko vault 命令来检索 ETag。

-- name (字符串)

可选。更新了 vault.The 长度必须在 1 到 100 个字符之间。该值必须与正则表达式 /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/匹配。

--description (字符串)

可选。已更新保险库文件的描述。长度必须在 0 到 200 个字符之间。该值必须与正则表达式 /(.|\\n)*/匹配。

示例

ibmcloud hpcs uko vault-update \
  --id=06ce6d7e-9edb-431b-8a96-e88e8a4b266b \
  --if-match=2022-05-11T14:58:26Z \
  --description='Updated description of the vault' \
  --name="Jakub's Vault" \
  --output json

输出

该命令返回类似于以下示例的输出:

ETag
2022-05-20T15:27:01Z
{
  "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
  "name": "Test Vault Name",
  "description": "'Test Vault Name' description.",
  "created_at": "2022-03-09T10:57:43Z",
  "updated_at": "2022-03-09T10:57:43Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "href": "https://uko.us-south.hs-crypto.cloud.ibm.com:9549/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
}

Unified Key Orchestrator CLI 插件命令模式示例

以下模式示例表示需要为某些命令选项指定的数据。这些示例显示数据结构，并包含期望值类型的占位符值。运行命令时，请根据需要将这些值替换为适用于您的环境的值。

KeyProperties

以下示例显示了 KeyProperties 对象的格式。

{
  "size" : "256",
  "algorithm" : "aes",
  "activation_date" : "P5Y1M1W2D",
  "expiration_date" : "P1Y2M1W4D",
  "state" : "active"
}

KeyProperties更新

以下示例显示了 KeyPropertiesUpdate 对象的格式。

{
  "size" : "256",
  "activation_date" : "P5Y1M1W2D",
  "expiration_date" : "P1Y2M1W4D",
  "state" : "active"
}

KeystoreCreation请求

以下示例显示了 KeystoreCreationRequest 对象的格式。

{
  "type" : "aws_kms",
  "vault" : {
    "id" : "5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
  },
  "name" : "IBM Cloud Keystore Name",
  "description" : "Azure keystore",
  "groups" : [ "Production" ],
  "aws_region" : "af_south_1",
  "aws_access_key_id" : "BSDFWERUANLKJDN54AAS",
  "aws_secret_access_key" : "6HSz234KBjMrASFasfg5PasAFGNasg87asdgQzgs"
}

KeystoreUpdate请求

以下示例显示了 KeystoreUpdateRequest 对象的格式。

{
  "name" : "IBM Cloud Keystore Name",
  "description" : "Azure keystore",
  "groups" : [ "Production" ],
  "google_credentials" : "eyJleGFtcGxlIjogImdvb2dsZV9jbG91ZF9rbXMifQo=",
  "google_location" : "europe-central2",
  "google_key_ring" : "my-key-ring"
}

KeystoresProperties创建[]

以下示例显示了 KeystoresPropertiesCreate[] 对象的格式。


[ {
  "group" : "Production",
  "type" : "ibm_cloud_kms",
  "google_key_protection_level" : "software",
  "google_key_purpose" : "encrypt_decrypt",
  "google_kms_algorithm" : "google_symmetric_encryption"
} ]

KeystoresProperties更新[]

以下示例显示了 KeystoresPropertiesUpdate[] 对象的格式。

[ {
  "group" : "Production",
  "google_key_protection_level" : "software",
  "google_key_purpose" : "encrypt_decrypt",
  "google_kms_algorithm" : "google_symmetric_encryption"
} ]

标记[]

以下示例显示了 Tag[] 对象的格式。

[ {
  "name" : "exampleString",
  "value" : "exampleString"
} ]

VaultReferenceInCreation请求

以下示例显示了 VaultReferenceInCreationRequest 对象的格式。

{
  "id" : "5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
}