hpcs-cert-mgr adminkey get

Cette commande permet d'extraire la clé de signature de l'administrateur du certificat.

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

• Options de commande

  --crn HPCS_CRN

  Obligatoire. Le crn de votre instance Hyper Protect Crypto Services. Vous pouvez utiliser la commande ibmcloud resource service-instances --long pour extraire le crn.

  --private

  Optionnel. Si vous utilisez cette option, l'URL du serveur du gestionnaire de certificats pointe vers le réseau privé. Par exemple, cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region est l'abréviation de la zone géographique dans laquelle vous vous connectez à IBM Cloud. Dans ce cas, vous devez utiliser le réseau privé pour connecter votre instance de service.

• Example

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

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

• Sortie

  La commande renvoie une sortie similaire à l'exemple suivant:

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

hpcs-cert-mgr adminkey set

Cette commande permet de créer la clé de signature de l'administrateur pour que l'administrateur de certificats se connecte au serveur du gestionnaire de certificats.

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

• Options de commande

  --crn HPCS_CRN

  Obligatoire. Le crn de votre instance Hyper Protect Crypto Services. Vous pouvez utiliser la commande ibmcloud resource service-instances --long pour extraire le crn.

  --private

  Optionnel. Si vous utilisez cette option, l'URL du serveur du gestionnaire de certificats pointe vers le réseau privé. Par exemple, cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region est l'abréviation de la zone géographique dans laquelle vous vous connectez à IBM Cloud. Dans ce cas, vous devez utiliser le réseau privé pour connecter votre instance de service.

• Example

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

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

• Sortie

  La commande renvoie une sortie similaire à l'exemple suivant:

  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

Cette commande permet d'actualiser et de mettre à jour la clé de signature de l'administrateur du certificat.

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

• Options de commande

  --crn HPCS_CRN

  Obligatoire. Le crn de votre instance Hyper Protect Crypto Services. Vous pouvez utiliser la commande ibmcloud resource service-instances --long pour extraire le crn.

  --admin-priv-key ADMIN_PRIV_KEY

  Obligatoire. Le chemin de fichier de votre clé privée actuelle qui est stockée sur votre poste de travail local. La clé privée est utilisée pour signer cette action de commande vers votre serveur de gestionnaire de certificat d'instance.

  --private

  Optionnel. Si vous utilisez cette option, l'URL du serveur du gestionnaire de certificats pointe vers le réseau privé. Par exemple, cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region est l'abréviation de la zone géographique dans laquelle vous vous connectez à IBM Cloud. Dans ce cas, vous devez utiliser le réseau privé pour connecter votre instance de service.

• Example

  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}
  

• Sortie

  La commande renvoie une sortie similaire à l'exemple suivant:

  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

Cette commande permet de supprimer la clé de signature de l'administrateur du certificat.

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

• Options de commande

  --crn HPCS_CRN

  Obligatoire. Le crn de votre instance Hyper Protect Crypto Services. Vous pouvez utiliser la commande ibmcloud resource service-instances --long pour extraire le crn.

  --admin-priv-key ADMIN_PRIV_KEY

  Obligatoire. Le chemin de fichier de votre clé privée actuelle qui est stockée sur votre poste de travail local. La clé privée est utilisée pour signer cette action de commande vers votre serveur de gestionnaire de certificat d'instance.

  --private

  Optionnel. Si vous utilisez cette option, l'URL du serveur du gestionnaire de certificats pointe vers le réseau privé. Par exemple, cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region est l'abréviation de la zone géographique dans laquelle vous vous connectez à IBM Cloud. Dans ce cas, vous devez utiliser le réseau privé pour connecter votre instance de service.

• Example

  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}
  

• Sortie

  La commande renvoie une sortie similaire à l'exemple suivant:

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

hpcs-cert-mgr cert get

Cette commande permet d'extraire le certificat client sur votre serveur de gestionnaire de certificats d'instance.

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

• Options de commande

  --crn HPCS_CRN

  Obligatoire. Le crn de votre instance Hyper Protect Crypto Services. Vous pouvez utiliser la commande ibmcloud resource service-instances --long pour extraire le crn.

  --cert-id CERT_ID

  Obligatoire. L'ID de la chaîne du certificat client que vous souhaitez extraire.

  --cert-store-file CERT_FILE

  Optionnel. Le chemin d'accès au fichier pour stocker le certificat extrait. Si vous indiquez cette option, le fichier est créé sur votre poste de travail local et stocke le contenu du certificat.

  --private

  Optionnel. Si vous utilisez cette option, l'URL du serveur du gestionnaire de certificats pointe vers le réseau privé. Par exemple, cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region est l'abréviation de la zone géographique dans laquelle vous vous connectez à IBM Cloud. Dans ce cas, vous devez utiliser le réseau privé pour connecter votre instance de service.

• Example

  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
  

• Sortie

  La commande renvoie une sortie similaire à l'exemple suivant:

  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

Cette commande permet de définir des certificats client pour votre serveur de gestionnaire de certificats d'instance.

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

• Options de commande

  --crn HPCS_CRN

  Obligatoire. Le crn de votre instance Hyper Protect Crypto Services. Vous pouvez utiliser la commande ibmcloud resource service-instances --long pour extraire le crn.

  --admin-priv-key ADMIN_PRIV_KEY

  Obligatoire. Le chemin de fichier de votre clé privée actuelle qui est stockée sur votre poste de travail local. La clé privée est utilisée pour signer cette action de commande vers votre serveur de gestionnaire de certificat d'instance.

  --cert-id CERT_ID

  Obligatoire. L'ID de la chaîne que vous souhaitez affecter au certificat pour une identification facile.

  --cert CERT_FILE

  Obligatoire. Le fichier de certificat stocké sur votre poste de travail. Il est conseillé d'utiliser le Gestionnaire de certificats IBM Cloud pour ordonner et gérer les certificats SSL/TLS pour vos applications et services.

  --private

  Optionnel. Si vous utilisez cette option, l'URL du serveur du gestionnaire de certificats pointe vers le réseau privé. Par exemple, cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region est l'abréviation de la zone géographique dans laquelle vous vous connectez à IBM Cloud. Dans ce cas, vous devez utiliser le réseau privé pour connecter votre instance de service.

• Example

  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}
  

• Sortie

  La commande renvoie une sortie similaire à l'exemple suivant:

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

hpcs-cert-mgr cert list

Cette commande permet de répertorier tous les certificats gérés par l'administrateur pour votre serveur de gestionnaire de certificats d'instance.

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

• Options de commande

  --crn HPCS_CRN

  Obligatoire. Le crn de votre instance Hyper Protect Crypto Services. Vous pouvez utiliser la commande ibmcloud resource service-instances --long pour extraire le crn.

  --private

  Optionnel. Si vous utilisez cette option, l'URL du serveur du gestionnaire de certificats pointe vers le réseau privé. Par exemple, cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region est l'abréviation de la zone géographique dans laquelle vous vous connectez à IBM Cloud. Dans ce cas, vous devez utiliser le réseau privé pour connecter votre instance de service.

• Example

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

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

• Sortie

  La commande renvoie une sortie similaire à l'exemple suivant:

  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

Cette commande permet de supprimer des certificats client pour votre serveur de gestionnaire de certificats d'instance.

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

• Options de commande

  --crn HPCS_CRN

  Obligatoire. Le crn de votre instance Hyper Protect Crypto Services. Vous pouvez utiliser la commande ibmcloud resource service-instances --long pour extraire le crn.

  --admin-priv-key ADMIN_PRIV_KEY

  Obligatoire. Le chemin de fichier de votre clé privée actuelle qui est stockée sur votre poste de travail local. La clé privée est utilisée pour signer cette action de commande vers votre serveur de gestionnaire de certificat d'instance.

  --cert-id CERT_ID

  Obligatoire. L'ID de la chaîne du certificat que vous souhaitez supprimer.

  --private

  Optionnel. Si vous utilisez cette option, l'URL du serveur du gestionnaire de certificats pointe vers le réseau privé. Par exemple, cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. La region est l'abréviation de la zone géographique dans laquelle vous vous connectez à IBM Cloud. Dans ce cas, vous devez utiliser le réseau privé pour connecter votre instance de service.

• Example

  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
  

• Sortie

  La commande renvoie une sortie similaire à l'exemple suivant:

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

Clés gérées hpcs uko

Répertorier toutes les clés gérées dans l'instance. Il est possible de trier par les paramètres suivants: label, algorithm, state, activation-date, deactivation-date, created-at, updated-at, size, vault-id.

Si l'option --all-pages n'est pas définie, la commande n'extrait qu'une seule page de la collection.

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]

• Options de commande

  -- vault-id (chaîne[])

  Optionnel. Identificateur unique universel (UUID) du coffre. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-keys pour extraire l'identificateur unique universel. La longueur doit être de 36 caractères. Les éléments de liste doivent correspondre à l'expression régulière /^[-0-9a-z]+$/.

  -- algorithm (chaîne[])

  Optionnel. Algorithme des clés renvoyées. Les valeurs pouvant être définies sont aes, rsa, hmac, ec, des et dilithium.

  -- state (chaîne[])

  Optionnel. Etat dans lequel doivent se trouver les clés renvoyées. La valeur par défaut est ["pre_activation","active"]. Les valeurs pouvant être définies sont les suivantes: pre_activation, active, deactivated, destroyed, compromised et destroyed_compromised.

  --limit (int64)

  Optionnel. Nombre de clés à extraire. La valeur maximale est 1000. La valeur minimale est 1. La valeur par défaut est 20.

  --offset (int64)

  Optionnel. Nombre de clés à ignorer. Valeur minimale : 0.

  -- sort (chaîne[])

  Optionnel. Ordre de tri. La valeur par défaut est ["-updated_at"]. Les éléments de liste doivent correspondre à l'expression régulière /^-?[a-z0-9_.\\[\\],-]+$/.

  -- label (chaîne)

  Optionnel. Libellé de la clé. La valeur doit correspondre à l'expression régulière /.+/.

  -- activation-date (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date d'activation correspond au paramètre. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --activation-date-min (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date d'activation est égale ou postérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête activation_date. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --activation-date-max (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date d'activation est égale ou antérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête activation_date. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --desactivation-date (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date de désactivation correspond au paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête expiration_date. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --desactivation-date-min (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date de désactivation est égale ou postérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec les paramètres de requête deactivation_date, expiration_date, expiration_date_min et expiration_date_max. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --desactivation-date-max (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date de désactivation est égale ou antérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec les paramètres de requête deactivation_date, expiration_date, expiration_date_min et expiration_date_max. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  -- expiration-date (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date de désactivation correspond au paramètre. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --expiration-date-min (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date de désactivation est égale ou postérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec les paramètres de requête deactivation_date, expiration_date, deactivation_date_min et deactivation_date_max. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --expiration-date-max (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date de désactivation est égale ou antérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec les paramètres de requête deactivation_date, expiration_date, deactivation_date_min et deactivation_date_max. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  -- created-at (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de création correspond au paramètre. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --created-at-min (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de création est égale ou postérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête created_at. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --created-at-max (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de création est égale ou antérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête created_at. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  -- updated-at (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de mise à jour correspond au paramètre. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --updated-at-min (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de mise à jour est postérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête updated_at. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --updated-at-max (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de mise à jour est antérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête updated_at. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  ---tourné-à-min (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la durée de rotation est postérieure à la valeur du paramètre.

  --rotatif-à-max (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la durée de rotation est antérieure à la valeur du paramètre.

  -- size (int64)

  Optionnel. Taille de la clé.

  -- size-min (int64)

  Optionnel. Taille minimale de la clé. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête size.

  -- size-max (int64)

  Optionnel. Taille maximale de la clé. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête size.

  --reference-keystores-type (chaîne[])

  Optionnel. Type du magasin de clés référencé. Les valeurs pouvant être définies sont aws_kms, azure_key_vault, ibm_cloud_kms, google_kms et cca.

  --references-keystores-name (chaîne[])

  Optionnel. Nom du magasin de clés référencé. Les éléments de liste doivent correspondre à l'expression régulière /[^,]+/.

  --instances-keystore-type (chaîne[])

  Optionnel. Type de magasin de clés pris en charge par l'une des instances. Les valeurs pouvant être définies sont aws_kms, azure_key_vault, ibm_cloud_kms, google_kms et cca.

  -- template-name (chaîne)

  Renvoie uniquement les clés gérées dont le nom de modèle commence par la chaîne.

  -- template-id (chaîne[])

  Renvoie uniquement les clés gérées avec l'identificateur unique universel de modèle donné.

  -- template-type (chaîne[])

  Renvoie uniquement les clés gérées avec le type de modèle donné. Les valeurs pouvant être définies sont user_defined, shadow et system.

  -- gestion-systèmes

  Renvoie uniquement les clés gérées avec les systèmes de gestion indiqués. Les valeurs pouvant être définies sont web et workstation.

  -- all-pages (bool)

  Optionnel. Appelez plusieurs demandes pour afficher toutes les pages de la collection pour les clés gérées.

• Example

  ibmcloud hpcs uko managed-keys --output json
  

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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"
          }
        ]
      }
    ]
  }
  

hpcs uko managed-key-create

Créez une nouvelle clé basée sur le modèle fourni. Le modèle doit exister dans votre instance pour que vous puissiez exécuter cette commande.

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

• Options de commande

  -- template-name (chaîne)

  Obligatoire. Nom du modèle de clé à utiliser lorsque vous créez une clé. La longueur doit être comprise entre 1 et 30 caractères. La valeur doit correspondre à l'expression régulière /^[A-Za-z][A-Za-z0-9-]+$/.

  -- vault (VaultReferenceInCreationInCreation)

  Obligatoire. ID du coffre dans lequel la clé gérée doit être créée.

  -- label (chaîne)

  Obligatoire. Libellé de la clé. La longueur doit être comprise entre 1 et 255 caractères. La valeur doit correspondre à l'expression régulière /^[A-Za-z0-9._ \/-]+$/.

  -- tags (Balise [])

  Optionnel. Paires clé-valeur associées à la clé. La longueur doit être comprise entre 0 et 128 éléments.

  --description (chaîne)

  Optionnel. Description de la clé gérée. La longueur doit être comprise entre 0 et 200 caractères. La valeur doit correspondre à l'expression régulière /(.|\\n)*/.

• Example

  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
  

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  Emplacement	Chaîne	Chemin d'accès à la ressource nouvellement créée, relatif à la racine de contexte.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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-delete

Supprimez une clé gérée par ID de clé du coffre. Vérifiez que la clé est à l'état Détruit avant d'exécuter cette commande.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel de la clé. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-keys pour extraire l'identificateur unique universel de la clé.

  -- if-match (chaîne)

  Obligatoire. Précondition de la mise à jour, qui correspond à la valeur de l'étiquette ETag de l'en-tête d'une demande GET. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-key pour extraire l'étiquette ETag.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.

  La commande renvoie une sortie similaire à l'exemple suivant:

  ...
  OK
  

Clé gérée hpcs uko

Extrayez une clé gérée et ses détails en spécifiant l'ID de clé.

ibmcloud hpcs uko managed-key --id ID

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel de la clé. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-keys pour extraire l'identificateur unique universel de la clé.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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-update

Mettre à jour les attributs d'une clé gérée. Vous pouvez uniquement modifier l'état de la clé séparément des autres modifications. La modification de l'état d'une clé affecte sa disponibilité pour les opérations cryptographiques dans les magasins de clés.

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]

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel de la clé. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-keys pour extraire l'identificateur unique universel de la clé.

  -- if-match (chaîne)

  Obligatoire. Précondition de la mise à jour, qui correspond à la valeur de l'étiquette ETag de l'en-tête d'une demande GET. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-key pour extraire l'étiquette ETag.

  -- label (chaîne)

  Obligatoire. Libellé de la clé. La longueur doit être comprise entre 1 et 255 caractères. La valeur doit correspondre à l'expression régulière /^[A-Za-z0-9._ \/-]+$/.

  -- activation-date (strfmt.Date)

  Optionnel. La date d'activation doit être indiquée au format AAAA-MM-JJ.

  -- expiration-date (strfmt.Date)

  Optionnel. La date d'expiration doit être fournie au format AAAA-MM-JJ.

  -- tags (Balise [])

  Optionnel. Paires clé-valeur associées à la clé. La longueur doit être comprise entre 0 et 128 éléments.

  --description (chaîne)

  Optionnel. Description de la clé gérée. La longueur doit être comprise entre 0 et 200 caractères. La valeur doit correspondre à l'expression régulière /(.|\\n)*/.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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-ressources-associées-pour-clé-gérée

Obtenez la liste des ressources associées à une clé gérée dans IBM Cloud. Ces ressources de cloud sont protégées par la clé que vous spécifiez.

Si l'option --all-pages n'est pas définie, la commande n'extrait qu'une seule page de la collection.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel de la clé. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-keys pour extraire l'identificateur unique universel de la clé.

  --limit (int64)

  Optionnel. Nombre de ressources à extraire. La valeur doit être comprise entre 1 et 1000.

  --offset (int64)

  Optionnel. Nombre de ressources à ignorer. La valeur minimale est 0.

  -- sort (chaîne[])

  Optionnel. Ordre de tri. La valeur par défaut est ["name"]. Les éléments de liste doivent correspondre à l'expression régulière /^-?[a-z0-9_.\\[\\],-]+$/.

  -- all-pages (bool)

  Optionnel. Appelez plusieurs demandes pour afficher toutes les pages de la collection pour les ressources associées.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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

Répertorier toutes les clés gérées affectées au magasin de clés.

Si l'option --all-pages n'est pas définie, la commande n'extrait qu'une seule page de la collection.

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]

• Options de commande

  -- uko-vault (chaîne)

  Obligatoire. Identificateur unique universel du coffre dans lequel la mise à jour doit être effectuée. Vous pouvez utiliser la commande ibmcloud hpcs uko vaults pour extraire l'identificateur unique universel.

  --id (chaîne)

  Obligatoire. Identificateur unique universel du magasin de clés. Vous pouvez utiliser la commande ibmcloud hpcs uko keystores pour extraire l'identificateur unique universel.

  -- algorithm (chaîne)

  Optionnel. Algorithme des clés renvoyées. Les valeurs pouvant être définies sont aes, rsa, hmac et ec.

  -- state (chaîne)

  Optionnel. Etat dans lequel doivent se trouver les clés renvoyées. La valeur par défaut est ["pre_activation","active"]. Les valeurs pouvant être définies sont les suivantes: pre_activation, active, deactivated, destroyed.

  --limit (int64)

  Optionnel. Nombre de clés à extraire. La valeur doit être comprise entre 1 et 1000.

  --offset (int64)

  Optionnel. Nombre de clés à ignorer. Valeur minimale : 0.

  -- sort (chaîne[])

  Optionnel. Ordre de tri. La valeur par défaut est ["-updated_at"]. Les éléments de liste doivent correspondre à l'expression régulière /^-?[a-z0-9_.\\[\\],-]+$/.

  -- label (chaîne)

  Optionnel. Libellé de la clé. La valeur doit correspondre à l'expression régulière /.+/.

  -- activation-date (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date d'activation correspond au paramètre. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --activation-date-min (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date d'activation est égale ou postérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête activation_date. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --activation-date-max (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date d'activation est égale ou antérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête activation_date. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --desactivation-date (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date de désactivation correspond au paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête expiration_date. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --desactivation-date-min (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date de désactivation est égale ou postérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec les paramètres de requête deactivation_date, expiration_date, expiration_date_min et expiration_date_max. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --desactivation-date-max (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date de désactivation est égale ou antérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec les paramètres de requête deactivation_date, expiration_date, expiration_date_min et expiration_date_max. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  -- expiration-date (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date de désactivation correspond au paramètre. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --expiration-date-min (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date de désactivation est égale ou postérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec les paramètres de requête deactivation_date, expiration_date, deactivation_date_min et deactivation_date_max. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --expiration-date-max (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date de désactivation est égale ou antérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec les paramètres de requête deactivation_date, expiration_date, deactivation_date_min et deactivation_date_max. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  -- created-at (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de création correspond au paramètre. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --created-at-min (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de création est égale ou postérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête created_at. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --created-at-max (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de création est égale ou antérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête created_at. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  -- updated-at (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de mise à jour correspond au paramètre. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --updated-at-min (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de mise à jour est postérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête updated_at. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --updated-at-max (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de mise à jour est antérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête updated_at. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --rotate-at-min (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date de rotation est postérieure à la valeur du paramètre.

  --rotate-at-max (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont la date de rotation est antérieure à la valeur du paramètre.

  -- size (int64)

  Optionnel. Taille de la clé.

  -- size-min (int64)

  Optionnel. Taille minimale de la clé. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête size.

  -- size-max (int64)

  Optionnel. Taille maximale de la clé. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête size.

  -- template-name (chaîne)

  Renvoie uniquement les clés gérées dont le nom de modèle commence par la chaîne.

  -- template-id (chaîne[])

  Renvoie uniquement les clés gérées avec l'identificateur unique universel de modèle donné.

  -- template-type (chaîne[])

  Renvoie uniquement les clés gérées avec le type de modèle donné. Les valeurs pouvant être définies sont user_defined, shadow et system.

  -- all-pages (bool)

  Optionnel. Appelez plusieurs demandes pour afficher toutes les pages de la collection pour les clés gérées.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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"
          }
        ]
      }
    ]
  }
  

hpcs uko-key-géré-ds

Renvoie le statut de distribution du magasin de clés pour une clé gérée.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel de la clé. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-keys pour extraire l'identificateur unique universel de la clé.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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"
      }
    ]
  }
  

hpcs uko managed-key-update-from-template

Mettez à jour une clé gérée pour qu'elle corresponde à la dernière version du modèle de clé associé. Vous pouvez affecter, activer ou désactiver la clé dans les magasins de clés du groupe défini par le modèle de clé.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel de la clé. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-keys pour extraire l'identificateur unique universel de la clé.

  -- if-match (chaîne)

  Obligatoire. Précondition de la mise à jour, qui correspond à la valeur de l'étiquette ETag de l'en-tête d'une demande GET. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-key pour extraire l'étiquette ETag.

  --dry-run (valeur booléenne)

  Optionnel. Ne créez, ne mettez pas à jour ou ne supprimez pas une ressource. Vérifiez et validez uniquement si la ressource peut être créée, mise à jour ou supprimée avec une demande donnée. La valeur par défaut est false.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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-activate

Activez une clé gérée et effectuez des opérations d'installation ou d'activation de clé sur les magasins de clés du groupe de magasins de clés associé à la clé gérée.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel de la clé. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-keys pour extraire l'identificateur unique universel de la clé.

  -- if-match (chaîne)

  Obligatoire. Précondition de la mise à jour, qui correspond à la valeur de l'étiquette ETag de l'en-tête d'une demande GET. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-key pour extraire l'étiquette ETag.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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-deactivate

Désactivez une clé gérée et effectuez des opérations de désactivation de clé sur les magasins de clés du groupe de magasins de clés associé à la clé gérée.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel de la clé. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-keys pour extraire l'identificateur unique universel de la clé.

  -- if-match (chaîne)

  Obligatoire. Précondition de la mise à jour, qui correspond à la valeur de l'étiquette ETag de l'en-tête d'une demande GET. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-key pour extraire l'étiquette ETag.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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

Détruisez une clé gérée et effectuez des opérations de destruction de clé sur les magasins de clés du groupe de magasins de clés associé à la clé gérée. Cette opération est irréversible. Assurez-vous que la clé gérée est à l'état deactivated avant d'exécuter cette commande.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel de la clé. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-keys pour extraire l'identificateur unique universel de la clé.

  -- if-match (chaîne)

  Obligatoire. Précondition de la mise à jour, qui correspond à la valeur de l'étiquette ETag de l'en-tête d'une demande GET. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-key pour extraire l'étiquette ETag.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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-sync

Effectuez l'opération de synchronisation sur une clé gérée pour aligner les états dans les magasins de clés associés.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel de la clé. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-keys pour extraire l'identificateur unique universel de la clé.

  -- if-match (chaîne)

  Obligatoire. Précondition de la mise à jour, qui correspond à la valeur de l'étiquette ETag de l'en-tête d'une demande GET. Vous pouvez utiliser la commande ibmcloud hpcs uko managed-key pour extraire l'étiquette ETag.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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"
      }
    ]
  }
  

Modèles de clé hpcs uko

Répertorier tous les modèles de clé dans l'instance.

Si l'option --all-pages n'est pas définie, la commande n'extrait qu'une seule page de la collection.

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]

• Options de commande

  --name (chaîne)

  Optionnel. Renvoie uniquement les modèles dont le nom commence par la chaîne.

  -- naming-scheme (chaîne)

  Optionnel. Renvoie uniquement les modèles dont le schéma de dénomination contient la chaîne.

  -- vault-id (chaîne)

  Optionnel. Identificateur unique universel du coffre. La longueur doit être de 36 caractères. La valeur doit correspondre à l'expression régulière /^[-0-9a-z]+$/.

  -- key-algorithm (chaîne)

  Optionnel. Algorithme des modèles de clé renvoyés. Les valeurs pouvant être définies sont aes, rsa, hmac, ec, des et dilithium.

  -- key-size (chaîne)

  Optionnel. Taille de la clé

  --key-size-min (chaîne)

  Optionnel. Taille minimale de la clé. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête key-size.

  --key-size-max (chaîne)

  Optionnel. Taille maximale de la clé. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête key-size.

  -- keystores-type (chaîne[])

  Optionnel. Type du magasin de clés référencé. Les valeurs pouvant être définies sont aws_kms, azure_key_vault, ibm_cloud_kms, google_kms et cca.

  -- keystores-group (chaîne[])

  Optionnel. Groupe de magasins de clés référencés.

  -- created-at (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de création correspond au paramètre. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --created-at-min (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de création est égale ou postérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête created_at. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --created-at-max (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de création est égale ou antérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête created_at. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  -- updated-at (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de mise à jour correspond au paramètre. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --updated-at-min (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de mise à jour est postérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête updated_at. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  --updated-at-max (chaîne)

  Optionnel. Renvoie uniquement les clés gérées dont l'heure de mise à jour est antérieure à la valeur du paramètre. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête updated_at. La valeur doit correspondre à l'expression régulière /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

  -- type (chaîne[])

  Optionnel. Types de modèles renvoyés. Les valeurs admises sont user_defined, shadow et system.

  -- state (chaîne[])

  Optionnel. Renvoie uniquement le modèle dont l'état contient la chaîne. Les valeurs pouvant être définies sont archived ou unarchived.

  -- sort (chaîne[])

  Optionnel. Ordre de tri. La valeur par défaut est ["-updated_at"]. Les éléments de liste doivent correspondre à l'expression régulière /^-?[a-z0-9_.\\[\\],-]+$/.

  --limit (int64)

  Optionnel. Nombre de modèles de clé à extraire. La valeur doit être comprise entre 1 et 1000.

  --offset (int64)

  Optionnel. Nombre de clés à ignorer. Valeur minimale : 0.

  -- gestion-systèmes

  Renvoie uniquement les clés gérées avec les systèmes de gestion indiqués. Les valeurs pouvant être définies sont web et workstation.

• Example

  ibmcloud hpcs uko key-templates --output json
  

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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-create

Créez un modèle de clé. Les modèles de clé sont utilisés pour combiner les informations nécessaires à la création d'une clé. Avec les modèles de clé, vous pouvez facilement créer des clés suivantes sans spécifier de détails.

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

• Options de commande

  -- vault (VaultReferenceInCreationInCreation)

  Obligatoire. ID du coffre dans lequel le modèle de clé doit être créé.

  --name (chaîne)

  Obligatoire. Nom du modèle. Vous devez le référencer lors de la création de clés gérées. La longueur doit être comprise entre 1 et 30 caractères. La valeur doit correspondre à l'expression régulière /^[A-Za-z][A-Za-z0-9-]*$/.

  -- type (chaîne[])

  Obligatoire. Type du modèle. Les valeurs pouvant être définies sont user_defined, shadow et system.

  -- state (chaîne)

  Obligatoire. Etat du modèle. Les valeurs pouvant être définies sont archived ou unarchived.

  -- naming-scheme (chaîne)

  Obligatoire. Modèle de chaîne que votre nom de modèle doit suivre.

  -- key (KeyProperties)

  Obligatoire. Propriétés qui décrivent la clé gérée.

  -- keystores (KeystoresPropertiesCréer [])

  Obligatoire. Tableau décrivant le type et le groupe de magasins de clés dans lesquels la clé gérée doit être installée. La longueur maximale est de 1. La longueur minimale est 1.

  --description (chaîne)

  Optionnel. Description du modèle de clé. La longueur doit être comprise entre 0 et 200 caractères. La valeur doit correspondre à l'expression régulière /(.|\\n)*/.

• Example

  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
  

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  Emplacement	Chaîne	Chemin d'accès à la ressource nouvellement créée, relatif à la racine de contexte.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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"
  }
  

hpcs uko key-template-supprimer

Supprimez un modèle de clé du coffre. Assurez-vous qu'aucune clé gérée n'est associée au modèle de clé avant d'exécuter cette commande.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel du modèle. Vous pouvez utiliser la commande ibmcloud hpcs uko key-templates pour extraire l'identificateur unique universel.

  -- if-match (chaîne)

  Obligatoire. Précondition de la mise à jour, qui correspond à la valeur de l'étiquette ETag de l'en-tête d'une demande GET. Vous pouvez utiliser la commande ibmcloud hpcs uko key-template pour extraire l'étiquette ETag.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.

  La commande renvoie une sortie similaire à l'exemple suivant:

  ...
  OK
  

ibmcloud hpcs uko key-template

Extrayez un modèle de clé et ses détails en spécifiant l'ID.

ibmcloud hpcs uko key-template --id ID

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel du modèle. Vous pouvez utiliser la commande ibmcloud hpcs uko key-templates pour extraire l'identificateur unique universel.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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"
  }
  

hpcs uko key-template-update

Mettre à jour les attributs d'un modèle de clé.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel du modèle. Vous pouvez utiliser la commande ibmcloud hpcs uko key-templates pour extraire l'identificateur unique universel.

  -- if-match (chaîne)

  Obligatoire. Précondition de la mise à jour, qui correspond à la valeur de l'étiquette ETag de l'en-tête d'une demande GET. Vous pouvez utiliser la commande ibmcloud hpcs uko key-template pour extraire l'étiquette ETag.

  --name (chaîne)

  Optionnel. Nom du modèle mis à jour.

  -- keystores (KeystoresPropertiesMise à jour [])

  Optionnel. Tableau décrivant le type et le groupe de magasins de clés dans lesquels la clé gérée doit être installée. La longueur maximale est de 1. La longueur minimale est 1.

  --description (chaîne)

  Optionnel. Description mise à jour du modèle de clé. La longueur doit être comprise entre 0 et 200 caractères. La valeur doit correspondre à l'expression régulière /(.|\\n)*/.

  -- key (Mise à jour deKeyProperties)

  Optionnel. Propriétés de la clé gérée.

• Example

  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
  

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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"
  }
  

magasins de clés hpcs uko

Répertoriez tous les magasins de clés de l'instance.

Si l'option --all-pages n'est pas définie, la commande n'extrait qu'une seule page de la collection.

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]

• Options de commande

  -- type (chaîne[])

  Optionnel. Type de magasin de clés que vous souhaitez extraire. Les valeurs pouvant être définies sont les suivantes: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms et cca.

  --name (chaîne)

  Optionnel. Renvoie uniquement les magasins de clés dont le nom contient la chaîne. La longueur doit être comprise entre 1 et 100 caractères. La valeur doit correspondre à l'expression régulière /.+/.

  --description (chaîne)

  Optionnel. Renvoie uniquement les magasins de clés dont la description contient la chaîne. La longueur doit être comprise entre 1 et 200 caractères. La valeur doit correspondre à l'expression régulière /.+/.

  -- group (chaîne)

  Optionnel. Groupe de magasins de clés. Ce paramètre de requête ne peut pas être utilisé avec le paramètre de requête groups[].

  -- groupes (chaîne[])

  Optionnel. Groupes de fichiers de clés.

  -- vault-id (chaîne[])

  Optionnel. Identificateur unique universel du coffre. Les éléments de liste doivent correspondre à l'expression régulière /^[-0-9a-z]+$/.

  -- location (chaîne)

  Optionnel. Emplacement du magasin de clés.

  --limit (int64)

  Optionnel. Nombre de magasins de clés à extraire. La valeur doit être comprise entre 1 et 1000.

  --offset (int64)

  Optionnel. Nombre de clés à ignorer. Valeur minimale : 0.

  -- sort (chaîne[])

  Optionnel. Ordre de tri. La valeur par défaut est ["-updated_at"]. Les éléments de liste doivent correspondre à l'expression régulière /^-?[a-z0-9_.\\[\\],-]+$/.

  -- all-pages (bool)

  Optionnel. Appelez plusieurs demandes pour afficher toutes les pages de la collection pour les magasins de clés.

• Example

  ibmcloud hpcs uko keystores --output json
  

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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-créer

Créez un magasin de clés interne ou connectez-vous à un magasin de clés externe du type demandé. Si le paramètre de requête dry_run est utilisé, aucun magasin de clés n'est créé dans la base de données et seul un test est effectué pour vérifier si les informations de connexion sont correctes. Il est possible de trier en fonction des paramètres suivants: name, created_at, updated_at, vault-id.

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

• Options de commande

  -- keystore-body (DemandeKeystoreCreation)

  Obligatoire. Propriétés du magasin de clés que vous souhaitez créer ou auquel vous souhaitez vous connecter.

  --dry-run (bool)

  Optionnel. Effectuez un test pour vérifier si un magasin de clés créé avec des paramètres donnés peut être communiqué avec succès. Aucun magasin de clés n'est créé dans la base de données. La valeur par défaut est false.

• Example

  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
  

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  Emplacement	Chaîne	Chemin d'accès à la ressource nouvellement créée, relatif à la racine de contexte.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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"
  }
  

magasin de clés hpcs uko-delete

Supprimez un magasin de clés interne ou supprimez une connexion à un magasin de clés externe. Le magasin de clés externe sur la plateforme distante existe toujours après la suppression de la connexion.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel du magasin de clés. Vous pouvez utiliser la commande ibmcloud hpcs uko keystores pour extraire l'identificateur unique universel.

  -- if-match (chaîne)

  Obligatoire. Précondition de la mise à jour, qui correspond à la valeur de l'étiquette ETag de l'en-tête d'une demande GET. Vous pouvez utiliser la commande ibmcloud hpcs uko keystore pour extraire l'étiquette ETag.

  -- mode (chaîne)

  Optionnel. Mode de déconnexion du magasin de clés. Les valeurs admises sont restrict, disconnect, deactivate et destroy. La valeur par défaut est restrict.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.

  La commande renvoie une sortie similaire à l'exemple suivant:

  ...
  OK
  

fichier de clés hpcs uko

Extrayez un magasin de clés interne cible ou une connexion de magasin de clés externe et ses détails en spécifiant l'ID.

ibmcloud hpcs uko keystore --id ID

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel du magasin de clés. Vous pouvez utiliser la commande ibmcloud hpcs uko keystores pour extraire l'identificateur unique universel.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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-mise à jour

Mettez à jour les attributs d'un magasin de clés interne ou d'une connexion de magasin de clés externe.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel du magasin de clés. Vous pouvez utiliser la commande ibmcloud hpcs uko keystores pour extraire l'identificateur unique universel.

  -- if-match (chaîne)

  Obligatoire. Précondition de la mise à jour, qui correspond à la valeur de l'étiquette ETag de l'en-tête d'une demande GET. Vous pouvez utiliser la commande ibmcloud hpcs uko keystore pour extraire l'étiquette ETag.

  -- keystore-body (DemandeKeystoreUpdate)

  Obligatoire. Propriétés du magasin de clés que vous souhaitez mettre à jour.

• Example

  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
  

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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-ressources-associées-pour-la-cible-magasin de clés

Obtenez la liste des ressources associées à toutes les clés qui sont activées dans ce magasin de clés.

Si l'option --all-pages n'est pas définie, la commande n'extrait qu'une seule page de la collection.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel du magasin de clés. Vous pouvez utiliser la commande ibmcloud hpcs uko keystores pour extraire l'identificateur unique universel.

  --limit (int64)

  Optionnel. Nombre de ressources à extraire. La valeur doit être comprise entre 1 et 1000.

  --offset (int64)

  Optionnel. Nombre de ressources à ignorer. La valeur minimale est 0.

  -- sort (chaîne[])

  Optionnel. Ordre de tri. La valeur par défaut est ["name"]. Les éléments de liste doivent correspondre à l'expression régulière /^-?[a-z0-9_.\\[\\],-]+$/.

  -- all-pages (bool)

  Optionnel. Appelez plusieurs demandes pour afficher toutes les pages de la collection pour les ressources associées pour le magasin de clés.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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 magasin de clés-statut

Extrayez le statut d'un magasin de clés interne ou externe cible.

ibmcloud hpcs uko keystore-status --id ID

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel du magasin de clés. Vous pouvez utiliser la commande ibmcloud hpcs uko keystores pour extraire l'identificateur unique universel.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.

  La commande renvoie une sortie similaire à l'exemple suivant:

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

coffres hpcs uko

Répertorier tous les coffres de l'instance.

Si l'option --all-pages n'est pas définie, la commande n'extrait qu'une seule page de la collection.

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

• Options de commande

  --limit (int64)

  Optionnel. Nombre de coffres à extraire. La valeur maximale est 1000. La valeur minimale est 1.

  --offset (int64)

  Optionnel. Nombre de coffres à ignorer. Valeur minimale : 0.

  -- sort (chaîne[])

  Optionnel. Ordre de tri. La valeur par défaut est ["-updated_at"]. Les éléments de liste doivent correspondre à l'expression régulière /^-?[a-z0-9_.\\[\\],-]+$/.

  --name (chaîne)

  Optionnel. Renvoie uniquement les coffres dont les noms commencent par la chaîne. La longueur doit être comprise entre 1 et 100 caractères. La valeur doit correspondre à l'expression régulière /.+/.

  --description (chaîne)

  Optionnel. Renvoie uniquement les coffres dont la description contient la chaîne. La longueur doit être comprise entre 1 et 200 caractères. La valeur doit correspondre à l'expression régulière /.+/.

  -- all-pages (bool)

  Optionnel. Appelez plusieurs demandes pour afficher toutes les pages de la collection pour les coffres.

• Example

  ibmcloud hpcs uko vaults --output json
  

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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-créer

Créez un coffre dans l'instance avec le nom et la description spécifiés.

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

• Options de commande

  --name (chaîne)

  Obligatoire. Nom lisible à affecter à votre coffre. Pour protéger votre vie privée, n'utilisez pas de données personnelles, telles que votre nom ou votre emplacement. La longueur doit être comprise entre 1 et 100 caractères. La valeur doit correspondre à l'expression régulière /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/.

  --description (chaîne)

  Optionnel. Description du coffre. La longueur doit être comprise entre 0 et 200 caractères. La valeur doit correspondre à l'expression régulière /(.|\\n)*/.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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-supprimer

Supprimez un coffre de votre instance. Assurez-vous qu'aucune clé ou magasin de clés n'est associé au coffre avant d'exécuter cette commande.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel du coffre. Vous pouvez utiliser la commande ibmcloud hpcs uko vaults pour extraire l'identificateur unique universel.

  -- if-match (chaîne)

  Obligatoire. Précondition de la mise à jour, qui correspond à la valeur de l'étiquette ETag de l'en-tête d'une demande GET. Vous pouvez utiliser la commande ibmcloud hpcs uko vault pour extraire l'étiquette ETag.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.

  La commande renvoie une sortie similaire à l'exemple suivant:

  ...
  OK
  

coffre hpcs uko

Extrayez un coffre et ses détails en spécifiant l'ID.

ibmcloud hpcs uko vault --id ID

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel du coffre. Vous pouvez utiliser la commande ibmcloud hpcs uko vaults pour extraire l'identificateur unique universel.

• Example

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

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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-mise à jour

Mettre à jour les attributs d'un coffre.

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

• Options de commande

  --id (chaîne)

  Obligatoire. Identificateur unique universel du coffre. Vous pouvez utiliser la commande ibmcloud hpcs uko vaults pour extraire l'identificateur unique universel.

  -- if-match (chaîne)

  Obligatoire. Précondition de la mise à jour, qui correspond à la valeur de l'étiquette ETag de l'en-tête d'une demande GET. Vous pouvez utiliser la commande ibmcloud hpcs uko vault pour extraire l'étiquette ETag.

  --name (chaîne)

  Optionnel. Nom mis à jour du coffre vault.The doit être comprise entre 1 et 100 caractères. La valeur doit correspondre à l'expression régulière /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/.

  --description (chaîne)

  Optionnel. Mise à jour de la description du coffre. La longueur doit être comprise entre 0 et 200 caractères. La valeur doit correspondre à l'expression régulière /(.|\\n)*/.

• Example

  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
  

• Sortie

  En-têtes:

  Tableau: En-têtes de sortie de commande

  Nom	Type	Description
  X-ID-corrélation	Chaîne	Identificateur unique associé aux demandes et aux messages qui permettent de faire référence à une transaction ou à une chaîne d'événements particulière.
  ETag	Chaîne	Identificateur d'une version spécifique de la ressource.

  La commande renvoie une sortie similaire à l'exemple suivant:

  {
    "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
  }
  

KeyProperties

L'exemple suivant illustre le format de l'objet KeyProperties.

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

Mise à jour de KeyProperties

L'exemple suivant illustre le format de l'objet KeyPropertiesUpdate.

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

Demande KeystoreCreation

L'exemple suivant illustre le format de l'objet 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"
}

Demande KeystoreUpdate

L'exemple suivant illustre le format de l'objet 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"
}

KeystoresPropertiesCréer[]

L'exemple suivant illustre le format de l'objet KeystoresPropertiesCreate[].

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

KeystoresPropertiesMise à jour[]

L'exemple suivant illustre le format de l'objet KeystoresPropertiesUpdate[].

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

Balise[]

L'exemple suivant illustre le format de l'objet Tag[].

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

Demande VaultReferenceInCreation

L'exemple suivant illustre le format de l'objet VaultReferenceInCreationRequest.

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