hpcs-cert-mgr adminkey get

Verwenden Sie diesen Befehl, um den Administratorsignaturschlüssel für den Zertifikatadministrator zu löschen.

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

• Befehlsoptionen

  --crn HPCS_CRN

  Erforderlich. Der crn Ihrer Hyper Protect Crypto Services-Instanz. Sie können den Befehl ibmcloud resource service-instances --long verwenden, um den crn abzurufen.

  -- private

  Optional. Wenn Sie diese Option verwenden, verweist die Server-URL des Zertifikatmanagers auf das private Netz. Beispiel: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. Die region ist die Abkürzung des geografischen Bereichs, in dem Sie sich bei IBM Cloud anmelden. In diesem Fall müssen Sie das private Netz verwenden, um Ihre Serviceinstanz zu verbinden.

• Beispiel

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

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

• Ausgabe

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

hpcs-cert-mgr adminkey set

Verwenden Sie diesen Befehl, um den Administratorsignaturschlüssel für den Zertifikatadministrator zu erstellen, um eine Verbindung zum Zertifikatmanagerserver herzustellen.

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

• Befehlsoptionen

  --crn HPCS_CRN

  Erforderlich. Der crn Ihrer Hyper Protect Crypto Services-Instanz. Sie können den Befehl ibmcloud resource service-instances --long verwenden, um den crn abzurufen.

  -- private

  Optional. Wenn Sie diese Option verwenden, verweist die Server-URL des Zertifikatmanagers auf das private Netz. Beispiel: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. Die region ist die Abkürzung des geografischen Bereichs, in dem Sie sich bei IBM Cloud anmelden. In diesem Fall müssen Sie das private Netz verwenden, um Ihre Serviceinstanz zu verbinden.

• Beispiel

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

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

• Ausgabe

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  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

Verwenden Sie diesen Befehl, um den Administratorsignaturschlüssel für den Zertifikatadministrator zu aktualisieren.

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

• Befehlsoptionen

  --crn HPCS_CRN

  Erforderlich. Der crn Ihrer Hyper Protect Crypto Services-Instanz. Sie können den Befehl ibmcloud resource service-instances --long verwenden, um den crn abzurufen.

  --admin-priv-key ADMIN_PRIV_KEY

  Erforderlich. Der Dateipfad Ihres aktuellen privaten Schlüssels, der auf Ihrer lokalen Workstation gespeichert ist. Der private Schlüssel wird verwendet, um diese Befehlsaktion für den Zertifikatmanagerserver Ihrer Instanz zu signieren.

  -- private

  Optional. Wenn Sie diese Option verwenden, verweist die Server-URL des Zertifikatmanagers auf das private Netz. Beispiel: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. Die region ist die Abkürzung des geografischen Bereichs, in dem Sie sich bei IBM Cloud anmelden. In diesem Fall müssen Sie das private Netz verwenden, um Ihre Serviceinstanz zu verbinden.

• Beispiel

  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}
  

• Ausgabe

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  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

Verwenden Sie diesen Befehl, um den Administratorsignaturschlüssel für den Zertifikatadministrator zu löschen.

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

• Befehlsoptionen

  --crn HPCS_CRN

  Erforderlich. Der crn Ihrer Hyper Protect Crypto Services-Instanz. Sie können den Befehl ibmcloud resource service-instances --long verwenden, um den crn abzurufen.

  --admin-priv-key ADMIN_PRIV_KEY

  Erforderlich. Der Dateipfad Ihres aktuellen privaten Schlüssels, der auf Ihrer lokalen Workstation gespeichert ist. Der private Schlüssel wird verwendet, um diese Befehlsaktion für den Zertifikatmanagerserver Ihrer Instanz zu signieren.

  -- private

  Optional. Wenn Sie diese Option verwenden, verweist die Server-URL des Zertifikatmanagers auf das private Netz. Beispiel: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. Die region ist die Abkürzung des geografischen Bereichs, in dem Sie sich bei IBM Cloud anmelden. In diesem Fall müssen Sie das private Netz verwenden, um Ihre Serviceinstanz zu verbinden.

• Beispiel

  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}
  

• Ausgabe

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

hpcs-cert-mgr cert get

Verwenden Sie diesen Befehl, um das Clientzertifikat auf Ihrem Instanzzertifikatmanagerserver abzurufen.

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

• Befehlsoptionen

  --crn HPCS_CRN

  Erforderlich. Der crn Ihrer Hyper Protect Crypto Services-Instanz. Sie können den Befehl ibmcloud resource service-instances --long verwenden, um den crn abzurufen.

  --cert-id CERT_ID

  Erforderlich. Die Zeichenfolge-ID des Clientzertifikats, das abgerufen werden soll.

  --cert-store-file CERT_FILE

  Optional. Der Dateipfad zum Speichern des abgerufenen Zertifikats. Wenn Sie diese Option angeben, wird die Datei auf Ihrer lokalen Workstation erstellt und sie speichert den Zertifikatsinhalt.

  -- private

  Optional. Wenn Sie diese Option verwenden, verweist die Server-URL des Zertifikatmanagers auf das private Netz. Beispiel: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. Die region ist die Abkürzung des geografischen Bereichs, in dem Sie sich bei IBM Cloud anmelden. In diesem Fall müssen Sie das private Netz verwenden, um Ihre Serviceinstanz zu verbinden.

• Beispiel

  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
  

• Ausgabe

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  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

Verwenden Sie diesen Befehl, um Clientzertifikate für Ihren Instanzzertifikatmanagerserver festzulegen.

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

• Befehlsoptionen

  --crn HPCS_CRN

  Erforderlich. Der crn Ihrer Hyper Protect Crypto Services-Instanz. Sie können den Befehl ibmcloud resource service-instances --long verwenden, um den crn abzurufen.

  --admin-priv-key ADMIN_PRIV_KEY

  Erforderlich. Der Dateipfad Ihres aktuellen privaten Schlüssels, der auf Ihrer lokalen Workstation gespeichert ist. Der private Schlüssel wird verwendet, um diese Befehlsaktion für den Zertifikatmanagerserver Ihrer Instanz zu signieren.

  --cert-id CERT_ID

  Erforderlich. Die Zeichenfolge-ID, die Sie dem Clientzertifikat zuordnen möchten, um eine einfache Identifizierung zu ermöglichen.

  --cert CERT_FILE

  Erforderlich. Die Zertifikatsdatei, die auf Ihrer Workstation gespeichert wird. Es wird empfohlen, den IBM Cloud-Zertifikatsmanager für die Bestellung und Verwaltung von SSL/TLS-Zertifikaten für Ihre Anwendungen und Services zu verwenden.

  -- private

  Optional. Wenn Sie diese Option verwenden, verweist die Server-URL des Zertifikatmanagers auf das private Netz. Beispiel: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. Die region ist die Abkürzung des geografischen Bereichs, in dem Sie sich bei IBM Cloud anmelden. In diesem Fall müssen Sie das private Netz verwenden, um Ihre Serviceinstanz zu verbinden.

• Beispiel

  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}
  

• Ausgabe

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

hpcs-cert-mgr cert list

Verwenden Sie diesen Befehl, um alle Zertifikate aufzulisten, die vom Administrator für Ihren Instanzzertifikatmanagerserver verwaltet werden.

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

• Befehlsoptionen

  --crn HPCS_CRN

  Erforderlich. Der crn Ihrer Hyper Protect Crypto Services-Instanz. Sie können den Befehl ibmcloud resource service-instances --long verwenden, um den crn abzurufen.

  -- private

  Optional. Wenn Sie diese Option verwenden, verweist die Server-URL des Zertifikatmanagers auf das private Netz. Beispiel: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. Die region ist die Abkürzung des geografischen Bereichs, in dem Sie sich bei IBM Cloud anmelden. In diesem Fall müssen Sie das private Netz verwenden, um Ihre Serviceinstanz zu verbinden.

• Beispiel

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

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

• Ausgabe

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  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

Verwenden Sie diesen Befehl, um Clientzertifikate für Ihren Instanzzertifikatmanagerserver zu löschen.

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

• Befehlsoptionen

  --crn HPCS_CRN

  Erforderlich. Der crn Ihrer Hyper Protect Crypto Services-Instanz. Sie können den Befehl ibmcloud resource service-instances --long verwenden, um den crn abzurufen.

  --admin-priv-key ADMIN_PRIV_KEY

  Erforderlich. Der Dateipfad Ihres aktuellen privaten Schlüssels, der auf Ihrer lokalen Workstation gespeichert ist. Der private Schlüssel wird verwendet, um diese Befehlsaktion für den Zertifikatmanagerserver Ihrer Instanz zu signieren.

  --cert-id CERT_ID

  Erforderlich. Die Zeichenfolge-ID des Zertifikats, das gelöscht werden soll.

  -- private

  Optional. Wenn Sie diese Option verwenden, verweist die Server-URL des Zertifikatmanagers auf das private Netz. Beispiel: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. Die region ist die Abkürzung des geografischen Bereichs, in dem Sie sich bei IBM Cloud anmelden. In diesem Fall müssen Sie das private Netz verwenden, um Ihre Serviceinstanz zu verbinden.

• Beispiel

  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
  

• Ausgabe

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Verwaltete hpcs-uko-Schlüssel

Listet alle verwalteten Schlüssel in der Instanz auf Es ist möglich, nach den folgenden Parametern zu sortieren: label, algorithm, state, activation-date, deactivation-date, created-at, updated-at, size, vault-id.

Ist die Option --all-pages nicht festgelegt, ruft der Befehl nur eine einzelne Seite der Objektgruppe ab.

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]

• Befehlsoptionen

  -- vault-id ([]Zeichenfolge)

  Optional. Die UUID (Universally Unique Identifier) der Vault. Sie können den Befehl ibmcloud hpcs uko managed-keys verwenden, um die UUID abzurufen. Die Länge muss 36 Zeichen betragen. Die Listenelemente müssen dem regulären Ausdruck /^[-0-9a-z]+$/ entsprechen.

  -- algorithm ([]Zeichenfolge)

  Optional. Der Algorithmus der zurückgegebenen Schlüssel. Mögliche Werte sind aes, rsa, hmac, ec, des und dilithium.

  -- state ([]Zeichenfolge)

  Optional. Der Status, in dem Schlüssel zurückgegeben werden sollen. Der Standardwert ist ["pre_activation","active"]. Die folgenden Werte können festgelegt werden: pre_activation, active, deactivated, destroyed, compromised und destroyed_compromised.

  --limit (int64)

  Optional. Die Anzahl der abzurufenden Schlüssel. Der Maximalwert ist 1000. Der Mindestwert ist 1. Der Standardwert ist 20.

  --offset (int64)

  Optional. Die Anzahl der zu überspringenden Schlüssel. Der Mindestwert ist 0.

  -- sort ([]zeichenfolge)

  Optional. Die Sortierreihenfolge. Der Standardwert ist ["-updated_at"]. Die Listenelemente müssen dem regulären Ausdruck /^-?[a-z0-9_.\\[\\],-]+$/ entsprechen.

  -- label (Zeichenfolge)

  Optional. Die Bezeichnung des Schlüssels Der Wert muss dem regulären Ausdruck /.+/ entsprechen.

  -- activation-date (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Aktivierungsdatum dem Parameter entspricht. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --activation-date-min (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Aktivierungsdatum am oder nach dem Parameterwert liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter activation_date verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --activation-date-max (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Aktivierungsdatum dem Parameterwert entspricht oder vor diesem liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter activation_date verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --deactivation-date (zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Inaktivierungsdatum dem Parameter entspricht. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter expiration_date verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --deactivation-date-min (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Inaktivierungsdatum bei oder nach dem Parameterwert liegt. Dieser Abfrageparameter kann nicht in Verbindung mit den Abfrageparametern deactivation_date, expiration_date, expiration_date_min und expiration_date_max verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --deactivation-date-max (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Inaktivierungsdatum dem Parameterwert entspricht oder vor diesem liegt. Dieser Abfrageparameter kann nicht in Verbindung mit den Abfrageparametern deactivation_date, expiration_date, expiration_date_min und expiration_date_max verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  -- expiration-date (zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Inaktivierungsdatum dem Parameter entspricht. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --expiration-date-min (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Inaktivierungsdatum bei oder nach dem Parameterwert liegt. Dieser Abfrageparameter kann nicht in Verbindung mit den Abfrageparametern deactivation_date, expiration_date, deactivation_date_min und deactivation_date_max verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --expiration-date-max (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Inaktivierungsdatum dem Parameterwert entspricht oder vor diesem liegt. Dieser Abfrageparameter kann nicht in Verbindung mit den Abfrageparametern deactivation_date, expiration_date, deactivation_date_min und deactivation_date_max verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  -- created-at (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Erstellungszeit dem Parameter entspricht. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --created-at-min (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Erstellungszeit zum oder nach dem Parameterwert liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter created_at verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --created-at-max (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Erstellungszeit dem Parameterwert entspricht oder vor diesem liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter created_at verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  -- updated-at (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Aktualisierungszeit dem Parameter entspricht. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --updated-at-min (Zeichenfolge)

  Optional. Nur verwaltete Schlüssel zurückgeben, deren Aktualisierungszeit nach dem Parameterwert liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter updated_at verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --updated-at-max (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Aktualisierungszeit vor dem Parameterwert liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter updated_at verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --rotiert-at-min (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Rotationszeit nach dem Parameterwert liegt.

  --rotiert-at-max (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Rotationszeit vor dem Parameterwert liegt.

  -- size (int64)

  Optional. Die Größe des Schlüssels.

  -- size-min (int64)

  Optional. Die Mindestgröße des Schlüssels Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter size verwendet werden.

  -- size-max (int64)

  Optional. Die maximale Größe des Schlüssels. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter size verwendet werden.

  --referenced-keystores-type ([]zeichenfolge)

  Optional. Typ des referenzierten Keystores. Mögliche Werte sind aws_kms, azure_key_vault, ibm_cloud_kms, google_kms und cca.

  --referenced-keystores-name ([]zeichenfolge)

  Optional. Name des referenzierten Keystores. Die Listenelemente müssen dem regulären Ausdruck /[^,]+/ entsprechen.

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

  Optional. Der Typ des von einer der Instanzen unterstützten Keystores. Mögliche Werte sind aws_kms, azure_key_vault, ibm_cloud_kms, google_kms und cca.

  -- template-name (zeichenfolge)

  Gibt nur verwaltete Schlüssel zurück, deren Schablonenname mit der Zeichenfolge beginnt.

  -- template-id (Zeichenfolge[])

  Gibt nur verwaltete Schlüssel mit der angegebenen Schablonen-UUID zurück

  -- template-type (Zeichenfolge[])

  Gibt nur verwaltete Schlüssel mit dem angegebenen Schablonentyp zurück. Mögliche Werte sind user_defined, shadow und system.

  -- verwaltende-Systeme

  Gibt nur verwaltete Schlüssel mit den angegebenen verwaltenden Systemen zurück Mögliche Werte sind web und workstation.

  -- all-pages (bool)

  Optional. Rufen Sie mehrere Anforderungen auf, um alle Seiten der Sammlung für verwaltete Schlüssel anzuzeigen.

• Beispiel

  ibmcloud hpcs uko managed-keys --output json
  

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Erstellen Sie einen neuen Schlüssel auf der Basis der bereitgestellten Vorlage. Die Vorlage muss in Ihrer Instanz vorhanden sein, bevor Sie diesen Befehl ausführen können.

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

• Befehlsoptionen

  -- template-name (zeichenfolge)

  Erforderlich. Der Name der Schlüsselvorlage, die beim Erstellen eines Schlüssels verwendet werden soll. Die Länge muss zwischen 1 und 30 Zeichen liegen. Der Wert muss mit dem regulären Ausdruck /^[A-Za-z][A-Za-z0-9-]+$/ übereinstimmen.

  -- vault (VaultReferenceInCreationRequest)

  Erforderlich. Die ID der Vault, in der der verwaltete Schlüssel erstellt werden soll

  -- label (Zeichenfolge)

  Erforderlich. Die Bezeichnung des Schlüssels Die Länge muss zwischen 1 und 255 Zeichen liegen. Der Wert muss mit dem regulären Ausdruck /^[A-Za-z0-9._ \/-]+$/ übereinstimmen.

  -- tags (Tag [])

  Optional. Schlüssel/Wert-Paare, die dem Schlüssel zugeordnet sind. Die Länge muss zwischen 0 und 128 Elementen liegen.

  --description (string)

  Optional. Die Beschreibung des verwalteten Schlüssels. Die Länge muss zwischen 0 und 200 Zeichen liegen. Der Wert muss mit dem regulären Ausdruck /(.|\\n)*/ übereinstimmen.

• Beispiel

  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
  

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  Standort	Zeichenfolge	Pfad zur neu erstellten Ressource relativ zum Kontextstammverzeichnis.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Löscht einen verwalteten Schlüssel nach Schlüssel-ID aus der Vault. Stellen Sie sicher, dass sich der Schlüssel im Status Gelöscht befindet, bevor Sie den Befehl ausführen.

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Schlüssels. Sie können den Befehl ibmcloud hpcs uko managed-keys verwenden, um die Schlüssel-UUID abzurufen.

  -- if-match (Zeichenfolge)

  Erforderlich. Die Vorbedingung der Aktualisierung. Dies ist der Wert des ETag aus dem Header in einer GET-Anforderung. Sie können den Befehl ibmcloud hpcs uko managed-key verwenden, um den ETag abzurufen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  ...
  OK
  

Verwalteter hpcs-Uko-Schlüssel

Rufen Sie einen verwalteten Schlüssel und seine Details ab, indem Sie die Schlüssel-ID angeben.

ibmcloud hpcs uko managed-key --id ID

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Schlüssels. Sie können den Befehl ibmcloud hpcs uko managed-keys verwenden, um die Schlüssel-UUID abzurufen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Attribute eines verwalteten Schlüssels aktualisieren. Sie können den Status des Schlüssels nur getrennt von anderen Änderungen ändern. Das Ändern des Status eines Schlüssels wirkt sich auf seine Verfügbarkeit für Verschlüsselungsoperationen in Keystores aus.

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]

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Schlüssels. Sie können den Befehl ibmcloud hpcs uko managed-keys verwenden, um die Schlüssel-UUID abzurufen.

  -- if-match (Zeichenfolge)

  Erforderlich. Die Vorbedingung der Aktualisierung. Dies ist der Wert des ETag aus dem Header in einer GET-Anforderung. Sie können den Befehl ibmcloud hpcs uko managed-key verwenden, um den ETag abzurufen.

  -- label (Zeichenfolge)

  Erforderlich. Die Bezeichnung des Schlüssels Die Länge muss zwischen 1 und 255 Zeichen liegen. Der Wert muss mit dem regulären Ausdruck /^[A-Za-z0-9._ \/-]+$/ übereinstimmen.

  -- activation-date (strfmt.Date)

  Optional. Das Aktivierungsdatum muss im Format JJJJ-MM-TT angegeben werden.

  -- expiration-date (strfmt.Date)

  Optional. Das Ablaufdatum muss im Format JJJJ-MM-TT angegeben werden.

  -- tags (Tag [])

  Optional. Schlüssel/Wert-Paare, die dem Schlüssel zugeordnet sind. Die Länge muss zwischen 0 und 128 Elementen liegen.

  --description (string)

  Optional. Die Beschreibung des verwalteten Schlüssels. Die Länge muss zwischen 0 und 200 Zeichen liegen. Der Wert muss mit dem regulären Ausdruck /(.|\\n)*/ übereinstimmen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  {
    "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 associated-resources-for-managed-key'

Liste der Ressourcen abrufen, die einem verwalteten Schlüssel in IBM Cloudzugeordnet sind. Diese Cloudressourcen werden durch den angegebenen Schlüssel geschützt.

Wenn die Option --all-pages nicht festgelegt ist, ruft der Befehl nur eine einzelne Seite der Objektgruppe ab.

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Schlüssels. Sie können den Befehl ibmcloud hpcs uko managed-keys verwenden, um die Schlüssel-UUID abzurufen.

  --limit (int64)

  Optional. Die Anzahl der abzurufenden Ressourcen. Der Wert muss zwischen 1 und 1000 liegen.

  --offset (int64)

  Optional. Die Anzahl der zu überspringenden Ressourcen. Der Mindestwert ist 0.

  -- sort ([]zeichenfolge)

  Optional. Die Sortierreihenfolge. Der Standardwert ist ["name"]. Die Listenelemente müssen dem regulären Ausdruck /^-?[a-z0-9_.\\[\\],-]+$/ entsprechen.

  -- all-pages (bool)

  Optional. Rufen Sie mehrere Anforderungen auf, um alle Seiten der Sammlung für die zugeordneten Ressourcen anzuzeigen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Alle verwalteten Schlüssel auflisten, die dem Schlüsselspeicher zugeordnet sind.

Wenn die Option --all-pages nicht festgelegt ist, ruft der Befehl nur eine einzelne Seite der Objektgruppe ab.

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]

• Befehlsoptionen

  -- uko-vault (Zeichenfolge)

  Erforderlich. Die UUID der Vault, in der die Aktualisierung stattfinden soll Sie können den Befehl ibmcloud hpcs uko vaults verwenden, um die UUID abzurufen.

  --id (string)

  Erforderlich. Die UUID des Keystores Sie können den Befehl ibmcloud hpcs uko keystores verwenden, um die UUID abzurufen.

  -- algorithm (zeichenfolge)

  Optional. Der Algorithmus der zurückgegebenen Schlüssel. Mögliche Werte sind aes, rsa, hmac und ec.

  -- state (Zeichenfolge)

  Optional. Der Status, in dem Schlüssel zurückgegeben werden sollen. Der Standardwert ist ["pre_activation","active"]. Folgende Werte können festgelegt werden: pre_activation, active, deactivated, destroyed.

  --limit (int64)

  Optional. Die Anzahl der abzurufenden Schlüssel. Der Wert muss zwischen 1 und 1000 liegen.

  --offset (int64)

  Optional. Die Anzahl der zu überspringenden Schlüssel. Der Mindestwert ist 0.

  -- sort ([]zeichenfolge)

  Optional. Die Sortierreihenfolge. Der Standardwert ist ["-updated_at"]. Die Listenelemente müssen dem regulären Ausdruck /^-?[a-z0-9_.\\[\\],-]+$/ entsprechen.

  -- label (Zeichenfolge)

  Optional. Die Bezeichnung des Schlüssels Der Wert muss dem regulären Ausdruck /.+/ entsprechen.

  -- activation-date (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Aktivierungsdatum dem Parameter entspricht. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --activation-date-min (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Aktivierungsdatum am oder nach dem Parameterwert liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter activation_date verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --activation-date-max (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Aktivierungsdatum dem Parameterwert entspricht oder vor diesem liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter activation_date verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --deactivation-date (zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Inaktivierungsdatum dem Parameter entspricht. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter expiration_date verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --deactivation-date-min (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Inaktivierungsdatum bei oder nach dem Parameterwert liegt. Dieser Abfrageparameter kann nicht in Verbindung mit den Abfrageparametern deactivation_date, expiration_date, expiration_date_min und expiration_date_max verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --deactivation-date-max (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Inaktivierungsdatum dem Parameterwert entspricht oder vor diesem liegt. Dieser Abfrageparameter kann nicht in Verbindung mit den Abfrageparametern deactivation_date, expiration_date, expiration_date_min und expiration_date_max verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  -- expiration-date (zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Inaktivierungsdatum dem Parameter entspricht. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --expiration-date-min (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Inaktivierungsdatum bei oder nach dem Parameterwert liegt. Dieser Abfrageparameter kann nicht in Verbindung mit den Abfrageparametern deactivation_date, expiration_date, deactivation_date_min und deactivation_date_max verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --expiration-date-max (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Inaktivierungsdatum dem Parameterwert entspricht oder vor diesem liegt. Dieser Abfrageparameter kann nicht in Verbindung mit den Abfrageparametern deactivation_date, expiration_date, deactivation_date_min und deactivation_date_max verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  -- created-at (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Erstellungszeit dem Parameter entspricht. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --created-at-min (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Erstellungszeit zum oder nach dem Parameterwert liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter created_at verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --created-at-max (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Erstellungszeit dem Parameterwert entspricht oder vor diesem liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter created_at verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  -- updated-at (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Aktualisierungszeit dem Parameter entspricht. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --updated-at-min (Zeichenfolge)

  Optional. Nur verwaltete Schlüssel zurückgeben, deren Aktualisierungszeit nach dem Parameterwert liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter updated_at verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --updated-at-max (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Aktualisierungszeit vor dem Parameterwert liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter updated_at verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --rotate-at-min (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Rotationsdatum nach dem Parameterwert liegt.

  --rotate-at-max (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Rotationsdatum vor dem Parameterwert liegt.

  -- size (int64)

  Optional. Die Größe des Schlüssels.

  -- size-min (int64)

  Optional. Die Mindestgröße des Schlüssels Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter size verwendet werden.

  -- size-max (int64)

  Optional. Die maximale Größe des Schlüssels. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter size verwendet werden.

  -- template-name (zeichenfolge)

  Gibt nur verwaltete Schlüssel zurück, deren Schablonenname mit der Zeichenfolge beginnt.

  -- template-id (Zeichenfolge[])

  Gibt nur verwaltete Schlüssel mit der angegebenen Schablonen-UUID zurück

  -- template-type (Zeichenfolge[])

  Gibt nur verwaltete Schlüssel mit dem angegebenen Schablonentyp zurück. Mögliche Werte sind user_defined, shadow und system.

  -- all-pages (bool)

  Optional. Rufen Sie mehrere Anforderungen auf, um alle Seiten der Sammlung für verwaltete Schlüssel anzuzeigen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Gibt den Status der Keystore-Verteilung für einen verwalteten Schlüssel zurück

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Schlüssels. Sie können den Befehl ibmcloud hpcs uko managed-keys verwenden, um die Schlüssel-UUID abzurufen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Aktualisieren Sie einen verwalteten Schlüssel so, dass er der neuesten Version der zugeordneten Schlüsselvorlage entspricht. Sie können den Schlüssel in Keystores in der durch die Schlüsselschablone definierten Gruppe zuordnen, aktivieren oder inaktivieren.

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Schlüssels. Sie können den Befehl ibmcloud hpcs uko managed-keys verwenden, um die Schlüssel-UUID abzurufen.

  -- if-match (Zeichenfolge)

  Erforderlich. Die Vorbedingung der Aktualisierung. Dies ist der Wert des ETag aus dem Header in einer GET-Anforderung. Sie können den Befehl ibmcloud hpcs uko managed-key verwenden, um den ETag abzurufen.

  --dry-run (boolesch)

  Optional. Erstellen, aktualisieren oder löschen Sie keine Ressource, sondern prüfen und prüfen Sie nur, ob die Ressource mit der angegebenen Anforderung erfolgreich erstellt, aktualisiert oder gelöscht werden kann. Der Standardwert ist 'false'.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Aktivieren Sie einen verwalteten Schlüssel und führen Sie Operationen zur Schlüsselinstallation oder Aktivierung für Keystores in der Keystore-Gruppe aus, die dem verwalteten Schlüssel zugeordnet ist.

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Schlüssels. Sie können den Befehl ibmcloud hpcs uko managed-keys verwenden, um die Schlüssel-UUID abzurufen.

  -- if-match (Zeichenfolge)

  Erforderlich. Die Vorbedingung der Aktualisierung. Dies ist der Wert des ETag aus dem Header in einer GET-Anforderung. Sie können den Befehl ibmcloud hpcs uko managed-key verwenden, um den ETag abzurufen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Inaktiviert einen verwalteten Schlüssel und führt Schlüsselinaktivierungsoperationen für Keystores in der Keystore-Gruppe aus, die dem verwalteten Schlüssel zugeordnet ist.

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Schlüssels. Sie können den Befehl ibmcloud hpcs uko managed-keys verwenden, um die Schlüssel-UUID abzurufen.

  -- if-match (Zeichenfolge)

  Erforderlich. Die Vorbedingung der Aktualisierung. Dies ist der Wert des ETag aus dem Header in einer GET-Anforderung. Sie können den Befehl ibmcloud hpcs uko managed-key verwenden, um den ETag abzurufen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Löschen eines verwalteten Schlüssels und Ausführen von Schlüssellöschoperationen für Keystores in der Keystore-Gruppe, die dem verwalteten Schlüssel zugeordnet ist. Diese Operation kann nicht rückgängig gemacht werden. Stellen Sie sicher, dass sich der verwaltete Schlüssel im Status deactivated befindet, bevor Sie diesen Befehl ausführen.

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Schlüssels. Sie können den Befehl ibmcloud hpcs uko managed-keys verwenden, um die Schlüssel-UUID abzurufen.

  -- if-match (Zeichenfolge)

  Erforderlich. Die Vorbedingung der Aktualisierung. Dies ist der Wert des ETag aus dem Header in einer GET-Anforderung. Sie können den Befehl ibmcloud hpcs uko managed-key verwenden, um den ETag abzurufen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Führen Sie die Synchronisationsoperation für einen verwalteten Schlüssel aus, um die Status in den zugeordneten Keystores abzustimmen.

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Schlüssels. Sie können den Befehl ibmcloud hpcs uko managed-keys verwenden, um die Schlüssel-UUID abzurufen.

  -- if-match (Zeichenfolge)

  Erforderlich. Die Vorbedingung der Aktualisierung. Dies ist der Wert des ETag aus dem Header in einer GET-Anforderung. Sie können den Befehl ibmcloud hpcs uko managed-key verwenden, um den ETag abzurufen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  {
    "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-Schlüsselvorlagen

Alle Schlüsselvorlagen in der Instanz auflisten.

Wenn die Option --all-pages nicht festgelegt ist, ruft der Befehl nur eine einzelne Seite der Objektgruppe ab.

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]

• Befehlsoptionen

  -- name (Zeichenfolge)

  Optional. Gibt nur Schablonen zurück, deren Name mit der Zeichenfolge beginnt.

  -- naming-scheme (zeichenfolge)

  Optional. Gibt nur Schablonen zurück, deren Namensschema die Zeichenfolge enthält.

  -- vault-id (zeichenfolge)

  Optional. Die UUID der Vault. Die Länge muss 36 Zeichen betragen. Der Wert muss mit dem regulären Ausdruck /^[-0-9a-z]+$/ übereinstimmen.

  -- key-algorithm (zeichenfolge)

  Optional. Der Algorithmus der zurückgegebenen Schlüsselvorlagen. Mögliche Werte sind aes, rsa, hmac, ec, des und dilithium.

  -- key-size (Zeichenfolge)

  Optional. Die Größe des Schlüssels

  --key-size-min (Zeichenfolge)

  Optional. Die Mindestgröße des Schlüssels Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter key-size verwendet werden.

  --key-size-max (Zeichenfolge)

  Optional. Die maximale Größe des Schlüssels. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter key-size verwendet werden.

  -- keystores-type ([]Zeichenfolge)

  Optional. Typ des referenzierten Keystores. Mögliche Werte sind aws_kms, azure_key_vault, ibm_cloud_kms, google_kms und cca.

  -- keystores-group ([]Zeichenfolge)

  Optional. Gruppe des referenzierten Keystores.

  -- created-at (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Erstellungszeit dem Parameter entspricht. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --created-at-min (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Erstellungszeit zum oder nach dem Parameterwert liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter created_at verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --created-at-max (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Erstellungszeit dem Parameterwert entspricht oder vor diesem liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter created_at verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  -- updated-at (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Aktualisierungszeit dem Parameter entspricht. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --updated-at-min (Zeichenfolge)

  Optional. Nur verwaltete Schlüssel zurückgeben, deren Aktualisierungszeit nach dem Parameterwert liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter updated_at verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  --updated-at-max (Zeichenfolge)

  Optional. Gibt nur verwaltete Schlüssel zurück, deren Aktualisierungszeit vor dem Parameterwert liegt. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter updated_at verwendet werden. Der Wert muss dem regulären Ausdruck /[0-9]{4}-[0-9]{2}-[0-9]{2}/ entsprechen.

  -- type ([]Zeichenfolge)

  Optional. Die Typen der zurückgegebenen Vorlagen Mögliche Werte sind user_defined, shadow und system.

  -- state ([]Zeichenfolge)

  Optional. Gibt nur Schablonen zurück, deren Status die Zeichenfolge enthält Mögliche Werte sind archived oder unarchived.

  -- sort ([]zeichenfolge)

  Optional. Die Sortierreihenfolge. Der Standardwert ist ["-updated_at"]. Die Listenelemente müssen dem regulären Ausdruck /^-?[a-z0-9_.\\[\\],-]+$/ entsprechen.

  --limit (int64)

  Optional. Die Anzahl der abzurufenden Schlüsselvorlagen. Der Wert muss zwischen 1 und 1000 liegen.

  --offset (int64)

  Optional. Die Anzahl der zu überspringenden Schlüssel. Der Mindestwert ist 0.

  -- verwaltende-Systeme

  Gibt nur verwaltete Schlüssel mit den angegebenen verwaltenden Systemen zurück Mögliche Werte sind web und workstation.

• Beispiel

  ibmcloud hpcs uko key-templates --output json
  

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Erstellen Sie eine neue Schlüsselvorlage. Schlüsselvorlagen werden verwendet, um Informationen zu kombinieren, die zum Erstellen eines Schlüssels erforderlich sind. Mit Schlüsselvorlagen können Sie ohne großen Aufwand nachfolgende Schlüssel erstellen, ohne Details anzugeben.

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

• Befehlsoptionen

  -- vault (VaultReferenceInCreationRequest)

  Erforderlich. Die ID der Vault, in der die Schlüsselschablone erstellt werden soll

  -- name (Zeichenfolge)

  Erforderlich. Der Name der Schablone. Sie müssen beim Erstellen verwalteter Schlüssel darauf verweisen. Die Länge muss zwischen 1 und 30 Zeichen liegen. Der Wert muss mit dem regulären Ausdruck /^[A-Za-z][A-Za-z0-9-]*$/ übereinstimmen.

  -- type (Zeichenfolge[])

  Erforderlich. Der Typ der Vorlage Mögliche Werte sind user_defined, shadow und system.

  -- state (Zeichenfolge)

  Erforderlich. Der Status der Vorlage Mögliche Werte sind archived oder unarchived.

  -- naming-scheme (zeichenfolge)

  Erforderlich. Das Zeichenfolgemuster, dem der Vorlagenname folgen muss.

  -- key (KeyProperties)

  Erforderlich. Eigenschaften, die den verwalteten Schlüssel beschreiben.

  -- keystores (KeystoresPropertiesErstellen [])

  Erforderlich. Ein Array, das den Typ und die Gruppe von Keystores beschreibt, in denen der verwaltete Schlüssel installiert werden soll. Die maximale Länge beträgt 1 Element. Die Mindestlänge ist 1 Element.

  --description (string)

  Optional. Die Beschreibung der Schlüsselvorlage Die Länge muss zwischen 0 und 200 Zeichen liegen. Der Wert muss mit dem regulären Ausdruck /(.|\\n)*/ übereinstimmen.

• Beispiel

  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
  

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  Standort	Zeichenfolge	Pfad zur neu erstellten Ressource relativ zum Kontextstammverzeichnis.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  {
    "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 schlüsselschablone-löschen

Löscht eine Schlüsselschablone aus dem Vault. Stellen Sie sicher, dass der Schlüsselschablone kein verwalteter Schlüssel zugeordnet ist, bevor Sie diesen Befehl ausführen.

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID der Schablone. Sie können den Befehl ibmcloud hpcs uko key-templates verwenden, um die UUID abzurufen.

  -- if-match (Zeichenfolge)

  Erforderlich. Die Vorbedingung der Aktualisierung. Dies ist der Wert des ETag aus dem Header in einer GET-Anforderung. Sie können den Befehl ibmcloud hpcs uko key-template verwenden, um den ETag abzurufen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  ...
  OK
  

ibmcloud hpcs uko schlüsselvorlage

Rufen Sie eine Schlüsselvorlage und ihre Details ab, indem Sie die ID angeben.

ibmcloud hpcs uko key-template --id ID

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID der Schablone. Sie können den Befehl ibmcloud hpcs uko key-templates verwenden, um die UUID abzurufen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  {
    "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 schlüsselschablonenaktualisierung

Attribute einer Schlüsselvorlage aktualisieren.

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID der Schablone. Sie können den Befehl ibmcloud hpcs uko key-templates verwenden, um die UUID abzurufen.

  -- if-match (Zeichenfolge)

  Erforderlich. Die Vorbedingung der Aktualisierung. Dies ist der Wert des ETag aus dem Header in einer GET-Anforderung. Sie können den Befehl ibmcloud hpcs uko key-template verwenden, um den ETag abzurufen.

  -- name (Zeichenfolge)

  Optional. Der aktualisierte Vorlagenname.

  -- keystores (KeystoresPropertiesUpdate [])

  Optional. Ein Array, das den Typ und die Gruppe der Keystores beschreibt, in denen der verwaltete Schlüssel installiert werden soll. Die maximale Länge beträgt 1 Element. Die Mindestlänge ist 1 Element.

  --description (string)

  Optional. Die aktualisierte Beschreibung der Schlüsselvorlage. Die Länge muss zwischen 0 und 200 Zeichen liegen. Der Wert muss mit dem regulären Ausdruck /(.|\\n)*/ übereinstimmen.

  -- key (KeyPropertiesAktualisieren)

  Optional. Eigenschaften des verwalteten Schlüssels.

• Beispiel

  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
  

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Alle Keystores in der Instanz auflisten.

Wenn die Option --all-pages nicht festgelegt ist, ruft der Befehl nur eine einzelne Seite der Objektgruppe ab.

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]

• Befehlsoptionen

  -- type ([]Zeichenfolge)

  Optional. Der Typ der Keystores, die abgerufen werden sollen Folgende Werte können festgelegt werden: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms und cca.

  -- name (Zeichenfolge)

  Optional. Gibt nur Keystores zurück, deren Name die Zeichenfolge enthält. Die Länge muss zwischen 1 und 100 Zeichen liegen. Der Wert muss dem regulären Ausdruck /.+/ entsprechen.

  --description (string)

  Optional. Gibt nur Keystores zurück, deren Beschreibung die Zeichenfolge enthält Die Länge muss zwischen 1 und 200 Zeichen liegen. Der Wert muss dem regulären Ausdruck /.+/ entsprechen.

  -- group (Zeichenfolge)

  Optional. Die Keystore-Gruppe. Dieser Abfrageparameter kann nicht zusammen mit dem Abfrageparameter groups[] verwendet werden.

  -- groups ([]Zeichenfolge)

  Optional. Schlüsselspeichergruppen.

  -- vault-id ([]Zeichenfolge)

  Optional. Die UUID der Vault. Die Listenelemente müssen dem regulären Ausdruck /^[-0-9a-z]+$/ entsprechen.

  -- location (Zeichenfolge)

  Optional. Die Position des Schlüsselspeichers.

  --limit (int64)

  Optional. Die Anzahl der abzurufenden Keystores. Der Wert muss zwischen 1 und 1000 liegen.

  --offset (int64)

  Optional. Die Anzahl der zu überspringenden Schlüssel. Der Mindestwert ist 0.

  -- sort ([]zeichenfolge)

  Optional. Die Sortierreihenfolge. Der Standardwert ist ["-updated_at"]. Die Listenelemente müssen dem regulären Ausdruck /^-?[a-z0-9_.\\[\\],-]+$/ entsprechen.

  -- all-pages (bool)

  Optional. Rufen Sie mehrere Anforderungen auf, um alle Seiten der Sammlung für Keystores anzuzeigen.

• Beispiel

  ibmcloud hpcs uko keystores --output json
  

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Erstellen Sie einen internen Keystore oder stellen Sie eine Verbindung zu einem externen Keystore des angeforderten Typs her. Wenn der Abfrageparameter dry_run verwendet wird, werden keine Schlüsselspeicher in der Datenbank erstellt und nur ein Test wird ausgeführt, um zu prüfen, ob die Verbindungsinformationen korrekt sind. Es ist möglich, nach den folgenden Parametern zu sortieren: name, created_at, updated_at, vault-id.

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

• Befehlsoptionen

  -- keystore-body (AnforderungKeystoreCreation)

  Erforderlich. Eigenschaften des Keystores, den Sie erstellen oder zu dem Sie eine Verbindung herstellen möchten

  --dry-run (boolescher Wert)

  Optional. Führen Sie einen Test durch, um zu überprüfen, ob ein Keystore, der mit bestimmten Parametern erstellt wurde, erfolgreich kommuniziert werden kann. In der Datenbank werden keine Keystores erstellt. Der Standardwert ist false.

• Beispiel

  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
  

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  Standort	Zeichenfolge	Pfad zur neu erstellten Ressource relativ zum Kontextstammverzeichnis.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

hpcs uko keystore-löschen

Löscht einen internen Keystore oder entfernt eine Verbindung zu einem externen Keystore. Der externe Keystore auf der fernen Plattform ist nach dem Entfernen der Verbindung weiterhin vorhanden.

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Keystores Sie können den Befehl ibmcloud hpcs uko keystores verwenden, um die UUID abzurufen.

  -- if-match (Zeichenfolge)

  Erforderlich. Die Vorbedingung der Aktualisierung. Dies ist der Wert des ETag aus dem Header in einer GET-Anforderung. Sie können den Befehl ibmcloud hpcs uko keystore verwenden, um den ETag abzurufen.

  -- mode (Zeichenfolge)

  Optional. Modus der Trennung der Verbindung zum Keystore. Die Werte können restrict, disconnect, deactivate und destroy festgelegt werden. Der Standardwert ist restrict.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  ...
  OK
  

hpcs-uko-Keystore

Rufen Sie einen internen Zielschlüsselspeicher oder eine externe Schlüsselspeicherverbindung mit den zugehörigen Details ab, indem Sie die ID angeben.

ibmcloud hpcs uko keystore --id ID

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Keystores Sie können den Befehl ibmcloud hpcs uko keystores verwenden, um die UUID abzurufen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

ibmcloud hpcs uko keystore-update

Aktualisiert Attribute eines internen Schlüsselspeichers oder einer externen Schlüsselspeicherverbindung.

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Keystores Sie können den Befehl ibmcloud hpcs uko keystores verwenden, um die UUID abzurufen.

  -- if-match (Zeichenfolge)

  Erforderlich. Die Vorbedingung der Aktualisierung. Dies ist der Wert des ETag aus dem Header in einer GET-Anforderung. Sie können den Befehl ibmcloud hpcs uko keystore verwenden, um den ETag abzurufen.

  -- keystore-body (KeystoreUpdate-Anforderung)

  Erforderlich. Keystore-Eigenschaften, die Sie aktualisieren wollen.

• Beispiel

  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
  

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  {
    "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 zugeordnete-ressourcen-für-ziel-schlüsselspeicher

Rufen Sie eine Liste der Ressourcen ab, die allen in diesem Keystore aktivierten Schlüsseln zugeordnet sind.

Wenn die Option --all-pages nicht festgelegt ist, ruft der Befehl nur eine einzelne Seite der Objektgruppe ab.

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Keystores Sie können den Befehl ibmcloud hpcs uko keystores verwenden, um die UUID abzurufen.

  --limit (int64)

  Optional. Die Anzahl der abzurufenden Ressourcen. Der Wert muss zwischen 1 und 1000 liegen.

  --offset (int64)

  Optional. Die Anzahl der zu überspringenden Ressourcen. Der Mindestwert ist 0.

  -- sort ([]zeichenfolge)

  Optional. Die Sortierreihenfolge. Der Standardwert ist ["name"]. Die Listenelemente müssen dem regulären Ausdruck /^-?[a-z0-9_.\\[\\],-]+$/ entsprechen.

  -- all-pages (bool)

  Optional. Rufen Sie mehrere Anforderungen auf, um alle Seiten der Sammlung für die zugeordneten Ressourcen für den Keystore anzuzeigen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  {
    "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 schlüsselspeicherstatus

Ruft den Status eines internen oder externen Zielschlüsselspeichers ab.

ibmcloud hpcs uko keystore-status --id ID

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID des Keystores Sie können den Befehl ibmcloud hpcs uko keystores verwenden, um die UUID abzurufen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

hpcs-uko-Vaults

Alle Vaults in der Instanz auflisten.

Wenn die Option --all-pages nicht festgelegt ist, ruft der Befehl nur eine einzelne Seite der Objektgruppe ab.

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

• Befehlsoptionen

  --limit (int64)

  Optional. Die Anzahl der abzurufenden Vaults. Der Maximalwert ist 1000. Der Mindestwert ist 1.

  --offset (int64)

  Optional. Die Anzahl der zu überspringenden Vaults. Der Mindestwert ist 0.

  -- sort ([]zeichenfolge)

  Optional. Die Sortierreihenfolge. Der Standardwert ist ["-updated_at"]. Die Listenelemente müssen dem regulären Ausdruck /^-?[a-z0-9_.\\[\\],-]+$/ entsprechen.

  -- name (Zeichenfolge)

  Optional. Gibt nur Vaults zurück, deren Namen mit der Zeichenfolge beginnen. Die Länge muss zwischen 1 und 100 Zeichen liegen. Der Wert muss mit dem regulären Ausdruck /.+/ übereinstimmen.

  --description (string)

  Optional. Gibt nur Vaults zurück, deren Beschreibung die Zeichenfolge enthält Die Länge muss zwischen 1 und 200 Zeichen liegen. Der Wert muss mit dem regulären Ausdruck /.+/ übereinstimmen.

  -- all-pages (bool)

  Optional. Rufen Sie mehrere Anforderungen auf, um alle Seiten der Sammlung für Vaults anzuzeigen.

• Beispiel

  ibmcloud hpcs uko vaults --output json
  

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Vault in der Instanz mit dem angegebenen Namen und der angegebenen Beschreibung erstellen.

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

• Befehlsoptionen

  -- name (Zeichenfolge)

  Erforderlich. Ein lesbarer Name, der Ihrer Vault zugeordnet wird Verwenden Sie zum Schutz Ihrer Privatsphäre keine personenbezogenen Daten, wie z. B. Ihren Namen oder Ihren Standort. Die Länge muss zwischen 1 und 100 Zeichen liegen. Der Wert muss mit dem regulären Ausdruck /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/ übereinstimmen.

  --description (string)

  Optional. Die Beschreibung der Vault. Die Länge muss zwischen 0 und 200 Zeichen liegen. Der Wert muss mit dem regulären Ausdruck /(.|\\n)*/ übereinstimmen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  {
    "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-löschen

Vault aus Ihrer Instanz löschen. Stellen Sie sicher, dass der Vault keine Schlüssel oder Keystores zugeordnet sind, bevor Sie den Befehl ausführen.

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID der Vault. Sie können den Befehl ibmcloud hpcs uko vaults verwenden, um die UUID abzurufen.

  -- if-match (Zeichenfolge)

  Erforderlich. Die Vorbedingung der Aktualisierung. Dies ist der Wert des ETag aus dem Header in einer GET-Anforderung. Sie können den Befehl ibmcloud hpcs uko vault verwenden, um den ETag abzurufen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

  ...
  OK
  

hpcs-uko-Vault

Rufen Sie eine Vault und ihre Details durch Angabe der ID ab.

ibmcloud hpcs uko vault --id ID

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID der Vault. Sie können den Befehl ibmcloud hpcs uko vaults verwenden, um die UUID abzurufen.

• Beispiel

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

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Attribute einer Vault aktualisieren.

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

• Befehlsoptionen

  --id (string)

  Erforderlich. Die UUID der Vault. Sie können den Befehl ibmcloud hpcs uko vaults verwenden, um die UUID abzurufen.

  -- if-match (Zeichenfolge)

  Erforderlich. Die Vorbedingung der Aktualisierung. Dies ist der Wert des ETag aus dem Header in einer GET-Anforderung. Sie können den Befehl ibmcloud hpcs uko vault verwenden, um den ETag abzurufen.

  -- name (Zeichenfolge)

  Optional. Aktualisierter Name der vault.The-Länge muss zwischen 1 und 100 Zeichen liegen. Der Wert muss mit dem regulären Ausdruck /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/ übereinstimmen.

  --description (string)

  Optional. Die Beschreibung der Vault wurde aktualisiert. Die Länge muss zwischen 0 und 200 Zeichen liegen. Der Wert muss mit dem regulären Ausdruck /(.|\\n)*/ übereinstimmen.

• Beispiel

  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
  

• Ausgabe

  Header:

  Tabelle. Befehlsausgabeheader

  Name	Typ	Beschreibung
  X-Korrelations-ID	Zeichenfolge	Eine eindeutige Kennung, die Anforderungen und Nachrichten zugeordnet wird, die einen Verweis auf eine bestimmte Transaktion oder Ereigniskette ermöglichen.
  eTag	Zeichenfolge	Kennung für eine bestimmte Version der Ressource.

  Der Befehl gibt die Ausgabe ähnlich dem folgenden Beispiel zurück:

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

Das folgende Beispiel zeigt das Format des Objekts KeyProperties.

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

KeyPropertiesAktualisieren

Das folgende Beispiel zeigt das Format des Objekts KeyPropertiesUpdate.

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

Anforderung KeystoreCreation

Das folgende Beispiel zeigt das Format des Objekts 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"
}

Anforderung KeystoreUpdate

Das folgende Beispiel zeigt das Format des Objekts 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"
}

KeystoresPropertiesErstellen[]

Das folgende Beispiel zeigt das Format des Objekts KeystoresPropertiesCreate[].

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

KeystoresPropertiesAktualisierung[]

Das folgende Beispiel zeigt das Format des Objekts KeystoresPropertiesUpdate[].

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

Tag[]

Das folgende Beispiel zeigt das Format des Objekts Tag[].

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

Anforderung VaultReferenceInCreation

Das folgende Beispiel zeigt das Format des Objekts VaultReferenceInCreationRequest.

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