CLI de IBM Cloud de Hyper Protect Crypto Services

Hyper Protect Crypto Services proporciona varios plugins de CLI de IBM Cloud® para que realice acciones en las instancias de servicio: plugin de CLI de gestión de claves, plugin de CLI de Trusted Key Entry (TKE), plugin de CLI de gestor de certificados y plugin de CLI de Unified Key Orchestrator (UKO).

Plugin de la CLI de gestión de claves de Hyper Protect Crypto Services

Hyper Protect Crypto Services se integra con el plugin de CLI Key Protect para que pueda utilizar el plugin de CLI Key Protect para gestionar claves raíz y claves estándar en las instancias de Hyper Protect Crypto Services.

Para obtener información sobre cómo configurar el plugin de la CLI de Key Protect para Hyper Protect Crypto Services, consulte Realización de operaciones de gestión de claves con la CLI.
Para obtener la referencia completa de la CLI de gestión de claves, consulte Key Protect Referencia de mandatos de CLI.

Plugin de la CLI de Trusted Key Entry de Hyper Protect Crypto Services

Puede utilizar el plugin de la CLI de TKE para gestionar unidades criptográficas asignadas a su cuenta.

Instalación del plugin de la CLI TKE

Para instalar el plugin de la CLI TKE, siga estos pasos:

Instale la CLI de IBM Cloud.

La CLI de IBM Cloud requiere Java™ 1.8.0. El prefijo para ejecutar mandatos mediante la CLI de IBM Cloud es ibmcloud.
Instale el plugin TKE más reciente con el mandato siguiente:
```
ibmcloud plugin install tke
```
Se le notificará en la línea de mandatos cuándo están disponibles las actualizaciones de la CLI de IBM Cloud y los plugins. Asegúrese de que mantiene actualizada la CLI para poder utilizar los mandatos más recientes. Puede ver la versión actual de todos los plugins instalados con el mandato ibmcloud plugin list.
Establezca la variable de entorno CLOUDTKEFILES en la estación de trabajo. Especifique un directorio en el que desea que se creen y salven los archivos de estación de trabajo y los archivos de estación de trabajo de firma. Cree el directorio si no existe.
- En el sistema operativo Linux™ o MacOS, añada la línea siguiente al archivo .bash_profile :
```
export CLOUDTKEFILES=<path>
```
  Por ejemplo, puede especificar el valor de vía_acceso como /Users/tke-files.
- En el sistema operativo Windows™ , en Panel de control, escriba environment variable en el recuadro de búsqueda para localizar la ventana Variables de entorno. Cree una variable de entorno CLOUDTKEFILES y establezca el valor en la vía de acceso a los archivos de claves. Por ejemplo, C:\users\tke-files.
El URL del punto final privado se devuelve en private. Para el punto final de gestión de claves, utilice el valor que se ha devuelto en la sección kms. La variable de entorno KP_PRIVATE_ADDR se utiliza para definir el URL de punto final de la API para un punto final público y para un punto final privado. Si desea utilizar el punto final público, asegúrese de establecer la variable de entorno KP_PRIVATE_ADDR como URL de punto final público que se devuelve en el campo public en la sección kms.

Mandatos del plugin de CLI TKE

Tabla 1. Describe los mandatos del plugin de CLI TKE
Nombre de mandato	Descripción	Ejemplo
`tke auto-init`	Inicializa automáticamente la instancia de servicio.	`ibmcloud tke auto-init`
`tke auto-mk-rotate`	Rota automáticamente la clave maestra con un valor de clave maestra generado aleatoriamente en el HSM de recuperación.	`ibmcloud tke auto-mk-rotate`
`tke auto-recover`	Copia automáticamente el valor de la clave maestra actual del HSM de recuperación en otras unidades criptográficas del mismo grupo de recursos.	`ibmcloud tke auto-recover`
`tke`	Gestiona unidades criptográficas en IBM Cloud.	`ibmcloud tke`
`tke cryptounit-add`	Añade unidades criptográficas al conjunto de unidades criptográficas para trabajar con ellas.	`ibmcloud tke cryptounit-add`
`tke cryptounit-admin-add`	Añade un administrador de unidad criptográfica en las unidades criptográficas seleccionadas.	`ibmcloud tke cryptounit-admin-add`
`tke cryptounit-admin-rm`	Elimina un administrador de unidad criptográfica de las unidades criptográficas seleccionadas.	`ibmcloud tke cryptounit-admin-rm`
`tke cryptounit-admins`	Enumera administradores instalados en las unidades criptográficas seleccionadas.	`ibmcloud tke cryptounit-admins`
`tke cryptounit-compare`	Compara los valores de configuración de las unidades criptográficas seleccionadas.	`ibmcloud tke cryptounit-compare`
`tke cryptounit-cp-btc`	Habilita las funciones relacionadas con bitcoin (BTC) en las unidades criptográficas seleccionadas.	`ibmcloud tke cryptounit-cp-btc`
`tke cryptounit-cp-eddsa`	Habilita las funciones de algoritmos de firma digital de curva Edwards (EdDSA) en las unidades criptográficas seleccionadas.	`ibmcloud tke cryptounit-cp-eddsa`
`tke cryptounit-cp-sig-other`	Habilita las funciones de firma digital DSA de curva no elíptica, DSA de curva no Edwards en las unidades criptográficas seleccionadas.	`ibmcloud tke cryptounit-cp-sig-other`
`tke cryptounit-exit-impr`	Sale de la modalidad de impresión en las unidades criptográficas seleccionadas. (En desuso. En su lugar, utilice `cryptounit-thrhld-set`.)	`ibmcloud tke cryptounit-exit-impr`
`tke cryptounit-mk`	Muestra los registros de clave maestra para las unidades criptográficas seleccionadas.	`ibmcloud tke cryptounit-mk`
`tke cryptounit-mk-clrcur`	Borra el registro de clave maestra actual.	`ibmcloud tke cryptounit-mk-clrcur`
`tke cryptounit-mk-clrnew`	Borra el nuevo registro de clave maestra.	`ibmcloud tke cryptounit-mk-clrnew`
`tke cryptounit-mk-commit`	Confirma el nuevo registro de clave maestra.	`ibmcloud tke cryptounit-mk-commit`
`tke cryptounit-mk-load`	Carga el nuevo registro de clave maestra.	`ibmcloud tke cryptounit-mk-load`
`tke cryptounit-mk-rotate`	Promociona la clave maestra en el nuevo registro de clave maestra actual después de volver a envolver claves raíz y claves de cifrado en el almacén de claves de gestión de claves.	`ibmcloud tke cryptounit-mk-rotate`
`tke cryptounit-mk-setimm`	Se establece inmediatamente en los registros de clave maestra.	`ibmcloud tke cryptounit-mk-setimm`
`tke cryptounit-rm`	Elimina unidades criptográficas del conjunto de unidades criptográficas para trabajar con ellas.	`ibmcloud tke cryptounit-rm`
`tke cryptounit-thrhld-set`	Establece los umbrales de firma para las unidades criptográficas seleccionadas.	`ibmcloud tke cryptounit-thrhld-set`
`tke cryptounit-thrhlds`	Visualiza umbrales de firma para las unidades criptográficas seleccionadas.	`ibmcloud tke cryptounit-thrhlds`
`tke cryptounit-zeroize`	Pone a ceros las unidades criptográficas seleccionadas.	`ibmcloud tke cryptounit-zeroize`
`tke cryptounits`	Muestra las unidades criptográficas del grupo de recursos actual.	`ibmcloud tke cryptounits`
`tke failover-enable`	Habilite o añada unidades criptográficas de migración tras error después de suministrar una instancia de servicio.	`ibmcloud tke failover-enable`
`tke mk-add`	Crea y guarda un nuevo componente de clave maestra de EP11.	`ibmcloud tke mk-add`
`tke mk-rm`	Elimina un componente de clave maestra de EP11 de esta estación de trabajo.	`ibmcloud tke mk-rm`
`tke mks`	Enumera los componentes de claves maestras de EP11 almacenadas en esta estación de trabajo.	`ibmcloud tke mks`
`tke sigkey-add`	Genera y guarda una nueva clave de firma.	`ibmcloud tke sigkey-add`
`tke sigkey-rm`	Elimina una clave de firma de esta estación de trabajo.	`ibmcloud tke sigkey-rm`
`tke sigkey-sel`	Selecciona las claves de firma para utilizarla para firmar mandatos.	`ibmcloud tke sigkey-sel`
`tke sigkeys`	Enumera las claves de firma almacenadas en esta estación de trabajo.	`ibmcloud tke sigkeys`
`tke help`, `tke h`	Muestra la ayuda.	`ibmcloud tke help`

Para obtener más información sobre cada mandato, ejecute el mandato siguiente en el plugin de CLI TKE:

ibmcloud tke help <command_name>

Plugin de la CLI del gestor de certificados de Hyper Protect Crypto Services

Para el plan estándar Hyper Protect Crypto Services, puede utilizar el plugin de CLI del gestor de certificados para gestionar certificados y claves de firma de administrador para la segunda capa de autenticación en conexiones de API GREP11 o PKCS #11.

Instalación del plugin de la CLI del gestor de certificados

Para instalar el plugin de la CLI del gestor de certificados, siga estos pasos:

Instale la CLI de IBM Cloud.

La CLI de IBM Cloud requiere Java™ 1.8.0. El prefijo para ejecutar mandatos mediante la CLI de IBM Cloud es ibmcloud.
Instale el plugin de la CLI del gestor de certificados más reciente con el mandato siguiente:
```
ibmcloud plugin install hpcs-cert-mgr
```
Se le notifica en la línea de mandatos cuando las actualizaciones de la CLI de IBM Cloud y los plug-ins están disponibles. Asegúrese de que mantiene actualizada la CLI para poder utilizar los mandatos más recientes. Puede ver la versión actual de todos los plugins instalados con el mandato ibmcloud plugin list.

Mandatos de plugin de CLI de Certificate manager

A continuación se muestran todos los mandatos de la CLI del gestor de certificados disponibles y su uso correspondiente. Utilice -h o --help para obtener información de ayuda.

hpcs-cert-mgr adminkey get

Utilice este mandato para recuperar la clave de firma de administrador del administrador de certificados.

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

Opciones de mandato

--crn HPCS_CRN

Obligatorio. El crn de su instancia de Hyper Protect Crypto Services. Puede utilizar el mandato ibmcloud resource service-instances --long para recuperar el crn.

--private

Opcional. Si utiliza esta opción, el URL del servidor del gestor de certificados apunta a la red privada. Por ejemplo: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region es la abreviatura del área geográfica en la que inicia sesión en IBM Cloud. En este caso, debe utilizar la red privada para conectar su instancia de servicio.

Ejemplo

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

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

Salida

El mandato devuelve una salida similar a la del ejemplo siguiente:

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

command completed successfully.

hpcs-cert-mgr adminkey set

Utilice este mandato para crear la clave de firma del administrador para que el administrador de certificados se conecte al servidor del gestor de certificados.

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

Opciones de mandato

--crn HPCS_CRN

Obligatorio. El crn de su instancia de Hyper Protect Crypto Services. Puede utilizar el mandato ibmcloud resource service-instances --long para recuperar el crn.

--private

Opcional. Si utiliza esta opción, el URL del servidor del gestor de certificados apunta a la red privada. Por ejemplo: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region es la abreviatura del área geográfica en la que inicia sesión en IBM Cloud. En este caso, debe utilizar la red privada para conectar su instancia de servicio.

Ejemplo

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

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

Salida

El mandato devuelve una salida similar a la del ejemplo siguiente:

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 update

Renueve y actualice la clave de firma de administrador para el administrador de certificados.

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

Opciones de mandato

--crn HPCS_CRN

Obligatorio. El crn de su instancia de Hyper Protect Crypto Services. Puede utilizar el mandato ibmcloud resource service-instances --long para recuperar el crn.

--admin-priv-key ADMIN_PRIV_KEY

Obligatorio. La vía de acceso de la clave privada existente que se almacena en su estación de trabajo local. La clave privada se utiliza para firmar esta acción de mandato hacia el servidor del gestor de certificados de instancia.

--private

Opcional. Si utiliza esta opción, el URL del servidor del gestor de certificados apunta a la red privada. Por ejemplo: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region es la abreviatura del área geográfica en la que inicia sesión en IBM Cloud. En este caso, debe utilizar la red privada para conectar su instancia de servicio.

Ejemplo

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}

Salida

El mandato devuelve una salida similar a la del ejemplo siguiente:

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 delete

Utilice este mandato para suprimir la clave de firma de administrador para el administrador de certificados.

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

Opciones de mandato

--crn HPCS_CRN

Obligatorio. El crn de su instancia de Hyper Protect Crypto Services. Puede utilizar el mandato ibmcloud resource service-instances --long para recuperar el crn.

--admin-priv-key ADMIN_PRIV_KEY

Obligatorio. La vía de acceso del archivo de su clave privada actual que se almacena en la estación de trabajo local. La clave privada se utiliza para firmar esta acción de mandato hacia el servidor del gestor de certificados de instancia.

--private

Opcional. Si utiliza esta opción, el URL del servidor del gestor de certificados apunta a la red privada. Por ejemplo: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region es la abreviatura del área geográfica en la que inicia sesión en IBM Cloud. En este caso, debe utilizar la red privada para conectar su instancia de servicio.

Ejemplo

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}

Salida

El mandato devuelve una salida similar a la del ejemplo siguiente:

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

hpcs-cert-mgr cert get

Utilice este mandato para recuperar el certificado de cliente en el servidor del gestor de certificados de su instancia.

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

Opciones de mandato

--crn HPCS_CRN

Obligatorio. El crn de su instancia de Hyper Protect Crypto Services. Puede utilizar el mandato ibmcloud resource service-instances --long para recuperar el crn.

--cert-id CERT_ID

Obligatorio. El ID de serie del certificado de cliente que desea recuperar.

--cert-store-archivo CERT_FILE

Opcional. La vía de acceso del archivo para almacenar el certificado recuperado. Si especifica esta opción, el archivo se crea en su estación de trabajo local y almacena el contenido del certificado.

--private

Opcional. Si utiliza esta opción, el URL del servidor del gestor de certificados apunta a la red privada. Por ejemplo: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region es la abreviatura del área geográfica en la que inicia sesión en IBM Cloud. En este caso, debe utilizar la red privada para conectar su instancia de servicio.

Ejemplo

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

Salida

El mandato devuelve una salida similar a la del ejemplo siguiente:

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 cert set

Utilice este mandato para establecer certificados de cliente para el servidor del gestor de certificados de la instancia.

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

Opciones de mandato

--crn HPCS_CRN

Obligatorio. El crn de su instancia de Hyper Protect Crypto Services. Puede utilizar el mandato ibmcloud resource service-instances --long para recuperar el crn.

--admin-priv-key ADMIN_PRIV_KEY

Obligatorio. La vía de acceso del archivo de su clave privada actual que se almacena en la estación de trabajo local. La clave privada se utiliza para firmar esta acción de mandato hacia el servidor del gestor de certificados de instancia.

--cert-id CERT_ID

Obligatorio. El ID de serie que desea asignar al certificado para identificarlo fácilmente.

--cert CERT_FILE

Obligatorio. El archivo de certificado que se almacena en su estación de trabajo. Se recomienda utilizar el gestor de certificados de IBM Cloud para solicitar y gestionar los certificados SSL/TLS para sus aplicaciones y servicios.

--private

Opcional. Si utiliza esta opción, el URL del servidor del gestor de certificados apunta a la red privada. Por ejemplo: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region es la abreviatura del área geográfica en la que inicia sesión en IBM Cloud. En este caso, debe utilizar la red privada para conectar su instancia de servicio.

Ejemplo

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}

Salida

El mandato devuelve una salida similar a la del ejemplo siguiente:

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

hpcs-cert-mgr cert list

Utilice este mandato para listar todos los certificados gestionados por el administrador para el servidor del gestor de certificados de su instancia.

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

Opciones de mandato

--crn HPCS_CRN

Obligatorio. El crn de su instancia de Hyper Protect Crypto Services. Puede utilizar el mandato ibmcloud resource service-instances --long para recuperar el crn.

--private

Opcional. Si utiliza esta opción, el URL del servidor del gestor de certificados apunta a la red privada. Por ejemplo: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region es la abreviatura del área geográfica en la que inicia sesión en IBM Cloud. En este caso, debe utilizar la red privada para conectar su instancia de servicio.

Ejemplo

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

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

Salida

El mandato devuelve una salida similar a la del ejemplo siguiente:

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 cert delete

Utilice este mandato para suprimir certificados de cliente para el servidor del gestor de certificados de su instancia.

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

Opciones de mandato

--crn HPCS_CRN

Obligatorio. El crn de su instancia de Hyper Protect Crypto Services. Puede utilizar el mandato ibmcloud resource service-instances --long para recuperar el crn.

--admin-priv-key ADMIN_PRIV_KEY

Obligatorio. La vía de acceso del archivo de su clave privada actual que se almacena en la estación de trabajo local. La clave privada se utiliza para firmar esta acción de mandato hacia el servidor del gestor de certificados de instancia.

--cert-id CERT_ID

Obligatorio. El ID de serie del certificado que desea suprimir.

--private

Opcional. Si utiliza esta opción, el URL del servidor del gestor de certificados apunta a la red privada. Por ejemplo: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region es la abreviatura del área geográfica en la que inicia sesión en IBM Cloud. En este caso, debe utilizar la red privada para conectar su instancia de servicio.

Ejemplo

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

Salida

El mandato devuelve una salida similar a la del ejemplo siguiente:

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

Plugin de CLI de Hyper Protect Crypto Services Unified Key Orchestrator

Puede utilizar el plugin de CLI Unified Key Orchestrator para gestionar cajas fuertes, almacenes de claves y claves gestionadas para instancias de Hyper Protect Crypto Services con el plan Unified Key Orchestrator.

Instalación del plugin de CLI de Unified Key Orchestrator

Para instalar el plugin de CLI Unified Key Orchestrator, siga estos pasos:

Instale la CLI de IBM Cloud.

La CLI de IBM Cloud requiere Java™ 1.8.0. El prefijo para ejecutar mandatos mediante la CLI de IBM Cloud es ibmcloud.
Instale el último plugin de CLI de Unified Key Orchestrator con el mandato siguiente:
```
ibmcloud plugin install hpcs
```
Se le notifica en la línea de mandatos cuando las actualizaciones de la CLI de IBM Cloud y los plug-ins están disponibles. Asegúrese de que mantiene actualizada la CLI para poder utilizar los mandatos más recientes. Puede ver la versión actual de todos los plugins instalados con el mandato ibmcloud plugin list.
Establezca la variable de entorno UKO_URL en la estación de trabajo.
```
export UKO_URL=<UKO_endpoint_URL>
```
Sustituya <UKO_endpoint_URL> por el URL de punto final UKO de la instancia. Puede obtener el URL de punto final en el panel de control de la interfaz de usuario de la instancia de servicio suministrada a través de Visión general > Connect > Unified Key Orchestrator URL de punto final. O bien, puede recuperar dinámicamente el URL de punto final de API.

Mandatos del plugin de CLI Unified Key Orchestrator

A continuación se listan todos los mandatos de CLI Unified Key Orchestrator disponibles y su uso correspondiente. Utilice -h o --help para obtener información de ayuda.

claves gestionadas uko hpcs

Listar todas las claves gestionadas en la instancia. Es posible ordenar por los parámetros siguientes: label, algorithm, state, activation-date, deactivation-date, created-at, updated-at, size, vault-id.

Si la opción --all-pages no está establecida, el mandato sólo recuperará una única página de la colección.

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] [--rotated-at-min ROTATE-AT-MIN] [--rotated-at-max ROTATE-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] [--template-name TEMPLATE-NAME] [--template-id TEMPLATE-ID] [--template-type TEMPLATE-TYPE] [--managing-systems MANAGING-SYSTEMS]

Opciones de mandato

-- vault-id (serie[])

Opcional. El UUID (Universally Unique Identifier) de la caja fuerte. Puede utilizar el mandato ibmcloud hpcs uko managed-keys para recuperar el UUID. La longitud debe ser de 36 caracteres. Los elementos de lista deben coincidir con la expresión regular /^[-0-9a-z]+$/.

-- algorithm (serie[])

Opcional. El algoritmo de claves devueltas. Los valores que se pueden establecer son aes, rsa, hmac, ec, des y dilithium.

-- state (serie[])

Opcional. El estado en el que se deben estar las claves devueltas. El valor predeterminado es ["pre_activation","active"]. Los valores que se pueden establecer son: pre_activation, active, deactivated, destroyed, compromised y destroyed_compromised.

--limit (int64)

Opcional. El número de claves a recuperar. El valor máximo es 1000. El valor mínimo es 1. El valor predeterminado es 20.

--offset (int64)

Opcional. El número de claves a omitir. El valor mínimo es 0.

-- sort (serie[])

Opcional. El orden de clasificación. El valor predeterminado es ["-updated_at"]. Los elementos de lista deben coincidir con la expresión regular /^-?[a-z0-9_.\\[\\],-]+$/.

-- label (serie)

Opcional. La etiqueta de la clave. El valor debe coincidir con la expresión regular /.+/.

-- activation-date (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de activación coincida con el parámetro. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--activation-date-min (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de activación sea igual o posterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta activation_date. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--activation-date-max (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de activación sea igual o anterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta activation_date. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--deactivation-date (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de desactivación coincida con el parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta expiration_date. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--deactivation-date-min (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de desactivación sea igual o posterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con los parámetros de consulta deactivation_date, expiration_date, expiration_date_min y expiration_date_max. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--deactivation-date-max (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de desactivación sea igual o anterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con los parámetros de consulta deactivation_date, expiration_date, expiration_date_min y expiration_date_max. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- expiration-date (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de desactivación coincida con el parámetro. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--expiration-date-min (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de desactivación sea igual o posterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con los parámetros de consulta deactivation_date, expiration_date, deactivation_date_min y deactivation_date_max. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--expiration-date-max (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de desactivación sea igual o anterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con los parámetros de consulta deactivation_date, expiration_date, deactivation_date_min y deactivation_date_max. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- created-at (serie)

Opcional. Devolver sólo las claves gestionadas cuya hora de creación coincida con el parámetro. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at-min (serie)

Opcional. Devolver sólo las claves gestionadas cuya hora de creación sea igual o posterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta created_at. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at-max (serie)

Opcional. Devolver sólo las claves gestionadas cuya hora de creación sea igual o anterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta created_at. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- updated-at (serie)

Opcional. Devuelve sólo las claves gestionadas cuyo tiempo de actualización coincide con el parámetro. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at-min (serie)

Opcional. Devuelve sólo las claves gestionadas cuya hora de actualización es posterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta updated_at. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at-max (serie)

Opcional. Devolver sólo las claves gestionadas cuya hora de actualización sea anterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta updated_at. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--rotated-at-min (serie)

Opcional. Devuelve sólo las claves gestionadas cuyo tiempo de rotación es posterior al valor del parámetro.

--rotated-at-max (serie)

Opcional. Devolver sólo las claves gestionadas cuyo tiempo de rotación sea anterior al valor del parámetro.

-- size (int64)

Opcional. El tamaño de la clave.

-- size-min (int64)

Opcional. El tamaño mínimo de la clave. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta size.

-- size-max (int64)

Opcional. El tamaño máximo de la clave. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta size.

--referenciado-keystores-type (serie[])

Opcional. Tipo de almacén de claves referenciado. Los valores que se pueden establecer son aws_kms, azure_key_vault, ibm_cloud_kms, google_kms y cca.

--referenciado-keystores-name (serie[])

Opcional. Nombre del almacén de claves referenciado. Los elementos de lista deben coincidir con la expresión regular /[^,]+/.

--instances-keystore-type (serie[])

Opcional. Tipo de almacén de claves soportado por una de las instancias. Los valores que se pueden establecer son aws_kms, azure_key_vault, ibm_cloud_kms, google_kms y cca.

-- template-name (serie)

Devuelve sólo las claves gestionadas cuyo nombre de plantilla empieza por la serie.

-- template-id (serie[])

Devuelve sólo las claves gestionadas con el UUID de plantilla determinado.

-- template-type (serie[])

Devolver sólo las claves gestionadas con el tipo de plantilla especificado. Los valores que se pueden establecer son user_defined, shadow y system.

-- sistemas de gestión

Devolver sólo las claves gestionadas con los sistemas de gestión proporcionados. Los valores que se pueden establecer son web y workstation.

-- all-pages (bool)

Opcional. Invoque varias solicitudes para visualizar todas las páginas de la colección para claves gestionadas.

Ejemplo

ibmcloud hpcs uko managed-keys --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "total_count": 4,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "/v4/managed_keys?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0'"
  },
  "last": {
    "href": "/v4/managed_keys?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0"
  },
  "managed_keys": [
    {
      "id": "35f690df-064a-4758-8694-b2f011810701",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault-1",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "6393e930-562c-4042-b324-45c37d3d49d9",
        "name": "AZURE-template-920",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/6393e930-562c-4042-b324-45c37d3d49d9"
      },
      "version": "1,",
      "description": "AZURE KEY",
      "label": "AZUREproduction2029",
      "state": "active",
      "size": "2048",
      "algorithm": "rsa",
      "verification_patterns": [
        {
          "method": "PUB-HASH-SHA-1",
          "value\"": "947AA69D48EEE487048AF2999DADB8DA55769529"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "AZURE"
        },
        {
          "name": "ENV",
          "value": "production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "AZURE-TAG"
        }
      ],
      "created_at": "2023-06-05T11:33:54Z",
      "updated_at": "2023-06-05T11:33:54Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "keystore": [
            {
              "id": "2e124fa5-9ef6-406c-bb2f-9ad049ff1073",
              "name": "Azure Keystore",
              "type": "azure_key_vault",
              "href": "v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
            }
          ]
        }
      ],
      "instances": [
        {
          "id": "acb332dd-216c-44dd-8593-02bd2119ec62",
          "label_in_keystore\"": "AZUREproduction2029",
          "keystore": {
            "group": "Production AZURE GB",
            "type": "azure_key_vault"
          },
          "azure_key_protection_level": "software"
        }
      ],
      "href": "/v4/managed_keys/35f690df-064a-4758-8694-b2f011810701",
      "status_in_keystores": [
        {
          "keystore": [
            {
              "id": "2e124fa5-9ef6-406c-bb2f-9ad049ff1073",
              "name": "Azure Keystore",
              "type": "azure_key_vault",
              "href": "v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
            }
          ],
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "d1e2525c-62c8-4df2-9173-69e1a7bc8cdb/d1e2525c-62c8-4df2-9173-69e1a7bc8cdb"
        }
      ]
    },
    {
      "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "EXAMPLE-VAULT",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
        "name": "AWS-EXAMPLE-TEMPLATE",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
      },
      "version": 1,
      "description": "AWS key template description",
      "label": "AWS-production-2029",
      "state": "active",
      "size": 256,
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method\"": "ENC-ZERO",
          "value": "C05CA1"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "AWS"
        },
        {
          "name": "ENV",
          "value": "production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "AWS-TAG"
        }
      ],
      "created_at": "2023-06-05T10:40:13Z",
      "updated_at": "2023-06-05T10:40:19Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "id": "0743ae15-c594-476d-8e9a-1564740ace53",
          "name": "AWS KMS Keystore 335",
          "type": "aws_kms",
          "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
        }
      ],
      "instances": [
        {
          "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
          "label_in_keystore": "AWS-production-2029",
          "type": "secret_key",
          "keystore": {
            "group\"": "Production-AWS-DE",
            "type\"": "aws_kms"
          }
        }
      ],
      "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
      "status_in_keystores": [
        {
          "keystore": {
            "id": "0743ae15-c594-476d-8e9a-1564740ace53",
            "name": "AWS KMS Keystore 335",
            "type": "aws_kms",
            "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
          },
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
        }
      ]
    },
    {
      "id": "0beedc06-4608-48ae-8ae3-8b7bf3c2c39f",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault-2",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "64f98479-392d-4af2-a076-77cc21b8c6f3",
        "name": "IBM-CLOUD-TEMPLATE",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/64f98479-392d-4af2-a076-77cc21b8c6f3"
      },
      "version": 1,
      "description": "",
      "label": "IBMCloudProduction2029",
      "state": "active",
      "size": "256",
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method": "ENC-ZERO",
          "value": "4ADDCB"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "IBMCloud"
        },
        {
          "name": "ENV",
          "value": "Production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "AWS-TAG"
        }
      ],
      "created_at": "2023-06-05T11:59:47Z",
      "updated_at": "2023-06-05T11:59:47Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "id": "0743ae15-c594-476d-8e9a-1564740ace53",
          "name": "IBM CLOUD KEYSTORE",
          "type": "ibm_cloud_kms",
          "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
        }
      ],
      "instances": [
        {
          "id": "0c5b14ea-a3dd-407c-af7c-fd74575ccbad",
          "label_in_keystore": "IBMCloudProduction2029",
          "type": "secret_key",
          "keystore": {
            "group": "Production External GB",
            "type": "ibm_cloud_kms"
          }
        }
      ],
      "href": "/v4/managed_keys/0beedc06-4608-48ae-8ae3-8b7bf3c2c39f",
      "status_in_keystores": [
        {
          "keystore": {
            "id": "0743ae15-c594-476d-8e9a-1564740ace53",
            "name": "IBM CLOUD KEYSTORE",
            "type": "ibm_cloud_kms",
            "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
          },
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "804854d0-4eb7-416e-8ae2-45ba56921c8a/804854d0-4eb7-416e-8ae2-45ba56921c8a"
        }
      ]
    },
    {
      "id": "d7b8204c-4f8f-4ba1-b306-5434ae817f51",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault-3",
        "href": "v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "09d229e5-e330-4e85-a7ee-cc8555d38603",
        "name": "GOOGLE-TEMPLATE-86",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/09d229e5-e330-4e85-a7ee-cc8555d38603"
      },
      "version": 1,
      "description": "Google Key",
      "label": "Google-Production-2029",
      "state": "active",
      "size": "256",
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method\"": "ENC-ZERO",
          "value": "C3F432"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "Google"
        },
        {
          "name": "ENV",
          "value": "Production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "Google-TAG"
        }
      ],
      "created_at": "2023-06-05T13:18:28",
      "updated_at": "2023-06-05T13:18:28Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "id": "6e026faa-d44d-4a1a-aeea-0e1ef2840cba",
          "name": "Google Keystore",
          "type": "google_kms",
          "href": "/v4/keystores/6e026faa-d44d-4a1a-aeea-0e1ef2840cba"
        }
      ],
      "instances": [
        {
          "id": "ed74a984-2057-484c-9198-54839f3fec62",
          "label_in_keystore": "Google-Production-2029",
          "type": "secret_key",
          "keystore": {
            "group": "Production Google",
            "type": "google_kms"
          },
          "google_key_protection_level": "software",
          "google_key_purpose": "encrypt_decrypt",
          "google_kms_algorithm": "google_symmetric_encryption"
        }
      ],
      "href": "/v4/managed_keys/d7b8204c-4f8f-4ba1-b306-5434ae817f51",
      "status_in_keystores": [
        {
          "keystore": {
            "id": "6e026faa-d44d-4a1a-aeea-0e1ef2840cba",
            "name": "Google Keystore",
            "type": "google_kms",
            "href": "/v4/keystores/6e026faa-d44d-4a1a-aeea-0e1ef2840cba"
          },
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "projects/plated-field-364019/locations/europe-west3/keyRings/uko-ring/cryptoKeys/ROBOT-Google-Key-05-06-nciYX/cryptoKeyVersions/1"
        }
      ]
    }
  ]
}

uko managed-key-create de hpcs

Cree una clave nueva basada en la plantilla proporcionada. La plantilla debe existir en la instancia para poder ejecutar este mandato.

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

Opciones de mandato

-- template-name (serie)

Obligatorio. El nombre de la plantilla de clave que se debe utilizar al crear una clave. La longitud debe estar entre 1 y 30 caracteres. El valor debe coincidir con la expresión regular /^[A-Za-z][A-Za-z0-9-]+$/.

-- vault (VaultReferenceInCreationRequest)

Obligatorio. El ID de la caja fuerte donde se va a crear la clave gestionada.

-- label (serie)

Obligatorio. La etiqueta de la clave. La longitud debe estar entre 1 y 255 caracteres. El valor debe coincidir con la expresión regular /^[A-Za-z0-9._ \/-]+$/.

-- tags (Etiqueta [])

Opcional. Pares de clave-valor que están asociados con la clave. La longitud debe estar entre 0 y 128 elementos.

--description (serie)

Opcional. La descripción de la clave gestionada. La longitud debe estar entre 0 y 200 caracteres. El valor debe coincidir con la expresión regular /(.|\\n)*/.

Ejemplo

ibmcloud hpcs uko managed-key-create \
  --template-name=IBM-CLOUD-EXAMPLE-TEMPLATE \
  --vault='{"id": "93777bca-baef-4070-b9b5-a2e6079df1b4"}' \
  --label='IBM CLOUD KEY' \
  --tags='[{"name": "first-tag", "value": "for-IBM-CLOUD"}]' \
  --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
Ubicación	Serie	Vía de acceso al recurso recién creado, relativo a la raíz de contexto.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "AWS-EXAMPLE-VAULT",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "template": {
    "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
    "name": "AWS-EXAMPLE-TEMPLATE",
    "type": [
      "user_defined"
    ],
    "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
  },
  "version": 1,
  "description": "AWS key template description",
  "label": "AWS-production-2029",
  "state": "active",
  "size": 256,
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method\"": "ENC-ZERO",
      "value": "C05CA1"
    }
  ],
  "activation_date": "2028-07-14",
  "expiration_date": "2029-09-25",
  "label_tags": [
    {
      "name": "APP",
      "value": "AWS"
    },
    {
      "name": "ENV",
      "value": "production"
    },
    {
      "name": "lay",
      "value": "2029"
    }
  ],
  "tags": [
    {
      "name": "TAG-1",
      "value": "AWS-TAG"
    }
  ],
  "created_at": "2023-06-05T10:40:13Z",
  "updated_at": "2023-06-05T10:40:19Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "referenced_keystores": [
    {
      "id": "0743ae15-c594-476d-8e9a-1564740ace53",
      "name": "AWS KMS Keystore 335",
      "type": "aws_kms",
      "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
    }
  ],
  "instances": [
    {
      "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
      "label_in_keystore": "AWS-production-2029",
      "type": "secret_key",
      "keystore": {
        "group\"": "Production-AWS-DE",
        "type\"": "aws_kms"
      }
    }
  ],
  "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
  "status_in_keystores": [
    {
      "keystore": {
        "id": "0743ae15-c594-476d-8e9a-1564740ace53",
        "name": "AWS KMS Keystore 335",
        "type": "aws_kms",
        "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
      },
      "status": "active",
      "keystore_sync_flag": "ok",
      "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
      "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
    }
  ]
}

uko managed-key-delete de hpcs

Suprimir una clave gestionada por ID de clave de la caja fuerte. Asegúrese de que la clave esté en un estado Destruido antes de ejecutar este mandato.

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

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la clave. Puede utilizar el mandato ibmcloud hpcs uko managed-keys para recuperar el UUID de clave.

-- if-match (serie)

Obligatorio. Condición previa de la actualización, que es el valor de ETag de la cabecera en una solicitud GET. Puede utilizar el mandato ibmcloud hpcs uko managed-key para recuperar el ETag.

Ejemplo

ibmcloud hpcs uko managed-key-delete \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --if-match=2022-05-27T10:15:38Z

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.

El mandato devuelve una salida similar a la del ejemplo siguiente:

...
OK

clave gestionada uko hpcs

Recupere una clave gestionada y sus detalles especificando el ID de clave.

ibmcloud hpcs uko managed-key --id ID

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la clave. Puede utilizar el mandato ibmcloud hpcs uko managed-keys para recuperar el UUID de clave.

Ejemplo

ibmcloud hpcs uko managed-key \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "AWS-EXAMPLE-VAULT",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "template": {
    "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
    "name": "AWS-EXAMPLE-TEMPLATE",
    "type": [
      "user_defined"
    ],
    "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
  },
  "version": 1,
  "description": "AWS key template description",
  "label": "AWS-production-2029",
  "state": "active",
  "size": 256,
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method\"": "ENC-ZERO",
      "value": "C05CA1"
    }
  ],
  "activation_date": "2028-07-14",
  "expiration_date": "2029-09-25",
  "label_tags": [
    {
      "name": "APP",
      "value": "AWS"
    },
    {
      "name": "ENV",
      "value": "production"
    },
    {
      "name": "lay",
      "value": "2029"
    }
  ],
  "tags": [
    {
      "name": "TAG-1",
      "value": "AWS-TAG"
    }
  ],
  "created_at": "2023-06-05T10:40:13Z",
  "updated_at": "2023-06-05T10:40:19Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "referenced_keystores": [
    {
      "id": "0743ae15-c594-476d-8e9a-1564740ace53",
      "name": "AWS KMS Keystore 335",
      "type": "aws_kms",
      "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
    }
  ],
  "instances": [
    {
      "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
      "label_in_keystore": "AWS-production-2029",
      "type": "secret_key",
      "keystore": {
        "group\"": "Production-AWS-DE",
        "type\"": "aws_kms"
      }
    }
  ],
  "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
  "status_in_keystores": [
    {
      "keystore": {
        "id": "0743ae15-c594-476d-8e9a-1564740ace53",
        "name": "AWS KMS Keystore 335",
        "type": "aws_kms",
        "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
      },
      "status": "active",
      "keystore_sync_flag": "ok",
      "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
      "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
    }
  ]
}

uko managed-key-update de hpcs

Actualizar atributos de una clave gestionada. Sólo puede modificar el estado de la clave por separado de otros cambios. El cambio del estado de una clave afecta a su disponibilidad para las operaciones criptográficas en los almacenes de claves.

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

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la clave. Puede utilizar el mandato ibmcloud hpcs uko managed-keys para recuperar el UUID de clave.

-- if-match (serie)

Obligatorio. Condición previa de la actualización, que es el valor de ETag de la cabecera en una solicitud GET. Puede utilizar el mandato ibmcloud hpcs uko managed-key para recuperar el ETag.

-- label (serie)

Obligatorio. La etiqueta de la clave. La longitud debe estar entre 1 y 255 caracteres. El valor debe coincidir con la expresión regular /^[A-Za-z0-9._ \/-]+$/.

-- activation-date (strfmt.Date)

Opcional. La fecha de activación debe proporcionarse en formato AAAA-MM-DD.

-- expiration-date (strfmt.Date)

Opcional. La fecha de caducidad debe proporcionarse en el formato AAAA-MM-DD.

-- tags (Etiqueta [])

Opcional. Pares de clave-valor que están asociados con la clave. La longitud debe estar entre 0 y 128 elementos.

--description (serie)

Opcional. La descripción de la clave gestionada. La longitud debe estar entre 0 y 200 caracteres. El valor debe coincidir con la expresión regular /(.|\\n)*/.

Ejemplo

ibmcloud hpcs uko managed-key-update \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --if-match=2022-05-26T14:18:10Z \
  --description="updated description" \
  --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "AWS-EXAMPLE-VAULT",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "template": {
    "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
    "name": "AWS-EXAMPLE-TEMPLATE",
    "type": [
      "user_defined"
    ],
    "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
  },
  "version": 1,
  "description": "AWS key template description",
  "label": "AWS-production-2029",
  "state": "active",
  "size": 256,
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method\"": "ENC-ZERO",
      "value": "C05CA1"
    }
  ],
  "activation_date": "2028-07-14",
  "expiration_date": "2029-09-25",
  "label_tags": [
    {
      "name": "APP",
      "value": "AWS"
    },
    {
      "name": "ENV",
      "value": "production"
    },
    {
      "name": "lay",
      "value": "2029"
    }
  ],
  "tags": [
    {
      "name": "TAG-1",
      "value": "AWS-TAG"
    }
  ],
  "created_at": "2023-06-05T10:40:13Z",
  "updated_at": "2023-06-05T10:40:19Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "referenced_keystores": [
    {
      "id": "0743ae15-c594-476d-8e9a-1564740ace53",
      "name": "AWS KMS Keystore 335",
      "type": "aws_kms",
      "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
    }
  ],
  "instances": [
    {
      "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
      "label_in_keystore": "AWS-production-2029",
      "type": "secret_key",
      "keystore": {
        "group\"": "Production-AWS-DE",
        "type\"": "aws_kms"
      }
    }
  ],
  "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
  "status_in_keystores": [
    {
      "keystore": {
        "id": "0743ae15-c594-476d-8e9a-1564740ace53",
        "name": "AWS KMS Keystore 335",
        "type": "aws_kms",
        "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
      },
      "status": "active",
      "keystore_sync_flag": "ok",
      "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
      "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
    }
  ]
}

hpcs uko asociado-resources-for-managed-key

Obtenga una lista de recursos asociados con una clave gestionada en IBM Cloud. Estos recursos de nube están protegidos por la clave que especifique.

Si la opción --all-pages no está establecida, el mandato sólo recupera una única página de la colección.

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

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la clave. Puede utilizar el mandato ibmcloud hpcs uko managed-keys para recuperar el UUID de clave.

--limit (int64)

Opcional. El número de recursos a recuperar. El valor debe estar entre 1 y 1000.

--offset (int64)

Opcional. El número de recursos a omitir. El valor mínimo es 0.

-- sort (serie[])

Opcional. El orden de clasificación. El valor predeterminado es ["name"]. Los elementos de lista deben coincidir con la expresión regular /^-?[a-z0-9_.\\[\\],-]+$/.

-- all-pages (bool)

Opcional. Invoque varias solicitudes para visualizar todas las páginas de la colección para los recursos asociados.

Ejemplo

ibmcloud hpcs uko associated-resources-for-managed-key \
--id=93777bca-baef-4070-b9b5-a2e6079df1b4 \
--output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "total_count": 3,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_key/5295ad47-2ce9-43c3-b9e7-e5a9482c362b/associated_resources?limit=20"
  },
  "last": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_key/5295ad47-2ce9-43c3-b9e7-e5a9482c362b/associated_resources?limit=20&offset=0"
  },
  "previous": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_keys?offset=80"
  },
  "next": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_keys?offset=120"
  },
  "associated_resources": [
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "managed_key": {
        "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
        "name": "My Managed Key",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_keys/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "referenced_keystore": {
        "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
        "name": "My Managed Key",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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-keys-from-keystore

Listar todas las claves gestionadas que están asignadas al almacén de claves.

Si la opción --all-pages no está establecida, el mandato sólo recupera una única página de la colección.

ibmcloud hpcs uko managed-keys-from-keystore --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] [--rotate-at-min ROTATE-AT-MIN] [--rotate-at-max ROTATE-AT-MAX] [--size SIZE] [--size-min SIZE-MIN] [--size-max SIZE-MAX] [--template-name TEMPLATE-NAME] [--template-id TEMPLATE-ID] [--template-type TEMPLATE-TYPE]

Opciones de mandato

-- uko-vault (serie)

Obligatorio. El UUID de la caja fuerte donde se va a realizar la actualización. Puede utilizar el mandato ibmcloud hpcs uko vaults para recuperar el UUID.

--id (serie)

Obligatorio. El UUID del almacén de claves. Puede utilizar el mandato ibmcloud hpcs uko keystores para recuperar el UUID.

-- algorithm (serie)

Opcional. El algoritmo de las claves devueltas. Los valores que se pueden establecer son aes, rsa, hmac y ec.

-- state (serie)

Opcional. El estado en el que se deben estar las claves devueltas. El valor predeterminado es ["pre_activation","active"]. Los valores que se pueden establecer son: pre_activation, active, deactivated, destroyed.

--limit (int64)

Opcional. El número de claves a recuperar. El valor debe estar entre 1 y 1000.

--offset (int64)

Opcional. El número de claves a omitir. El valor mínimo es 0.

-- sort (serie[])

Opcional. El orden de clasificación. El valor predeterminado es ["-updated_at"]. Los elementos de lista deben coincidir con la expresión regular /^-?[a-z0-9_.\\[\\],-]+$/.

-- label (serie)

Opcional. La etiqueta de la clave. El valor debe coincidir con la expresión regular /.+/.

-- activation-date (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de activación coincida con el parámetro. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--activation-date-min (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de activación sea igual o posterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta activation_date. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--activation-date-max (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de activación sea igual o anterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta activation_date. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--deactivation-date (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de desactivación coincida con el parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta expiration_date. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--deactivation-date-min (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de desactivación sea igual o posterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con los parámetros de consulta deactivation_date, expiration_date, expiration_date_min y expiration_date_max. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--deactivation-date-max (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de desactivación sea igual o anterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con los parámetros de consulta deactivation_date, expiration_date, expiration_date_min y expiration_date_max. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- expiration-date (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de desactivación coincida con el parámetro. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--expiration-date-min (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de desactivación sea igual o posterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con los parámetros de consulta deactivation_date, expiration_date, deactivation_date_min y deactivation_date_max. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--expiration-date-max (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de desactivación sea igual o anterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con los parámetros de consulta deactivation_date, expiration_date, deactivation_date_min y deactivation_date_max. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- created-at (serie)

Opcional. Devolver sólo las claves gestionadas cuya hora de creación coincida con el parámetro. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at-min (serie)

Opcional. Devolver sólo las claves gestionadas cuya hora de creación sea igual o posterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta created_at. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at-max (serie)

Opcional. Devolver sólo las claves gestionadas cuya hora de creación sea igual o anterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta created_at. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- updated-at (serie)

Opcional. Devuelve sólo las claves gestionadas cuyo tiempo de actualización coincide con el parámetro. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at-min (serie)

Opcional. Devuelve sólo las claves gestionadas cuya hora de actualización es posterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta updated_at. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at-max (serie)

Opcional. Devolver sólo las claves gestionadas cuya hora de actualización sea anterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta updated_at. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--rotate-at-min (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de rotación sea posterior al valor del parámetro.

--rotate-at-max (serie)

Opcional. Devolver sólo las claves gestionadas cuya fecha de rotación sea anterior al valor del parámetro.

-- size (int64)

Opcional. El tamaño de la clave.

-- size-min (int64)

Opcional. El tamaño mínimo de la clave. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta size.

-- size-max (int64)

Opcional. El tamaño máximo de la clave. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta size.

-- template-name (serie)

Devuelve sólo las claves gestionadas cuyo nombre de plantilla empieza por la serie.

-- template-id (serie[])

Devuelve sólo las claves gestionadas con el UUID de plantilla determinado.

-- template-type (serie[])

Devolver sólo las claves gestionadas con el tipo de plantilla especificado. Los valores que se pueden establecer son user_defined, shadow y system.

-- all-pages (bool)

Opcional. Invoque varias solicitudes para visualizar todas las páginas de la colección para claves gestionadas.

Ejemplo

ibmcloud hpcs uko managed-keys-from-keystore \
  --id=f779c44d-b90e-4917-b8b0-28d4591fefda \
  --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "total_count": 4,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "/v4/managed_keys?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0'"
  },
  "last": {
    "href": "/v4/managed_keys?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0"
  },
  "managed_keys": [
    {
      "id": "35f690df-064a-4758-8694-b2f011810701",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault-1",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "6393e930-562c-4042-b324-45c37d3d49d9",
        "name": "AZURE-template-920",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/6393e930-562c-4042-b324-45c37d3d49d9"
      },
      "version": "1,",
      "description": "AZURE KEY",
      "label": "AZUREproduction2029",
      "state": "active",
      "size": "2048",
      "algorithm": "rsa",
      "verification_patterns": [
        {
          "method": "PUB-HASH-SHA-1",
          "value\"": "947AA69D48EEE487048AF2999DADB8DA55769529"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "AZURE"
        },
        {
          "name": "ENV",
          "value": "production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "AZURE-TAG"
        }
      ],
      "created_at": "2023-06-05T11:33:54Z",
      "updated_at": "2023-06-05T11:33:54Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "keystore": [
            {
              "id": "2e124fa5-9ef6-406c-bb2f-9ad049ff1073",
              "name": "Azure Keystore",
              "type": "azure_key_vault",
              "href": "v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
            }
          ]
        }
      ],
      "instances": [
        {
          "id": "acb332dd-216c-44dd-8593-02bd2119ec62",
          "label_in_keystore\"": "AZUREproduction2029",
          "keystore": {
            "group": "Production AZURE GB",
            "type": "azure_key_vault"
          },
          "azure_key_protection_level": "software"
        }
      ],
      "href": "/v4/managed_keys/35f690df-064a-4758-8694-b2f011810701",
      "status_in_keystores": [
        {
          "keystore": [
            {
              "id": "2e124fa5-9ef6-406c-bb2f-9ad049ff1073",
              "name": "Azure Keystore",
              "type": "azure_key_vault",
              "href": "v4/managed_keys/3dab42dc-6941-4841-8d27-4dabcc5aa09e"
            }
          ],
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "d1e2525c-62c8-4df2-9173-69e1a7bc8cdb/d1e2525c-62c8-4df2-9173-69e1a7bc8cdb"
        }
      ]
    },
    {
      "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "EXAMPLE-VAULT",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
        "name": "AWS-EXAMPLE-TEMPLATE",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
      },
      "version": 1,
      "description": "AWS key template description",
      "label": "AWS-production-2029",
      "state": "active",
      "size": 256,
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method\"": "ENC-ZERO",
          "value": "C05CA1"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "AWS"
        },
        {
          "name": "ENV",
          "value": "production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "AWS-TAG"
        }
      ],
      "created_at": "2023-06-05T10:40:13Z",
      "updated_at": "2023-06-05T10:40:19Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "id": "0743ae15-c594-476d-8e9a-1564740ace53",
          "name": "AWS KMS Keystore 335",
          "type": "aws_kms",
          "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
        }
      ],
      "instances": [
        {
          "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
          "label_in_keystore": "AWS-production-2029",
          "type": "secret_key",
          "keystore": {
            "group\"": "Production-AWS-DE",
            "type\"": "aws_kms"
          }
        }
      ],
      "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
      "status_in_keystores": [
        {
          "keystore": {
            "id": "0743ae15-c594-476d-8e9a-1564740ace53",
            "name": "AWS KMS Keystore 335",
            "type": "aws_kms",
            "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
          },
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
        }
      ]
    },
    {
      "id": "0beedc06-4608-48ae-8ae3-8b7bf3c2c39f",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault-2",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "64f98479-392d-4af2-a076-77cc21b8c6f3",
        "name": "IBM-CLOUD-TEMPLATE",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/64f98479-392d-4af2-a076-77cc21b8c6f3"
      },
      "version": 1,
      "description": "",
      "label": "IBMCloudProduction2029",
      "state": "active",
      "size": "256",
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method": "ENC-ZERO",
          "value": "4ADDCB"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "IBMCloud"
        },
        {
          "name": "ENV",
          "value": "Production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "AWS-TAG"
        }
      ],
      "created_at": "2023-06-05T11:59:47Z",
      "updated_at": "2023-06-05T11:59:47Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "id": "0743ae15-c594-476d-8e9a-1564740ace53",
          "name": "IBM CLOUD KEYSTORE",
          "type": "ibm_cloud_kms",
          "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
        }
      ],
      "instances": [
        {
          "id": "0c5b14ea-a3dd-407c-af7c-fd74575ccbad",
          "label_in_keystore": "IBMCloudProduction2029",
          "type": "secret_key",
          "keystore": {
            "group": "Production External GB",
            "type": "ibm_cloud_kms"
          }
        }
      ],
      "href": "/v4/managed_keys/0beedc06-4608-48ae-8ae3-8b7bf3c2c39f",
      "status_in_keystores": [
        {
          "keystore": {
            "id": "0743ae15-c594-476d-8e9a-1564740ace53",
            "name": "IBM CLOUD KEYSTORE",
            "type": "ibm_cloud_kms",
            "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
          },
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "804854d0-4eb7-416e-8ae2-45ba56921c8a/804854d0-4eb7-416e-8ae2-45ba56921c8a"
        }
      ]
    },
    {
      "id": "d7b8204c-4f8f-4ba1-b306-5434ae817f51",
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault-3",
        "href": "v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "template": {
        "id": "09d229e5-e330-4e85-a7ee-cc8555d38603",
        "name": "GOOGLE-TEMPLATE-86",
        "type": [
          "user_defined"
        ],
        "href": "/v4/templates/09d229e5-e330-4e85-a7ee-cc8555d38603"
      },
      "version": 1,
      "description": "Google Key",
      "label": "Google-Production-2029",
      "state": "active",
      "size": "256",
      "algorithm": "aes",
      "verification_patterns": [
        {
          "method\"": "ENC-ZERO",
          "value": "C3F432"
        }
      ],
      "activation_date": "2028-07-14",
      "expiration_date": "2029-09-25",
      "label_tags": [
        {
          "name": "APP",
          "value": "Google"
        },
        {
          "name": "ENV",
          "value": "Production"
        },
        {
          "name": "lay",
          "value": "2029"
        }
      ],
      "tags": [
        {
          "name": "TAG-1",
          "value": "Google-TAG"
        }
      ],
      "created_at": "2023-06-05T13:18:28",
      "updated_at": "2023-06-05T13:18:28Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "referenced_keystores": [
        {
          "id": "6e026faa-d44d-4a1a-aeea-0e1ef2840cba",
          "name": "Google Keystore",
          "type": "google_kms",
          "href": "/v4/keystores/6e026faa-d44d-4a1a-aeea-0e1ef2840cba"
        }
      ],
      "instances": [
        {
          "id": "ed74a984-2057-484c-9198-54839f3fec62",
          "label_in_keystore": "Google-Production-2029",
          "type": "secret_key",
          "keystore": {
            "group": "Production Google",
            "type": "google_kms"
          },
          "google_key_protection_level": "software",
          "google_key_purpose": "encrypt_decrypt",
          "google_kms_algorithm": "google_symmetric_encryption"
        }
      ],
      "href": "/v4/managed_keys/d7b8204c-4f8f-4ba1-b306-5434ae817f51",
      "status_in_keystores": [
        {
          "keystore": {
            "id": "6e026faa-d44d-4a1a-aeea-0e1ef2840cba",
            "name": "Google Keystore",
            "type": "google_kms",
            "href": "/v4/keystores/6e026faa-d44d-4a1a-aeea-0e1ef2840cba"
          },
          "status": "active",
          "keystore_sync_flag": "ok",
          "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
          "key_id_in_keystore": "projects/plated-field-364019/locations/europe-west3/keyRings/uko-ring/cryptoKeys/ROBOT-Google-Key-05-06-nciYX/cryptoKeyVersions/1"
        }
      ]
    }
  ]
}

uko managed-key-ds de hpcs

Devuelve el estado de distribución del almacén de claves para una clave gestionada.

ibmcloud hpcs uko managed-key-ds --id ID

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la clave. Puede utilizar el mandato ibmcloud hpcs uko managed-keys para recuperar el UUID de clave.

Ejemplo

ibmcloud hpcs uko managed-key-ds \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.

El mandato devuelve una salida similar a la del ejemplo siguiente:

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

uko managed-key-update-from-template de hpcs

Actualice una clave gestionada para que coincida con la última versión de la plantilla de clave asociada. Puede asignar, activar o desactivar la clave en los almacenes de claves del grupo definido por la plantilla de claves.

ibmcloud hpcs uko managed-key-update-from-template --id ID --if-match IF-MATCH [--dry-run DRY-RUN]

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la clave. Puede utilizar el mandato ibmcloud hpcs uko managed-keys para recuperar el UUID de clave.

-- if-match (serie)

Obligatorio. Condición previa de la actualización, que es el valor de ETag de la cabecera en una solicitud GET. Puede utilizar el mandato ibmcloud hpcs uko managed-key para recuperar el ETag.

--dry-run (booleano)

Opcional. No cree, actualice o suprima un recurso, solo verifique y valide si el recurso se puede crear, actualizar o suprimir correctamente con una solicitud determinada. El valor predeterminado es false.

Ejemplo

ibmcloud hpcs uko managed-key-update-from-template \
  --id=22c04c00-0687-4f10-b0ac-b9f01d68ee85 \
  --if-match=2022-05-27T12:27:37Z \
  --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "AWS-EXAMPLE-VAULT",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "template": {
    "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
    "name": "AWS-EXAMPLE-TEMPLATE",
    "type": [
      "user_defined"
    ],
    "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
  },
  "version": 1,
  "description": "AWS key template description",
  "label": "AWS-production-2029",
  "state": "active",
  "size": 256,
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method\"": "ENC-ZERO",
      "value": "C05CA1"
    }
  ],
  "activation_date": "2028-07-14",
  "expiration_date": "2029-09-25",
  "label_tags": [
    {
      "name": "APP",
      "value": "AWS"
    },
    {
      "name": "ENV",
      "value": "production"
    },
    {
      "name": "lay",
      "value": "2029"
    }
  ],
  "tags": [
    {
      "name": "TAG-1",
      "value": "AWS-TAG"
    }
  ],
  "created_at": "2023-06-05T10:40:13Z",
  "updated_at": "2023-06-05T10:40:19Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "referenced_keystores": [
    {
      "id": "0743ae15-c594-476d-8e9a-1564740ace53",
      "name": "AWS KMS Keystore 335",
      "type": "aws_kms",
      "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
    }
  ],
  "instances": [
    {
      "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
      "label_in_keystore": "AWS-production-2029",
      "type": "secret_key",
      "keystore": {
        "group\"": "Production-AWS-DE",
        "type\"": "aws_kms"
      }
    }
  ],
  "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
  "status_in_keystores": [
    {
      "keystore": {
        "id": "0743ae15-c594-476d-8e9a-1564740ace53",
        "name": "AWS KMS Keystore 335",
        "type": "aws_kms",
        "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
      },
      "status": "active",
      "keystore_sync_flag": "ok",
      "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
      "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
    }
  ]
}

uko managed-key-activate de hpcs

Active una clave gestionada y realice operaciones de instalación o activación de claves en los almacenes de claves del grupo de almacén de claves asociado con la clave gestionada.

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

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la clave. Puede utilizar el mandato ibmcloud hpcs uko managed-keys para recuperar el UUID de clave.

-- if-match (serie)

Obligatorio. Condición previa de la actualización, que es el valor de ETag de la cabecera en una solicitud GET. Puede utilizar el mandato ibmcloud hpcs uko managed-key para recuperar el ETag.

Ejemplo

ibmcloud hpcs uko managed-key-activate \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --if-match=2022-05-27T10:06:27Z \
  --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "AWS-EXAMPLE-VAULT",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "template": {
    "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
    "name": "AWS-EXAMPLE-TEMPLATE",
    "type": [
      "user_defined"
    ],
    "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
  },
  "version": 1,
  "description": "AWS key template description",
  "label": "AWS-production-2029",
  "state": "active",
  "size": 256,
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method\"": "ENC-ZERO",
      "value": "C05CA1"
    }
  ],
  "activation_date": "2028-07-14",
  "expiration_date": "2029-09-25",
  "label_tags": [
    {
      "name": "APP",
      "value": "AWS"
    },
    {
      "name": "ENV",
      "value": "production"
    },
    {
      "name": "lay",
      "value": "2029"
    }
  ],
  "tags": [
    {
      "name": "TAG-1",
      "value": "AWS-TAG"
    }
  ],
  "created_at": "2023-06-05T10:40:13Z",
  "updated_at": "2023-06-05T10:40:19Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "referenced_keystores": [
    {
      "id": "0743ae15-c594-476d-8e9a-1564740ace53",
      "name": "AWS KMS Keystore 335",
      "type": "aws_kms",
      "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
    }
  ],
  "instances": [
    {
      "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
      "label_in_keystore": "AWS-production-2029",
      "type": "secret_key",
      "keystore": {
        "group\"": "Production-AWS-DE",
        "type\"": "aws_kms"
      }
    }
  ],
  "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
  "status_in_keystores": [
    {
      "keystore": {
        "id": "0743ae15-c594-476d-8e9a-1564740ace53",
        "name": "AWS KMS Keystore 335",
        "type": "aws_kms",
        "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
      },
      "status": "active",
      "keystore_sync_flag": "ok",
      "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
      "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
    }
  ]
}

uko managed-key-deactivate de hpcs

Desactive una clave gestionada y realice operaciones de desactivación de claves en los almacenes de claves del grupo de almacén de claves asociado con la clave gestionada.

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

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la clave. Puede utilizar el mandato ibmcloud hpcs uko managed-keys para recuperar el UUID de clave.

-- if-match (serie)

Obligatorio. Condición previa de la actualización, que es el valor de ETag de la cabecera en una solicitud GET. Puede utilizar el mandato ibmcloud hpcs uko managed-key para recuperar el ETag.

Ejemplo

ibmcloud hpcs uko managed-key-deactivate \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --if-match=2022-05-27T10:13:31Z \
  --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "AWS-EXAMPLE-VAULT",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "template": {
    "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
    "name": "AWS-EXAMPLE-TEMPLATE",
    "type": [
      "user_defined"
    ],
    "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
  },
  "version": 1,
  "description": "AWS key template description",
  "label": "AWS-production-2029",
  "state": "active",
  "size": 256,
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method\"": "ENC-ZERO",
      "value": "C05CA1"
    }
  ],
  "activation_date": "2028-07-14",
  "expiration_date": "2029-09-25",
  "label_tags": [
    {
      "name": "APP",
      "value": "AWS"
    },
    {
      "name": "ENV",
      "value": "production"
    },
    {
      "name": "lay",
      "value": "2029"
    }
  ],
  "tags": [
    {
      "name": "TAG-1",
      "value": "AWS-TAG"
    }
  ],
  "created_at": "2023-06-05T10:40:13Z",
  "updated_at": "2023-06-05T10:40:19Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "referenced_keystores": [
    {
      "id": "0743ae15-c594-476d-8e9a-1564740ace53",
      "name": "AWS KMS Keystore 335",
      "type": "aws_kms",
      "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
    }
  ],
  "instances": [
    {
      "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
      "label_in_keystore": "AWS-production-2029",
      "type": "secret_key",
      "keystore": {
        "group\"": "Production-AWS-DE",
        "type\"": "aws_kms"
      }
    }
  ],
  "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
  "status_in_keystores": [
    {
      "keystore": {
        "id": "0743ae15-c594-476d-8e9a-1564740ace53",
        "name": "AWS KMS Keystore 335",
        "type": "aws_kms",
        "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
      },
      "status": "active",
      "keystore_sync_flag": "ok",
      "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
      "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
    }
  ]
}

hpcs uko managed-key-destroy

Destruya una clave gestionada y realice operaciones de destrucción de claves en los almacenes de claves del grupo de almacén de claves asociado con la clave gestionada. Esta operación no se puede deshacer. Asegúrese de que la clave gestionada esté en un estado deactivated antes de ejecutar este mandato.

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

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la clave. Puede utilizar el mandato ibmcloud hpcs uko managed-keys para recuperar el UUID de clave.

-- if-match (serie)

Obligatorio. Condición previa de la actualización, que es el valor de ETag de la cabecera en una solicitud GET. Puede utilizar el mandato ibmcloud hpcs uko managed-key para recuperar el ETag.

Ejemplo

ibmcloud hpcs uko managed-key-destroy \
  --id=21a7498e-2ae4-47ee-85ac-a19bf64e92fa \
  --if-match=2022-05-27T10:14:13Z \
  --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "id": "ceb54688-827c-4e31-afa8-4c0122465a5b",
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "AWS-EXAMPLE-VAULT",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "template": {
    "id": "7a4e3659-083b-4d77-8562-7081eb197e90",
    "name": "AWS-EXAMPLE-TEMPLATE",
    "type": [
      "user_defined"
    ],
    "href": "/v4/templates/7a4e3659-083b-4d77-8562-7081eb197e90"
  },
  "version": 1,
  "description": "AWS key template description",
  "label": "AWS-production-2029",
  "state": "active",
  "size": 256,
  "algorithm": "aes",
  "verification_patterns": [
    {
      "method\"": "ENC-ZERO",
      "value": "C05CA1"
    }
  ],
  "activation_date": "2028-07-14",
  "expiration_date": "2029-09-25",
  "label_tags": [
    {
      "name": "APP",
      "value": "AWS"
    },
    {
      "name": "ENV",
      "value": "production"
    },
    {
      "name": "lay",
      "value": "2029"
    }
  ],
  "tags": [
    {
      "name": "TAG-1",
      "value": "AWS-TAG"
    }
  ],
  "created_at": "2023-06-05T10:40:13Z",
  "updated_at": "2023-06-05T10:40:19Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "referenced_keystores": [
    {
      "id": "0743ae15-c594-476d-8e9a-1564740ace53",
      "name": "AWS KMS Keystore 335",
      "type": "aws_kms",
      "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
    }
  ],
  "instances": [
    {
      "id": "8c2bef79-dd15-477c-93f0-0ae62264d4b6",
      "label_in_keystore": "AWS-production-2029",
      "type": "secret_key",
      "keystore": {
        "group\"": "Production-AWS-DE",
        "type\"": "aws_kms"
      }
    }
  ],
  "href": "/v4/managed_keys/ceb54688-827c-4e31-afa8-4c0122465a5b",
  "status_in_keystores": [
    {
      "keystore": {
        "id": "0743ae15-c594-476d-8e9a-1564740ace53",
        "name": "AWS KMS Keystore 335",
        "type": "aws_kms",
        "href": "/v4/keystores/0743ae15-c594-476d-8e9a-1564740ace53"
      },
      "status": "active",
      "keystore_sync_flag": "ok",
      "keystore_sync_flag_detail": "active_key_is_active_in_keystore",
      "key_id_in_keystore": "arn:aws:kms:eu-central-1:584492040385:key/52eca0ad-79ca-4c16-8934-986ac5d14b73"
    }
  ]
}

uko managed-key-sync de hpcs

Realice la operación de sincronización en una clave gestionada para alinear los estados en los almacenes de claves asociados.

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

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la clave. Puede utilizar el mandato ibmcloud hpcs uko managed-keys para recuperar el UUID de clave.

-- if-match (serie)

Obligatorio. Condición previa de la actualización, que es el valor de ETag de la cabecera en una solicitud GET. Puede utilizar el mandato ibmcloud hpcs uko managed-key para recuperar el ETag.

Ejemplo

ibmcloud hpcs uko managed-key-sync \
    --id=b28bf13d-f49d-4b00-8b8d-457d38ad1e15 \
    --if-match=2022-05-27T10:14:13Z \
    --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.

El mandato devuelve una salida similar a la del ejemplo siguiente:

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

clave-plantillas hpcs uko

Listar todas las plantillas clave de la instancia.

Si la opción --all-pages no está establecida, el mandato sólo recupera una única página de la colección.

ibmcloud hpcs uko key-templates [--name NAME] [--naming-scheme NAME-SCHEME] [--vault-id VAULT-ID] [--key-algorithm KEY-ALGORITHM] [--key-size KEY-SIZE] [--key-size-min KEY-SIZE-MIN] [--key-size-max KEY-SIZE-MAX] [--keystores-type KEYSTORES-TYPE] [--keystores-group KEYSTORES-GROUP] [--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] [--type TYPE] [--state STATE] [--sort SORT] [--limit LIMIT] [--offset OFFSET] [--managing-systems MANAGING-SYSTEMS]

Opciones de mandato

--name (string)

Opcional. Devuelve sólo las plantillas cuyo nombre empieza por la serie.

-- naming-scheme (serie)

Opcional. Devuelve sólo las plantillas cuyo esquema de denominación contiene la serie.

-- vault-id (serie)

Opcional. El UUID de la caja fuerte. La longitud debe ser de 36 caracteres. El valor debe coincidir con la expresión regular /^[-0-9a-z]+$/.

-- key-algorithm (serie)

Opcional. El algoritmo de las plantillas de clave devueltas. Los valores que se pueden establecer son aes, rsa, hmac, ec, des y dilithium.

-- key-size (serie)

Opcional. El tamaño de la clave

--key-size-min (serie)

Opcional. El tamaño mínimo de la clave. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta key-size.

--key-size-max (serie)

Opcional. El tamaño máximo de la clave. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta key-size.

-- keystores-type (serie[])

Opcional. Tipo de almacén de claves referenciado. Los valores que se pueden establecer son aws_kms, azure_key_vault, ibm_cloud_kms, google_kms y cca.

-- keystores-group (serie[])

Opcional. Grupo de almacén de claves referenciado.

-- created-at (serie)

Opcional. Devolver sólo las claves gestionadas cuya hora de creación coincida con el parámetro. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at-min (serie)

Opcional. Devolver sólo las claves gestionadas cuya hora de creación sea igual o posterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta created_at. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at-max (serie)

Opcional. Devolver sólo las claves gestionadas cuya hora de creación sea igual o anterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta created_at. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- updated-at (serie)

Opcional. Devuelve sólo las claves gestionadas cuyo tiempo de actualización coincide con el parámetro. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at-min (serie)

Opcional. Devuelve sólo las claves gestionadas cuya hora de actualización es posterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta updated_at. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at-max (serie)

Opcional. Devolver sólo las claves gestionadas cuya hora de actualización sea anterior al valor del parámetro. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta updated_at. El valor debe coincidir con la expresión regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- type (serie[])

Opcional. Los tipos de plantillas devueltas. Los valores que se pueden establecer son user_defined, shadow y system.

-- state (serie[])

Opcional. Devuelve sólo la plantilla cuyo estado contiene la serie. Los valores que se pueden establecer son archived o unarchived.

-- sort (serie[])

Opcional. El orden de clasificación. El valor predeterminado es ["-updated_at"]. Los elementos de lista deben coincidir con la expresión regular /^-?[a-z0-9_.\\[\\],-]+$/.

--limit (int64)

Opcional. El número de plantillas de clave que se van a recuperar. El valor debe estar entre 1 y 1000.

--offset (int64)

Opcional. El número de claves a omitir. El valor mínimo es 0.

-- sistemas de gestión

Devolver sólo las claves gestionadas con los sistemas de gestión proporcionados. Los valores que se pueden establecer son web y workstation.

Ejemplo

ibmcloud hpcs uko key-templates --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "total_count": 3,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/templates?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20"
  },
  "last": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/templates?vault.id=5295ad47-2ce9-43c3-b9e7-e5a9482c362b&limit=20&offset=0"
  },
  "templates": [
    {
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "VAULT 391",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "id": "91caa113-d3ba-4620-a252-1c27aa31fd4e",
      "version": "0",
      "name": "AWS-TEMPLATE-229",
      "naming_scheme": "<APP>-AES256-<ENV>-<GROUP>-<lay>",
      "type": [
        "user_defined"
      ],
      "state": "unarchived",
      "keys_count": "0",
      "key": {
        "size": "256",
        "algorithm": "aes",
        "activation_date": "P5Y1M1W2D",
        "expiration_date": "P1Y2M1W4D",
        "state": "active"
      },
      "description": "AWS KMS KEY TEMPLATE",
      "created_at": "2023-06-05T14:16:07Z",
      "updated_at": "2023-06-05T14:16:07Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "keystores": [
        {
          "group": "Production-AWS-DE",
          "type": "aws_kms"
        }
      ],
      "href": "v4/templates/91caa113-d3ba-4620-a252-1c27aa31fd4e"
    },
    {
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault 391",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "id": "64f98479-392d-4af2-a076-77cc21b8c6f3",
      "version": "0",
      "name": "IBM-template-371",
      "naming_scheme": "IBMCloud<APP><ENV><lay>",
      "type": [
        "user_defined"
      ],
      "state": "unarchived",
      "keys_count": "0",
      "key": {
        "size": "256",
        "algorithm": "aes",
        "activation_date": "P5Y1M1W2D",
        "expiration_date": "P1Y2M1W4D",
        "state": "active"
      },
      "description": "IBM CLOUD key template description",
      "created_at": "2023-06-05T11:59:08Z",
      "updated_at": "2023-06-05T11:59:08Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "keystores": [
        {
          "group": "Production External GB",
          "type": "ibm_cloud_kms"
        }
      ],
      "href": "/v4/templates/64f98479-392d-4af2-a076-77cc21b8c6f3"
    },
    {
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault 391",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "id": "6393e930-562c-4042-b324-45c37d3d49d9",
      "version": "0",
      "name": "AZURE-TEMPLATE-920",
      "naming_scheme": "<APP><ENV><lay>",
      "type": [
        "user_defined"
      ],
      "state": "unarchived",
      "keys_count": "0",
      "key": {
        "size": "2048",
        "algorithm": "rsa",
        "activation_date": "P5Y1M1W2D",
        "expiration_date": "P1Y2M1W4D",
        "state": "active"
      },
      "description": "AZURE MANAGED KEY",
      "created_at": "2023-06-05T11:33:24Z",
      "updated_at": "2023-06-05T11:33:24Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "keystores": [
        {
          "group": "Production AZURE GB",
          "type": "azure_key_vault",
          "azure_key_protection_level": "software"
        }
      ],
      "href": "/v4/templates/6393e930-562c-4042-b324-45c37d3d49d9"
    },
    {
      "vault": {
        "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
        "name": "Vault 391",
        "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
      },
      "id": "09d229e5-e330-4e85-a7ee-cc8555d38603",
      "version": "0",
      "name": "GOOGLE-TEMPLATE-86",
      "naming_scheme": "<APP>-<ENV>-<lay>",
      "type": [
        "user_defined"
      ],
      "state": "unarchived",
      "keys_count": "0",
      "key": {
        "size": "256",
        "algorithm": "aes",
        "activation_date": "P5Y1M1W2D",
        "expiration_date": "P1Y2M1W4D",
        "state": "active"
      },
      "description": "Google Key Template",
      "created_at": "2023-06-05T13:17:01Z",
      "updated_at": "2023-06-05T13:17:01Z",
      "created_by": "IBMid-665000MCAR",
      "updated_by": "IBMid-665000MCAR",
      "keystores": [
        {
          "group": "Production Google",
          "type": "google_kms",
          "google_key_protection_level": "software",
          "google_key_purpose": "encrypt_decrypt",
          "google_kms_algorithm": "google_symmetric_encryption"
        }
      ],
      "href": "/v4/templates/09d229e5-e330-4e85-a7ee-cc8555d38603"
    }
  ]
}

ibmcloud hpcs uko key-template-crear

Cree una nueva plantilla de clave. Las plantillas clave se utilizan para combinar la información necesaria para crear una clave. Con las plantillas de claves, puede crear fácilmente claves posteriores sin especificar ningún detalle.

ibmcloud hpcs uko key-template-create --vault VAULT --name NAME --type TYPE --state STATE --naming-scheme NAMEING-SCHEME --key KEY --keystores KEYSTORES [--description DESCRIPTION]

Opciones de mandato

-- vault (VaultReferenceInCreationRequest)

Obligatorio. El ID de la caja fuerte donde se va a crear la plantilla de clave.

--name (string)

Obligatorio. El nombre de la plantilla. Debe hacer referencia a él al crear claves gestionadas. La longitud debe estar entre 1 y 30 caracteres. El valor debe coincidir con la expresión regular /^[A-Za-z][A-Za-z0-9-]*$/.

-- type (serie[])

Obligatorio. El tipo de la plantilla. Los valores que se pueden establecer son user_defined, shadow y system.

-- state (serie)

Obligatorio. El estado de la plantilla. Los valores que se pueden establecer son archived o unarchived.

-- naming-scheme (serie)

Obligatorio. El patrón de serie que el nombre de plantilla debe seguir.

-- key (KeyProperties)

Obligatorio. Propiedades que describen la clave gestionada.

-- keystores (KeystoresPropertiesCrear [])

Obligatorio. Una matriz que describe el tipo y el grupo de almacenes de claves en los que se va a instalar la clave gestionada. La longitud máxima es 1 elemento. La longitud mínima es 1 elemento.

--description (serie)

Opcional. La descripción de la plantilla de clave. La longitud debe estar entre 0 y 200 caracteres. El valor debe coincidir con la expresión regular /(.|\\n)*/.

Ejemplo

ibmcloud hpcs uko key-template-create \
    --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"}]' \
    --state="unarchived" \
    --naming-scheme="A-<APP>-AES256-<ENV>-<GROUP>" \
    --type="user_defined" \
    --description="IBM CLOUD key template description" \
    --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
Ubicación	Serie	Vía de acceso al recurso recién creado, relativo a la raíz de contexto.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "VAULT 391",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "id": "91caa113-d3ba-4620-a252-1c27aa31fd4e",
  "version": "0",
  "name": "AWS-TEMPLATE-229",
  "naming_scheme": "<APP>-AES256-<ENV>-<GROUP>-<lay>",
  "type": [
    "user_defined"
  ],
  "state": "unarchived",
  "keys_count": "0",
  "key": {
    "size": "256",
    "algorithm": "aes",
    "activation_date": "P5Y1M1W2D",
    "expiration_date": "P1Y2M1W4D",
    "state": "active"
  },
  "description": "AWS KMS KEY TEMPLATE",
  "created_at": "2023-06-05T14:16:07Z",
  "updated_at": "2023-06-05T14:16:07Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "keystores": [
    {
      "group": "Production-AWS-DE",
      "type": "aws_kms"
    }
  ],
  "href": "v4/templates/91caa113-d3ba-4620-a252-1c27aa31fd4e"
}

uko key-template-delete de hpcs

Suprimir una plantilla de clave de la caja fuerte. Asegúrese de que no haya ninguna clave gestionada asociada con la plantilla de clave antes de ejecutar este mandato.

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

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la plantilla. Puede utilizar el mandato ibmcloud hpcs uko key-templates para recuperar el UUID.

-- if-match (serie)

Obligatorio. Condición previa de la actualización, que es el valor de ETag de la cabecera en una solicitud GET. Puede utilizar el mandato ibmcloud hpcs uko key-template para recuperar el ETag.

Ejemplo

ibmcloud hpcs uko key-template-delete \
    --id=07b62c12-75a2-46c9-9259-0cecde3985d2 \
    --if-match=2022-05-11T14:58:26Z

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.

El mandato devuelve una salida similar a la del ejemplo siguiente:

...
OK

ibmcloud hpcs uko key-template

Recupere una plantilla de clave y sus detalles especificando el ID.

ibmcloud hpcs uko key-template --id ID

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la plantilla. Puede utilizar el mandato ibmcloud hpcs uko key-templates para recuperar el UUID.

Ejemplo

ibmcloud hpcs uko key-template \
    --id=07b62c12-75a2-46c9-9259-0cecde3985d2 \
    --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "VAULT 391",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "id": "91caa113-d3ba-4620-a252-1c27aa31fd4e",
  "version": "0",
  "name": "AWS-TEMPLATE-229",
  "naming_scheme": "<APP>-AES256-<ENV>-<GROUP>-<lay>",
  "type": [
    "user_defined"
  ],
  "state": "unarchived",
  "keys_count": "0",
  "key": {
    "size": "256",
    "algorithm": "aes",
    "activation_date": "P5Y1M1W2D",
    "expiration_date": "P1Y2M1W4D",
    "state": "active"
  },
  "description": "AWS KMS KEY TEMPLATE",
  "created_at": "2023-06-05T14:16:07Z",
  "updated_at": "2023-06-05T14:16:07Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "keystores": [
    {
      "group": "Production-AWS-DE",
      "type": "aws_kms"
    }
  ],
  "href": "v4/templates/91caa113-d3ba-4620-a252-1c27aa31fd4e"
}

uko key-template-update de hpcs

Actualizar atributos de una plantilla de clave.

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

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la plantilla. Puede utilizar el mandato ibmcloud hpcs uko key-templates para recuperar el UUID.

-- if-match (serie)

Obligatorio. Condición previa de la actualización, que es el valor de ETag de la cabecera en una solicitud GET. Puede utilizar el mandato ibmcloud hpcs uko key-template para recuperar el ETag.

--name (string)

Opcional. El nombre de plantilla actualizado.

-- keystores (KeystoresPropertiesActualizar [])

Opcional. Una matriz que describe el tipo y el grupo de almacenes de claves donde se va a instalar la clave gestionada. La longitud máxima es 1 elemento. La longitud mínima es 1 elemento.

--description (serie)

Opcional. La descripción actualizada de la plantilla de clave. La longitud debe estar entre 0 y 200 caracteres. El valor debe coincidir con la expresión regular /(.|\\n)*/.

-- key (KeyPropertiesActualizar)

Opcional. Propiedades de la clave gestionada.

Ejemplo

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

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "vault": {
    "id": "1d3b402a-ce40-4b17-b6f0-a7fa26ba72de",
    "name": "VAULT 391",
    "href": "/v4/vaults/1d3b402a-ce40-4b17-b6f0-a7fa26ba72de"
  },
  "id": "91caa113-d3ba-4620-a252-1c27aa31fd4e",
  "version": "0",
  "name": "AWS-TEMPLATE-229",
  "naming_scheme": "<APP>-AES256-<ENV>-<GROUP>-<lay>",
  "type": [
    "user_defined"
  ],
  "state": "unarchived",
  "keys_count": "0",
  "key": {
    "size": "256",
    "algorithm": "aes",
    "activation_date": "P5Y1M1W2D",
    "expiration_date": "P1Y2M1W4D",
    "state": "active"
  },
  "description": "AWS KMS KEY TEMPLATE",
  "created_at": "2023-06-05T14:16:07Z",
  "updated_at": "2023-06-05T14:16:07Z",
  "created_by": "IBMid-665000MCAR",
  "updated_by": "IBMid-665000MCAR",
  "keystores": [
    {
      "group": "Production-AWS-DE",
      "type": "aws_kms"
    }
  ],
  "href": "v4/templates/91caa113-d3ba-4620-a252-1c27aa31fd4e"
}

almacenes de claves uko hpcs

Listar todos los almacenes de claves de la instancia.

Si la opción --all-pages no está establecida, el mandato sólo recupera una única página de la colección.

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]

Opciones de mandato

-- type (serie[])

Opcional. El tipo de almacenes de claves que desea recuperar. Los valores que se pueden establecer son: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms y cca.

--name (string)

Opcional. Devuelve sólo los almacenes de claves cuyo nombre contiene la serie. La longitud debe estar entre 1 y 100 caracteres. El valor debe coincidir con la expresión regular /.+/.

--description (serie)

Opcional. Devolver sólo los almacenes de claves cuya descripción contenga la serie. La longitud debe estar entre 1 y 200 caracteres. El valor debe coincidir con la expresión regular /.+/.

-- group (serie)

Opcional. El grupo de almacén de claves. Este parámetro de consulta no se puede utilizar junto con el parámetro de consulta groups[].

--groups ([]serie)

Opcional. Grupos de almacén de claves.

-- vault-id (serie[])

Opcional. El UUID de la caja fuerte. Los elementos de lista deben coincidir con la expresión regular /^[-0-9a-z]+$/.

-- location (serie)

Opcional. Ubicación del almacén de claves.

--limit (int64)

Opcional. El número de almacenes de claves a recuperar. El valor debe estar entre 1 y 1000.

--offset (int64)

Opcional. El número de claves a omitir. El valor mínimo es 0.

-- sort (serie[])

Opcional. El orden de clasificación. El valor predeterminado es ["-updated_at"]. Los elementos de lista deben coincidir con la expresión regular /^-?[a-z0-9_.\\[\\],-]+$/.

-- all-pages (bool)

Opcional. Invoque varias solicitudes para visualizar todas las páginas de la colección para almacenes de claves.

Ejemplo

ibmcloud hpcs uko keystores --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "total_count": 3,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/keystores?limit=20"
  },
  "last": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/keystores?limit=20&offset=0"
  },
  "keystores": [
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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-crear

Cree un almacén de claves interno o conéctese a un almacén de claves externo del tipo solicitado. Si se utiliza el parámetro de consulta dry_run, no se crean almacenes de claves en la base de datos y sólo se realiza una prueba para verificar si la información de conexión es correcta. Es posible ordenar por los parámetros siguientes: name, created_at, updated_at, vault-id.

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

Opciones de mandato

-- keystore-body (KeystoreCreationSolicitud)

Obligatorio. Propiedades del almacén de claves al que desea crear o conectar.

--dry-run (bool)

Opcional. Realice una prueba para verificar si un almacén de claves creado con los parámetros especificados se puede comunicar correctamente. No se crean almacenes de claves en la base de datos. El valor predeterminado es false.

Ejemplo

ibmcloud hpcs uko keystore-create \
    --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

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
Ubicación	Serie	Vía de acceso al recurso recién creado, relativo a la raíz de contexto.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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 keystore-suprimir

Suprima un almacén de claves interno o elimine una conexión con un almacén de claves externo. El almacén de claves externo en la plataforma remota sigue existiendo después de eliminar la conexión.

ibmcloud hpcs uko keystore-delete --id ID --if-match IF-MATCH [--mode MODE]

Opciones de mandato

--id (serie)

Obligatorio. El UUID del almacén de claves. Puede utilizar el mandato ibmcloud hpcs uko keystores para recuperar el UUID.

-- if-match (serie)

Obligatorio. Condición previa de la actualización, que es el valor de ETag de la cabecera en una solicitud GET. Puede utilizar el mandato ibmcloud hpcs uko keystore para recuperar el ETag.

-- mode (serie)

Opcional. Modalidad de desconexión del almacén de claves. Los valores que se pueden establecer son restrict, disconnect, deactivate y destroy. El valor predeterminado es restrict.

Ejemplo

ibmcloud hpcs uko keystore-delete \
    --id=0325e05e-2b25-4f13-85b2-2d7f85e54359 \
    --if-match=2022-05-11T14:58:26Z

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.

El mandato devuelve una salida similar a la del ejemplo siguiente:

...
OK

almacén de claves uko hpcs

Recupere un almacén de claves interno de destino o una conexión de almacén de claves externo y sus detalles especificando el ID.

ibmcloud hpcs uko keystore --id ID

Opciones de mandato

--id (serie)

Obligatorio. El UUID del almacén de claves. Puede utilizar el mandato ibmcloud hpcs uko keystores para recuperar el UUID.

Ejemplo

ibmcloud hpcs uko keystore \
    --id=0325e05e-2b25-4f13-85b2-2d7f85e54359 \
    --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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-update

Actualizar atributos de un almacén de claves interno o una conexión de almacén de claves externo.

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

Opciones de mandato

--id (serie)

Obligatorio. El UUID del almacén de claves. Puede utilizar el mandato ibmcloud hpcs uko keystores para recuperar el UUID.

-- if-match (serie)

Obligatorio. Condición previa de la actualización, que es el valor de ETag de la cabecera en una solicitud GET. Puede utilizar el mandato ibmcloud hpcs uko keystore para recuperar el ETag.

-- keystore-body (KeystoreUpdateSolicitud)

Obligatorio. Propiedades de almacén de claves que desea actualizar.

Ejemplo

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

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "vault": {
    "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
    "name": "Test Vault Name",
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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 asociado-resources-for-target-keystore

Obtenga una lista de recursos asociados con todas las claves que están activadas en este almacén de claves.

Si la opción --all-pages no está establecida, el mandato sólo recupera una única página de la colección.

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

Opciones de mandato

--id (serie)

Obligatorio. El UUID del almacén de claves. Puede utilizar el mandato ibmcloud hpcs uko keystores para recuperar el UUID.

--limit (int64)

Opcional. El número de recursos a recuperar. El valor debe estar entre 1 y 1000.

--offset (int64)

Opcional. El número de recursos a omitir. El valor mínimo es 0.

-- sort (serie[])

Opcional. El orden de clasificación. El valor predeterminado es ["name"]. Los elementos de lista deben coincidir con la expresión regular /^-?[a-z0-9_.\\[\\],-]+$/.

-- all-pages (bool)

Opcional. Invoque varias solicitudes para visualizar todas las páginas de la colección para los recursos asociados para el almacén de claves.

Ejemplo

ibmcloud hpcs uko associated-resources-for-target-keystore \
--id=93777bca-baef-4070-b9b5-a2e6079df1b4 \
--output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "total_count": 3,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_key/5295ad47-2ce9-43c3-b9e7-e5a9482c362b/associated_resources?limit=20"
  },
  "last": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_key/5295ad47-2ce9-43c3-b9e7-e5a9482c362b/associated_resources?limit=20&offset=0"
  },
  "previous": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_keys?offset=80"
  },
  "next": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_keys?offset=120"
  },
  "associated_resources": [
    {
      "vault": {
        "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
        "name": "Test Vault Name",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "managed_key": {
        "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
        "name": "My Managed Key",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/managed_keys/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
      },
      "referenced_keystore": {
        "id": "93777bca-baef-4070-b9b5-a2e6079df1b4",
        "name": "My Managed Key",
        "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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"
      }
    }
  ]
}

almacén de claves uko hpcs-status

Recuperar el estado de un almacén de claves interno o externo de destino.

ibmcloud hpcs uko keystore-status --id ID

Opciones de mandato

--id (serie)

Obligatorio. El UUID del almacén de claves. Puede utilizar el mandato ibmcloud hpcs uko keystores para recuperar el UUID.

Ejemplo

ibmcloud hpcs uko keystore-status \
    --id=0325e05e-2b25-4f13-85b2-2d7f85e54359 \
    --output json

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.

El mandato devuelve una salida similar a la del ejemplo siguiente:

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

Cajas fuertes uko de hpcs

Listar todas las cajas fuertes de la instancia.

Si la opción --all-pages no está establecida, el mandato sólo recupera una única página de la colección.

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

Opciones de mandato

--limit (int64)

Opcional. El número de cajas fuertes a recuperar. El valor máximo es 1000. El valor mínimo es 1.

--offset (int64)

Opcional. El número de cajas fuertes que se van a omitir. El valor mínimo es 0.

-- sort (serie[])

Opcional. El orden de clasificación. El valor predeterminado es ["-updated_at"]. Los elementos de lista deben coincidir con la expresión regular /^-?[a-z0-9_.\\[\\],-]+$/.

--name (string)

Opcional. Devolver sólo cajas fuertes cuyos nombres empiecen por la serie. La longitud debe estar entre 1 y 100 caracteres. El valor debe coincidir con la expresión regular /.+/.

--description (serie)

Opcional. Devolver sólo cajas fuertes cuya descripción contenga la serie. La longitud debe estar entre 1 y 200 caracteres. El valor debe coincidir con la expresión regular /.+/.

-- all-pages (bool)

Opcional. Invoque varias solicitudes para visualizar todas las páginas de la colección para cajas fuertes.
Ejemplo
```
ibmcloud hpcs uko vaults --output json
```

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "total_count": 2,
  "limit": 20,
  "offset": 0,
  "first": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults?limit=20&limit=20&offset=0"
  },
  "last": {
    "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/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://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b"
    }
  ]
}

hpcs uko vault-crear

Cree una caja fuerte en la instancia con el nombre y la descripción especificados.

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

Opciones de mandato

--name (string)

Obligatorio. Un nombre legible para asignar a la caja fuerte. Para proteger su privacidad, no utilice datos personales, como su nombre o ubicación. La longitud debe estar entre 1 y 100 caracteres. El valor debe coincidir con la expresión regular /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/.

--description (serie)

Opcional. La descripción de la caja fuerte. La longitud debe estar entre 0 y 200 caracteres. El valor debe coincidir con la expresión regular /(.|\\n)*/.

Ejemplo

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

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "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",
  "recovery_key_label": "TEKMF.AES.RECOVERY.00001",
  "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
  "keys_count": 100,
  "key_templates_count": 10,
  "keystores_count": 0
}

hpcs uko vault-suprimir

Suprimir una caja fuerte de la instancia. Asegúrese de que no haya claves o almacenes de claves conectados a la caja fuerte antes de ejecutar este mandato.

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

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la caja fuerte. Puede utilizar el mandato ibmcloud hpcs uko vaults para recuperar el UUID.

-- if-match (serie)

Obligatorio. Condición previa de la actualización, que es el valor de ETag de la cabecera en una solicitud GET. Puede utilizar el mandato ibmcloud hpcs uko vault para recuperar el ETag.

Ejemplo

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

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.

El mandato devuelve una salida similar a la del ejemplo siguiente:

...
OK

Caja fuerte uko de hpcs

Recupere una caja fuerte y sus detalles especificando el ID.

ibmcloud hpcs uko vault --id ID

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la caja fuerte. Puede utilizar el mandato ibmcloud hpcs uko vaults para recuperar el UUID.

Ejemplo

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

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "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",
  "recovery_key_label": "TEKMF.AES.RECOVERY.00001",
  "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
  "keys_count": 100,
  "key_templates_count": 10,
  "keystores_count": 0
}

hpcs uko vault-actualizar

Actualizar atributos de una caja fuerte.

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

Opciones de mandato

--id (serie)

Obligatorio. El UUID de la caja fuerte. Puede utilizar el mandato ibmcloud hpcs uko vaults para recuperar el UUID.

-- if-match (serie)

Obligatorio. Condición previa de la actualización, que es el valor de ETag de la cabecera en una solicitud GET. Puede utilizar el mandato ibmcloud hpcs uko vault para recuperar el ETag.

--name (string)

Opcional. Nombre actualizado de la caja fuerte de vault.The debe estar entre 1 y 100 caracteres. El valor debe coincidir con la expresión regular /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/.

--description (serie)

Opcional. Se ha actualizado la descripción de la caja fuerte. La longitud debe estar entre 0 y 200 caracteres. El valor debe coincidir con la expresión regular /(.|\\n)*/.

Ejemplo

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

Salida

Headers:

Tabla. Cabeceras de salida de mandato
Nombre	Tipo	Descripción
X-ID-correlación	Serie	Identificador exclusivo que se adjunta a solicitudes y mensajes que permiten hacer referencia a una transacción o cadena de sucesos determinada.
ETag	Serie	Identificador de una versión específica del recurso.

El mandato devuelve una salida similar a la del ejemplo siguiente:

{
  "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",
  "recovery_key_label": "TEKMF.AES.RECOVERY.00001",
  "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
  "keys_count": 100,
  "key_templates_count": 10,
  "keystores_count": 0
}

Unified Key Orchestrator Ejemplos de esquema de mandatos de plugin de CLI

Los siguientes ejemplos de esquema representan los datos que necesita especificar para algunas opciones de mandato. Estos ejemplos muestran la estructura de datos e incluyen valores de marcador para los tipos de valores esperados. Cuando ejecute un mandato, sustituya estos valores por los valores que se aplican a su entorno según corresponda.

KeyProperties

El ejemplo siguiente muestra el formato del objeto KeyProperties.

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

Actualización de KeyProperties

El ejemplo siguiente muestra el formato del objeto KeyPropertiesUpdate.

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

Solicitud KeystoreCreation

El ejemplo siguiente muestra el formato del objeto KeystoreCreationRequest.

{
  "name": "IBM Cloud Keystore",
  "description": "IBM Cloud Keystore description.",
  "groups": [
    "Production"
  ],
  "ibm_api_endpoint": "https://us-south.kms.cloud.ibm.com",
  "ibm_iam_endpoint": "https://iam.bluemix.net/identity/token",
  "ibm_api_key": "bxgstahGH8273662-HGD8765ghsvv-hsjbv786KJHV",
  "ibm_instance_id": "r64jshf0a4-jh87-8476-jks3-9752hgdvs",
  "vault": {
    "id": "75d0f626-44b0-4076-80cd-8cb9e485fe73"
  },
  "ibm_variant": "hpcs",
  "ibm_key_ring": "IBM-Cloud-KMS-Internal",
  "type": "ibm_cloud_kms"
}

Solicitud KeystoreUpdate

El ejemplo siguiente muestra el formato del objeto KeystoreUpdateRequest.

{
  "name": "IBM Cloud Keystore",
  "description": "IBM Cloud Keystore description.",
  "groups": [
    "Production"
  ],
  "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": "c9e2e2d5-013a-409f-93cf-5393972263d7",
  "ibm_key_ring": "Key-Ring-1"
}

KeystoresPropertiesCrear[]

El ejemplo siguiente muestra el formato del objeto KeystoresPropertiesCreate[].


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

KeystoresPropertiesActualizar[]

El ejemplo siguiente muestra el formato del objeto KeystoresPropertiesUpdate[].

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

Etiqueta[]

El ejemplo siguiente muestra el formato del objeto Tag[].

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

VaultReferenceInCreationSolicitud

El ejemplo siguiente muestra el formato del objeto VaultReferenceInCreationRequest.

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