CLI IBM Cloud Hyper Protect Crypto Services

Hyper Protect Crypto Services fornisce più plug-in CLI IBM Cloud® per eseguire azioni verso le tue istanze del servizio: plug-in CLI di gestione chiavi, plug-in CLI TKE (Trusted Key Entry), plug-in CLI del gestore certificati e plug-in CLI Unified Key Orchestrator (UKO).

Plug-in CLI di gestione chiavi Hyper Protect Crypto Services

Hyper Protect Crypto Services si integra con il plug-in CLI Key Protect in modo da poter utilizzare il plug-in CLI Key Protect per gestire le chiavi root e standard nelle tue istanze Hyper Protect Crypto Services.

Per come configurare il plug-in CLI Key Protect per Hyper Protect Crypto Services, vedi Esecuzione delle operazioni di gestione delle chiavi con la CLI.
Per il riferimento completo alla CLI di gestione delle chiavi, consulta Key Protect CLI command reference.

Plug-in Hyper Protect Crypto Services Trusted Key Entry CLI

Puoi utilizzare il plug-in TKE CLI per gestire le unità di crittografia assegnate al tuo account.

Installazione del plugin della CLI TKE

Per installare il plugin della CLI TKE, attieniti alla seguente procedura:

Installa la CLIIBM Cloud.

La CLI IBM Cloud richiede Java™ 1.8.0. Il prefisso per eseguire i comandi con la CLI IBM Cloud è ibmcloud.
Installa il plugin TKE più recente con il seguente comando:
```
ibmcloud plugin install tke
```
Ricevi una notifica sulla riga di comando quando sono disponibili gli aggiornamenti ai plugin e alla CLI IBM Cloud. Assicurati di mantenere aggiornata la tua CLI in modo da poter utilizzare i comandi più recenti. Puoi visualizzare la versione corrente di tutti i plugin installati eseguendo ibmcloud plugin list.
Imposta la variabile di ambiente CLOUDTKEFILES sulla tua workstation. Specificare una directory in cui si desidera che i file della stazione di lavoro e i file della stazione di lavoro di firma vengano creati e salvati. Creare la directory se non esiste.
- Sul sistema operativo Linux™ o MacOS, aggiungere la seguente riga al file .bash_profile :
```
export CLOUDTKEFILES=<path>
```
  Ad esempio, puoi specificare path con /Users/tke-files.
- Nel sistema operativo Windows™ , in Pannello di controllo, immettere environment variable nella casella di ricerca per individuare la finestra Variabile di ambiente. Crea una variabile di ambiente CLOUDTKEFILES e impostane il valore sul percorso ai file della chiave. Ad esempio, C:\users\tke-files.
L'URL dell'endpoint privato viene restituito in private. Per l'endpoint di gestione delle chiavi, utilizza il valore restituito nella sezione kms. La variabile di ambiente KP_PRIVATE_ADDR viene utilizzata per impostare l'URL dell'endpoint API sia per l'endpoint pubblico che per l'endpoint privato. Se vuoi utilizzare l'endpoint pubblico, assicurati di impostare la variabile di ambiente KP_PRIVATE_ADDR come l'URL endpoint pubblico che viene restituito nel campo public nella sezione kms.

Comandi del plugin della CLI TKE

Tabella 1. Descrive i comandi del plug-in CLI TKE
Nome comando	Descrizione	Esempio
`tke auto-init`	Inizializza automaticamente l'istanza del servizio.	`ibmcloud tke auto-init`
`tke auto-mk-rotate`	Ruota automaticamente la chiave master con un valore di chiave master generato casualmente nell'HSM di recupero.	`ibmcloud tke auto-mk-rotate`
`tke auto-recover`	Copia automaticamente il valore della chiave master corrente dall'HSM di recupero ad altre unità di crittografia nello stesso gruppo di risorse.	`ibmcloud tke auto-recover`
`tke`	Gestisce le unità di crittografia in IBM Cloud.	`ibmcloud tke`
`tke cryptounit-add`	Aggiunge unità di crittografia all'insieme di unità di crittografia con cui lavorare.	`ibmcloud tke cryptounit-add`
`tke cryptounit-admin-add`	Aggiunge un amministratore di unità di crittografia alle unità di crittografia selezionate.	`ibmcloud tke cryptounit-admin-add`
`tke cryptounit-admin-rm`	Rimuove un amministratore di unità di crittografia dalle unità di crittografia selezionate.	`ibmcloud tke cryptounit-admin-rm`
`tke cryptounit-admins`	Elenca gli amministratori installati nelle unità di crittografia selezionate.	`ibmcloud tke cryptounit-admins`
`tke cryptounit-compare`	Mette a confronto le impostazioni di configurazione delle unità di crittografia selezionate.	`ibmcloud tke cryptounit-compare`
`tke cryptounit-cp-btc`	Abilita le funzioni relative a bitcoin (BTC) nelle unità di crittografia selezionate.	`ibmcloud tke cryptounit-cp-btc`
`tke cryptounit-cp-eddsa`	Abilita le funzioni degli algoritmi di firma digitale Edwards (EdDSA) nelle unità di crittografia selezionate.	`ibmcloud tke cryptounit-cp-eddsa`
`tke cryptounit-cp-sig-other`	Abilita funzioni di firma digitale DSA non ellittiche, DSA non Edwards nelle unità di crittografia selezionate.	`ibmcloud tke cryptounit-cp-sig-other`
`tke cryptounit-exit-impr`	Esce dalla modalità impronta nelle unità di crittografia selezionate. (Obsoleto. Utilizzare invece `cryptounit-thrhld-set`.)	`ibmcloud tke cryptounit-exit-impr`
`tke cryptounit-mk`	Visualizza i registri delle chiavi master per le unità di crittografia selezionate.	`ibmcloud tke cryptounit-mk`
`tke cryptounit-mk-clrcur`	Cancella il registro delle chiavi master corrente.	`ibmcloud tke cryptounit-mk-clrcur`
`tke cryptounit-mk-clrnew`	Cancella il nuovo registro delle chiavi master.	`ibmcloud tke cryptounit-mk-clrnew`
`tke cryptounit-mk-commit`	Esegue il commit del nuovo registro delle chiavi master.	`ibmcloud tke cryptounit-mk-commit`
`tke cryptounit-mk-load`	Carica il nuovo registro delle chiavi master.	`ibmcloud tke cryptounit-mk-load`
`tke cryptounit-mk-rotate`	Promuove la chiave principale nel nuovo registro della chiave principale al registro della chiave principale corrente dopo aver rieseguito il wrapping delle chiave root e delle chiavi di cifratura nel keystore di gestione chiavi.	`ibmcloud tke cryptounit-mk-rotate`
`tke cryptounit-mk-setimm`	Non imposta immediatamente i registri della chiave principale.	`ibmcloud tke cryptounit-mk-setimm`
`tke cryptounit-rm`	Rimuove unità di crittografia dall'insieme di unità di crittografia con cui lavorare.	`ibmcloud tke cryptounit-rm`
`tke cryptounit-thrhld-set`	Imposta le soglie di firma per le unità di crittografia selezionate.	`ibmcloud tke cryptounit-thrhld-set`
`tke cryptounit-thrhlds`	Visualizza le soglie di firma per le unità di crittografia selezionate.	`ibmcloud tke cryptounit-thrhlds`
`tke cryptounit-zeroize`	Azzera le unità di crittografia selezionate.	`ibmcloud tke cryptounit-zeroize`
`tke cryptounits`	Visualizza le unità di crittografia per il gruppo di risorse corrente.	`ibmcloud tke cryptounits`
`tke failover-enable`	Abilita o aggiungi le unità di crittografia di failover dopo il provisioning di un'istanza del servizio.	`ibmcloud tke failover-enable`
`tke mk-add`	Crea e salva una nuova parte di chiave master EP11.	`ibmcloud tke mk-add`
`tke mk-rm`	Rimuove una parte di chiave master EP11 da questa workstation.	`ibmcloud tke mk-rm`
`tke mks`	Elenca le parti della chiave principale EP11 memorizzate su questa workstation.	`ibmcloud tke mks`
`tke sigkey-add`	Genera e salva una nuova chiave di firma.	`ibmcloud tke sigkey-add`
`tke sigkey-rm`	Rimuove una chiave di firma da questa workstation.	`ibmcloud tke sigkey-rm`
`tke sigkey-sel`	Seleziona le chiavi di firma da utilizzare per firmare i comandi.	`ibmcloud tke sigkey-sel`
`tke sigkeys`	Elenca le chiavi di firma memorizzate su questa workstation.	`ibmcloud tke sigkeys`
`tke help`, `tke h`	Mostra la guida.	`ibmcloud tke help`

Per ulteriori informazioni su ciascun comando, esegui questo comando nel plugin della CLI TKE:

ibmcloud tke help <command_name>

Plug-in CLI gestore certificati Hyper Protect Crypto Services

Per il piano standard Hyper Protect Crypto Services, puoi utilizzare il plug-in della CLI del gestore dei certificati per gestire i certificati e le chiavi di firma dell'amministratore per il secondo livello di autenticazione nelle connessioni API GREP11 o PKCS #11.

Installazione del plug-in della CLI del gestore certificati

Per installare il plug-in della CLI del gestore certificati, attenersi alla seguente procedura:

Installa la CLIIBM Cloud.

La CLI IBM Cloud richiede Java™ 1.8.0. Il prefisso per eseguire i comandi con la CLI IBM Cloud è ibmcloud.
Installare il plug-in del gestore certificati più recente con il seguente comando:
```
ibmcloud plugin install hpcs-cert-mgr
```
Ricevi una notifica sulla riga di comando quando sono disponibili gli aggiornamenti alla CLI e ai plug-in IBM Cloud. Assicurati di mantenere aggiornata la tua CLI in modo da poter utilizzare i comandi più recenti. Puoi visualizzare la versione corrente di tutti i plugin installati eseguendo ibmcloud plugin list.

Comandi plug-in della CLI Certificate manager

Di seguito sono elencati tutti i comandi CLI di Certificate Manager disponibili e il rispettivo utilizzo. Utilizzare -h o --help per informazioni di aiuto.

hpcs - cert - mgr adminkey get

Utilizzare questo comando per richiamare la chiave di firma dell'amministratore del certificato.

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

Opzioni comando

-- crn HPCS_CRN

Obbligatorio. Il crn della tua istanza Hyper Protect Crypto Services. È possibile utilizzare il comando ibmcloud resource service-instances --long per richiamare crn.

--private

Facoltativo. Se si utilizza questa opzione, l'URL del server gestore certificati punta alla rete privata. Ad esempio: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. region è l'abbreviazione dell'area geografica in cui accedi a IBM Cloud. In questo caso, devi utilizzare la rete privata per collegare la tua istanza del servizio.

Esempio

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

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

Output

Il comando restituisce l'output simile al seguente esempio:

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

command completed successfully.

Serie di chiavi di gestione hpc - cert - mgr

Utilizzare questo comando per creare la chiave di firma dell'amministratore per l'amministratore del certificato per la connessione al server del gestore certificati.

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

Opzioni comando

-- crn HPCS_CRN

Obbligatorio. Il crn della tua istanza Hyper Protect Crypto Services. È possibile utilizzare il comando ibmcloud resource service-instances --long per richiamare crn.

--private

Facoltativo. Se si utilizza questa opzione, l'URL del server gestore certificati punta alla rete privata. Ad esempio: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. region è l'abbreviazione dell'area geografica in cui accedi a IBM Cloud. In questo caso, devi utilizzare la rete privata per collegare la tua istanza del servizio.

Esempio

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

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

Output

Il comando restituisce l'output simile al seguente esempio:

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.

Aggiornamento adminkey hpcs - cert - mgr

Utilizzare questo comando per aggiornare la chiave di firma dell'amministratore per l'amministratore del certificato.

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

Opzioni comando

-- crn HPCS_CRN

Obbligatorio. Il crn della tua istanza Hyper Protect Crypto Services. È possibile utilizzare il comando ibmcloud resource service-instances --long per richiamare crn.

- - admin - priv - chiave ADMIN_PRIV_KEY

Obbligatorio. Il percorso file della chiave privata esistente memorizzata sulla workstation locale. La chiave privata viene utilizzata per firmare questa operazione di comando verso il server gestore certificati dell'istanza.

--private

Facoltativo. Se si utilizza questa opzione, l'URL del server gestore certificati punta alla rete privata. Ad esempio: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. region è l'abbreviazione dell'area geografica in cui accedi a IBM Cloud. In questo caso, devi utilizzare la rete privata per collegare la tua istanza del servizio.

Esempio

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}

Output

Il comando restituisce l'output simile al seguente esempio:

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

Utilizzare questo comando per eliminare la chiave di firma dell'amministratore per l'amministratore del certificato.

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

Opzioni comando

-- crn HPCS_CRN

Obbligatorio. Il crn della tua istanza Hyper Protect Crypto Services. È possibile utilizzare il comando ibmcloud resource service-instances --long per richiamare crn.

- - admin - priv - chiave ADMIN_PRIV_KEY

Obbligatorio. Il percorso file della chiave privata corrente memorizzata sulla workstation locale. La chiave privata viene utilizzata per firmare questa operazione di comando verso il server gestore certificati dell'istanza.

--private

Facoltativo. Se si utilizza questa opzione, l'URL del server gestore certificati punta alla rete privata. Ad esempio: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. region è l'abbreviazione dell'area geografica in cui accedi a IBM Cloud. In questo caso, devi utilizzare la rete privata per collegare la tua istanza del servizio.

Esempio

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}

Output

Il comando restituisce l'output simile al seguente esempio:

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

hpcs - cert - mgr cert get

Utilizzare questo comando per richiamare il certificato client sul server gestore certificati dell'istanza.

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

Opzioni comando

-- crn HPCS_CRN

Obbligatorio. Il crn della tua istanza Hyper Protect Crypto Services. È possibile utilizzare il comando ibmcloud resource service-instances --long per richiamare crn.

-- cert-id ID_CERT

Obbligatorio. L'ID stringa del certificato client che si desidera richiamare.

- - cert - store - file CERT_FILE

Facoltativo. Il percorso file per memorizzare il certificato richiamato. Se si specifica questa opzione, il file viene creato sulla stazione di lavoro locale e memorizza il contenuto del certificato.

--private

Facoltativo. Se si utilizza questa opzione, l'URL del server gestore certificati punta alla rete privata. Ad esempio: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. region è l'abbreviazione dell'area geografica in cui accedi a IBM Cloud. In questo caso, devi utilizzare la rete privata per collegare la tua istanza del servizio.

Esempio

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

Output

Il comando restituisce l'output simile al seguente esempio:

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.

Serie di cert hpcs - cert - mgr

Utilizzare questo comando per impostare i certificati client per il proprio server gestore certificati dell'istanza.

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

Opzioni comando

-- crn HPCS_CRN

Obbligatorio. Il crn della tua istanza Hyper Protect Crypto Services. È possibile utilizzare il comando ibmcloud resource service-instances --long per richiamare crn.

- - admin - priv - chiave ADMIN_PRIV_KEY

Obbligatorio. Il percorso file della chiave privata corrente memorizzata sulla workstation locale. La chiave privata viene utilizzata per firmare questa operazione di comando verso il server gestore certificati dell'istanza.

-- cert-id ID_CERT

Obbligatorio. L'ID stringa che si desidera assegnare al certificato per una facile identificazione.

-- cert FILE CERT

Obbligatorio. Il file del certificato memorizzato sulla workstation. Si consiglia di utilizzare il Certificate Manager IBM Cloud per ordinare e gestire i certificati SSL/TLS per le applicazioni e i servizi.

--private

Facoltativo. Se si utilizza questa opzione, l'URL del server gestore certificati punta alla rete privata. Ad esempio: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. region è l'abbreviazione dell'area geografica in cui accedi a IBM Cloud. In questo caso, devi utilizzare la rete privata per collegare la tua istanza del servizio.

Esempio

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}

Output

Il comando restituisce l'output simile al seguente esempio:

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

Elenco di certificati hpcs - cert - mgr

Utilizzare questo comando per elencare tutti i certificati gestiti dall'amministratore per il proprio server gestore certificati dell'istanza.

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

Opzioni comando

-- crn HPCS_CRN

Obbligatorio. Il crn della tua istanza Hyper Protect Crypto Services. È possibile utilizzare il comando ibmcloud resource service-instances --long per richiamare crn.

--private

Facoltativo. Se si utilizza questa opzione, l'URL del server gestore certificati punta alla rete privata. Ad esempio: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. region è l'abbreviazione dell'area geografica in cui accedi a IBM Cloud. In questo caso, devi utilizzare la rete privata per collegare la tua istanza del servizio.

Esempio

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

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

Output

Il comando restituisce l'output simile al seguente esempio:

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

Utilizzare questo comando per eliminare i certificati client per il server gestore certificati dell'istanza.

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

Opzioni comando

-- crn HPCS_CRN

Obbligatorio. Il crn della tua istanza Hyper Protect Crypto Services. È possibile utilizzare il comando ibmcloud resource service-instances --long per richiamare crn.

- - admin - priv - chiave ADMIN_PRIV_KEY

Obbligatorio. Il percorso file della chiave privata corrente memorizzata sulla workstation locale. La chiave privata viene utilizzata per firmare questa operazione di comando verso il server gestore certificati dell'istanza.

-- cert-id ID_CERT

Obbligatorio. L'ID stringa del certificato che vuoi eliminare.

--private

Facoltativo. Se si utilizza questa opzione, l'URL del server gestore certificati punta alla rete privata. Ad esempio: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. region è l'abbreviazione dell'area geografica in cui accedi a IBM Cloud. In questo caso, devi utilizzare la rete privata per collegare la tua istanza del servizio.

Esempio

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

Output

Il comando restituisce l'output simile al seguente esempio:

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

Plugin CLI Hyper Protect Crypto Services Unified Key Orchestrator

Puoi utilizzare il plugin della CLI Unified Key Orchestrator per gestire vault, keystore e chiavi gestite per le istanze Hyper Protect Crypto Services con il piano Unified Key Orchestrator.

Installazione del plugin della CLI Unified Key Orchestrator

Per installare il plug-in della CLI Unified Key Orchestrator, attieniti a questa procedura:

Installa la CLIIBM Cloud.

La CLI IBM Cloud richiede Java™ 1.8.0. Il prefisso per eseguire i comandi con la CLI IBM Cloud è ibmcloud.
Installa il plugin CLI Unified Key Orchestrator più recente con il seguente comando:
```
ibmcloud plugin install hpcs
```
Ricevi una notifica sulla riga di comando quando sono disponibili gli aggiornamenti alla CLI e ai plug-in IBM Cloud. Assicurati di mantenere aggiornata la tua CLI in modo da poter utilizzare i comandi più recenti. Puoi visualizzare la versione corrente di tutti i plugin installati eseguendo ibmcloud plugin list.
Imposta la variabile di ambiente UKO_URL sulla tua workstation.
```
export UKO_URL=<UKO_endpoint_URL>
```
Sostituisci <UKO_endpoint_URL> con l'URL dell'endpoint UKO della tua istanza. Puoi ottenere l'URL dell'endpoint sul tuo dashboard dell'IU della tua istanza del servizio con provisioning tramite Panoramica > Connect > Unified Key Orchestrator URL dell'endpoint. In alternativa, puoi richiamare in modo dinamico l'URL dell'endpoint API.

Comandi plug-in CLI Unified Key Orchestrator

Di seguito sono elencati tutti i comandi della CLI Unified Key Orchestrator disponibili e il relativo utilizzo. Utilizzare -h o --help per informazioni di aiuto.

Chiavi gestite uko hpcs

Elenca tutte le chiavi gestite nell'istanza. È possibile ordinare in base ai seguenti parametri: label, algorithm, state, activation - date, deactivation - date, created - at, updated - at, size, vault - id.

Se l'opzione --all-pages non è impostata, il comando richiamerà solo una singola pagina della raccolta.

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]

Opzioni comando

-- vault-id (stringa[])

Facoltativo. L'UUID (Universally Unique Identifier) del vault. È possibile utilizzare il comando ibmcloud hpcs uko managed-keys per richiamare l'UUID. La lunghezza deve essere di 36 caratteri. Gli elementi dell'elenco devono corrispondere all'espressione regolare /^[-0-9a-z]+$/.

-- algorithm (stringa[])

Facoltativo. L'algoritmo delle chiavi restituite. I valori che è possibile impostare sono aes, rsa, hmac, ec, des e dilithium.

-- state (stringa[])

Facoltativo. Lo stato in cui si trovano le chiavi restituite. Il valore predefinito è ["pre_activation","active"]. I valori che è possibile impostare sono: pre_activation, active, deactivated, destroyed, compromised e destroyed_compromised.

-- limit (int64)

Facoltativo. Il numero di chiavi da richiamare. Il valore massimo è 1000. Il valore minimo è 1. Il valore predefinito è 20.

-- offset (int64)

Facoltativo. Il numero di chiavi da tralasciare. Il valore minimo è 0.

-- sort (stringa[])

Facoltativo. Il criterio di ordinamento. Il valore predefinito è ["-updated_at"]. Gli elementi dell'elenco devono corrispondere all'espressione regolare /^-?[a-z0-9_.\\[\\],-]+$/.

-- label (stringa)

Facoltativo. L'etichetta della chiave. Il valore deve corrispondere all'espressione regolare /.+/.

-- activation - date (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di attivazione corrisponde al parametro. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - activation - date - min (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di attivazione è uguale o successiva al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query activation_date. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - activation - date - max (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di attivazione è uguale o precedente al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query activation_date. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--deactivation - data (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di disattivazione corrisponde al parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query expiration_date. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - deactivation - date - min (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di disattivazione è uguale o successiva al valore del parametro. Questo parametro di query non può essere utilizzato insieme ai parametri di query deactivation_date, expiration_date, expiration_date_min e expiration_date_max. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - disattivazione - data - max (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di disattivazione è uguale o precedente al valore del parametro. Questo parametro di query non può essere utilizzato insieme ai parametri di query deactivation_date, expiration_date, expiration_date_min e expiration_date_max. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- expiration - date (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di disattivazione corrisponde al parametro. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - expiration - date - min (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di disattivazione è uguale o successiva al valore del parametro. Questo parametro di query non può essere utilizzato insieme ai parametri di query deactivation_date, expiration_date, deactivation_date_min e deactivation_date_max. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - expiration - date - max (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di disattivazione è uguale o precedente al valore del parametro. Questo parametro di query non può essere utilizzato insieme ai parametri di query deactivation_date, expiration_date, deactivation_date_min e deactivation_date_max. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- created - at (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui ora di creazione corrisponde al parametro. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - created - at - min (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui ora di creazione è uguale o successiva al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query created_at. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - created - at - max (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui ora di creazione è uguale o precedente al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query created_at. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- updated - at (stringa)

Facoltativo. Restituire solo le chiavi gestite il cui tempo di aggiornamento corrisponde al parametro. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - updated - at - min (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui ora di aggiornamento è successiva al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query updated_at. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - updated - at - max (stringa)

Facoltativo. Restituire solo le chiavi gestite il cui tempo di aggiornamento è precedente al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query updated_at. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - rotated - at - min (stringa)

Facoltativo. Restituisce solo le chiavi gestite il cui tempo di rotazione è successivo al valore del parametro.

- - rotated - at - max (stringa)

Facoltativo. Restituisce solo le chiavi gestite il cui tempo di rotazione è precedente al valore del parametro.

-- size (int64)

Facoltativo. La dimensione della chiave.

-- size - min (int64)

Facoltativo. La dimensione minima della chiave. Questo parametro di query non può essere utilizzato insieme al parametro di query size.

-- size - max (int64)

Facoltativo. La dimensione massima della chiave. Questo parametro di query non può essere utilizzato insieme al parametro di query size.

- - referenziato - keystore - type (stringa[])

Facoltativo. Tipo di keystore di riferimento. I valori che è possibile impostare sono aws_kms, azure_key_vault, ibm_cloud_kms, google_kms e cca.

- - referenziato - keystores - name (stringa[])

Facoltativo. Nome del keystore di riferimento. Gli elementi dell'elenco devono corrispondere all'espressione regolare /[^,]+/.

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

Facoltativo. Tipo di keystore supportato da una delle istanze. I valori che è possibile impostare sono aws_kms, azure_key_vault, ibm_cloud_kms, google_kms e cca.

-- template - name (stringa)

Restituisce solo le chiavi gestite il cui nome modello inizia con la stringa.

-- template-id (stringa[])

Restituisce solo le chiavi gestite con l'UUID modello fornito.

-- template - type (stringa[])

Restituisce solo le chiavi gestite con il tipo di modello fornito. I valori che è possibile impostare sono user_defined, shadow e system.

-- gestione - sistemi

Restituisce solo le chiavi gestite con i sistemi di gestione forniti. I valori che è possibile impostare sono web e workstation.

-- tutte le pagine (bool)

Facoltativo. Richiamare più richieste per visualizzare tutte le pagine della raccolta per le chiavi gestite.

Esempio

ibmcloud hpcs uko managed-keys --output json

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.

Il comando restituisce l'output simile al seguente esempio:

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

Creare una nuova chiave in base al modello fornito. Il modello deve esistere nell'istanza prima di poter eseguire questo comando.

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

Opzioni comando

-- template - name (stringa)

Obbligatorio. Il nome del template chiave da utilizzare quando si crea una chiave. La lunghezza deve essere compresa tra 1 e 30 caratteri. Il valore deve corrispondere all'espressione regolare /^[A-Za-z][A-Za-z0-9-]+$/.

-- vault (VaultReferenceInCreationRichiesta)

Obbligatorio. L'ID del vault in cui deve essere creata la chiave gestita.

-- label (stringa)

Obbligatorio. L'etichetta della chiave. La lunghezza deve essere compresa tra 1 e 255 caratteri. Il valore deve corrispondere all'espressione regolare /^[A-Za-z0-9._ \/-]+$/.

-- tags (Tag [])

Facoltativo. Coppie chiave - valore associate alla chiave. La lunghezza deve essere compresa tra 0 e 128 elementi.

--description (stringa)

Facoltativo. La descrizione della chiave gestita. La lunghezza deve essere compresa tra 0 e 200 caratteri. Il valore deve corrispondere all'espressione regolare /(.|\\n)*/.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
Posizione	Stringa	Percorso della risorsa appena creata, relativo alla root di contesto.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

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

Elimina una chiave gestita per ID chiave dal vault. Assicurati che la chiave sia nello stato Destroyed prima di eseguire questo comando.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID della chiave. È possibile utilizzare il comando ibmcloud hpcs uko managed-keys per recuperare l'UUID chiave.

-- if - match (stringa)

Obbligatorio. La precondizione dell'aggiornamento, che è il valore dell'ETag dall'intestazione su una richiesta GET. È possibile utilizzare il comando ibmcloud hpcs uko managed-key per richiamare ETag.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.

Il comando restituisce l'output simile al seguente esempio:

...
OK

Chiave gestita uko hpcs

Richiamare una chiave gestita e i relativi dettagli specificando l'ID chiave.

ibmcloud hpcs uko managed-key --id ID

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID della chiave. È possibile utilizzare il comando ibmcloud hpcs uko managed-keys per recuperare l'UUID chiave.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

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

Aggiornare gli attributi di una chiave gestita. È possibile modificare solo lo stato della chiave separatamente da altre modifiche. La modifica dello stato di una chiave influisce sulla sua disponibilità per le operazioni crittografiche nei keystore.

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]

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID della chiave. È possibile utilizzare il comando ibmcloud hpcs uko managed-keys per recuperare l'UUID chiave.

-- if - match (stringa)

Obbligatorio. La precondizione dell'aggiornamento, che è il valore dell'ETag dall'intestazione su una richiesta GET. È possibile utilizzare il comando ibmcloud hpcs uko managed-key per richiamare ETag.

-- label (stringa)

Obbligatorio. L'etichetta della chiave. La lunghezza deve essere compresa tra 1 e 255 caratteri. Il valore deve corrispondere all'espressione regolare /^[A-Za-z0-9._ \/-]+$/.

-- activation - date (strfmt.Date)

Facoltativo. La data di attivazione deve essere fornita nel formato AAAA - MM - GG.

-- expiration - date (strfmt.Date)

Facoltativo. La data di scadenza deve essere fornita nel formato AAAA - MM - GG.

-- tags (Tag [])

Facoltativo. Coppie chiave - valore associate alla chiave. La lunghezza deve essere compresa tra 0 e 128 elementi.

--description (stringa)

Facoltativo. La descrizione della chiave gestita. La lunghezza deve essere compresa tra 0 e 200 caratteri. Il valore deve corrispondere all'espressione regolare /(.|\\n)*/.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

{
  "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 associata - risorse - per - chiave - gestita

Ottieni un elenco di risorse associate a una chiave gestita in IBM Cloud. Queste risorse cloud sono protette dalla chiave che specifichi.

Se l'opzione --all-pages non è impostata, il comando richiama solo una singola pagina della raccolta.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID della chiave. È possibile utilizzare il comando ibmcloud hpcs uko managed-keys per recuperare l'UUID chiave.

-- limit (int64)

Facoltativo. Il numero di risorse da recuperare. Il valore deve essere compreso tra 1 e 1000.

-- offset (int64)

Facoltativo. Il numero di risorse da ignorare. Il valore minimo è 0.

-- sort (stringa[])

Facoltativo. Il criterio di ordinamento. Il valore predefinito è ["name"]. Gli elementi dell'elenco devono corrispondere all'espressione regolare /^-?[a-z0-9_.\\[\\],-]+$/.

-- tutte le pagine (bool)

Facoltativo. Richiamare più richieste per mostrare tutte le pagine della raccolta per le risorse associate.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.

Il comando restituisce l'output simile al seguente esempio:

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

Elencare tutte le chiavi gestite assegnate al keystore.

Se l'opzione --all-pages non è impostata, il comando richiama solo una singola pagina della raccolta.

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]

Opzioni comando

-- uko - vault (stringa)

Obbligatorio. L'UUID del vault in cui deve essere eseguito l'aggiornamento. È possibile utilizzare il comando ibmcloud hpcs uko vaults per richiamare l'UUID.

-- id (stringa)

Obbligatorio. L'UUID del keystore. È possibile utilizzare il comando ibmcloud hpcs uko keystores per richiamare l'UUID.

-- algorithm (stringa)

Facoltativo. L'algoritmo delle chiavi restituite. I valori che è possibile impostare sono aes, rsa, hmac e ec.

-- state (stringa)

Facoltativo. Lo stato in cui si trovano le chiavi restituite. Il valore predefinito è ["pre_activation","active"]. I valori che è possibile impostare sono: pre_activation, active, deactivated, destroyed.

-- limit (int64)

Facoltativo. Il numero di chiavi da richiamare. Il valore deve essere compreso tra 1 e 1000.

-- offset (int64)

Facoltativo. Il numero di chiavi da tralasciare. Il valore minimo è 0.

-- sort (stringa[])

Facoltativo. Il criterio di ordinamento. Il valore predefinito è ["-updated_at"]. Gli elementi dell'elenco devono corrispondere all'espressione regolare /^-?[a-z0-9_.\\[\\],-]+$/.

-- label (stringa)

Facoltativo. L'etichetta della chiave. Il valore deve corrispondere all'espressione regolare /.+/.

-- activation - date (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di attivazione corrisponde al parametro. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - activation - date - min (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di attivazione è uguale o successiva al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query activation_date. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - activation - date - max (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di attivazione è uguale o precedente al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query activation_date. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--deactivation - data (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di disattivazione corrisponde al parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query expiration_date. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - deactivation - date - min (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di disattivazione è uguale o successiva al valore del parametro. Questo parametro di query non può essere utilizzato insieme ai parametri di query deactivation_date, expiration_date, expiration_date_min e expiration_date_max. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - disattivazione - data - max (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di disattivazione è uguale o precedente al valore del parametro. Questo parametro di query non può essere utilizzato insieme ai parametri di query deactivation_date, expiration_date, expiration_date_min e expiration_date_max. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- expiration - date (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di disattivazione corrisponde al parametro. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - expiration - date - min (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di disattivazione è uguale o successiva al valore del parametro. Questo parametro di query non può essere utilizzato insieme ai parametri di query deactivation_date, expiration_date, deactivation_date_min e deactivation_date_max. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - expiration - date - max (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di disattivazione è uguale o precedente al valore del parametro. Questo parametro di query non può essere utilizzato insieme ai parametri di query deactivation_date, expiration_date, deactivation_date_min e deactivation_date_max. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- created - at (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui ora di creazione corrisponde al parametro. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - created - at - min (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui ora di creazione è uguale o successiva al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query created_at. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - created - at - max (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui ora di creazione è uguale o precedente al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query created_at. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- updated - at (stringa)

Facoltativo. Restituire solo le chiavi gestite il cui tempo di aggiornamento corrisponde al parametro. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - updated - at - min (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui ora di aggiornamento è successiva al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query updated_at. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - updated - at - max (stringa)

Facoltativo. Restituire solo le chiavi gestite il cui tempo di aggiornamento è precedente al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query updated_at. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - rotate - at - min (stringa)

Facoltativo. Restituire solo le chiavi gestite la cui data di rotazione è successiva al valore del parametro.

- - rotate - at - max (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui data di rotazione è precedente al valore del parametro.

-- size (int64)

Facoltativo. La dimensione della chiave.

-- size - min (int64)

Facoltativo. La dimensione minima della chiave. Questo parametro di query non può essere utilizzato insieme al parametro di query size.

-- size - max (int64)

Facoltativo. La dimensione massima della chiave. Questo parametro di query non può essere utilizzato insieme al parametro di query size.

-- template - name (stringa)

Restituisce solo le chiavi gestite il cui nome modello inizia con la stringa.

-- template-id (stringa[])

Restituisce solo le chiavi gestite con l'UUID modello fornito.

-- template - type (stringa[])

Restituisce solo le chiavi gestite con il tipo di modello fornito. I valori che è possibile impostare sono user_defined, shadow e system.

-- tutte le pagine (bool)

Facoltativo. Richiamare più richieste per visualizzare tutte le pagine della raccolta per le chiavi gestite.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.

Il comando restituisce l'output simile al seguente esempio:

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

Restituisce lo stato di distribuzione del keystore per una chiave gestita.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID della chiave. È possibile utilizzare il comando ibmcloud hpcs uko managed-keys per recuperare l'UUID chiave.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.

Il comando restituisce l'output simile al seguente esempio:

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

Aggiornare una chiave gestita in modo che corrisponda all'ultima versione del modello di chiave associato. È possibile assegnare, attivare o disattivare la chiave sui keystore nel gruppo definito dal modello di chiave.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID della chiave. È possibile utilizzare il comando ibmcloud hpcs uko managed-keys per recuperare l'UUID chiave.

-- if - match (stringa)

Obbligatorio. La precondizione dell'aggiornamento, che è il valore dell'ETag dall'intestazione su una richiesta GET. È possibile utilizzare il comando ibmcloud hpcs uko managed-key per richiamare ETag.

--dry - run (booleano)

Facoltativo. Non creare, aggiornare o eliminare una risorsa, ma solo verificare e convalidare se la risorsa può essere creata, aggiornata o eliminata con la richiesta fornita correttamente. Il valore predefinito è false.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

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

Attivare una chiave gestita ed eseguire le operazioni di installazione o attivazione delle chiavi sui keystore nel gruppo di keystore associato alla chiave gestita.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID della chiave. È possibile utilizzare il comando ibmcloud hpcs uko managed-keys per recuperare l'UUID chiave.

-- if - match (stringa)

Obbligatorio. La precondizione dell'aggiornamento, che è il valore dell'ETag dall'intestazione su una richiesta GET. È possibile utilizzare il comando ibmcloud hpcs uko managed-key per richiamare ETag.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

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

Disattivare una chiave gestita ed eseguire le operazioni di disattivazione della chiave sui keystore nel gruppo di keystore associato alla chiave gestita.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID della chiave. È possibile utilizzare il comando ibmcloud hpcs uko managed-keys per recuperare l'UUID chiave.

-- if - match (stringa)

Obbligatorio. La precondizione dell'aggiornamento, che è il valore dell'ETag dall'intestazione su una richiesta GET. È possibile utilizzare il comando ibmcloud hpcs uko managed-key per richiamare ETag.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

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

Eliminare una chiave gestita ed eseguire operazioni di distruzione chiavi sui keystore nel gruppo di keystore associato alla chiave gestita. Questa operazione non può essere annullata. Assicurarsi che la chiave gestita sia nello stato deactivated prima di eseguire questo comando.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID della chiave. È possibile utilizzare il comando ibmcloud hpcs uko managed-keys per recuperare l'UUID chiave.

-- if - match (stringa)

Obbligatorio. La precondizione dell'aggiornamento, che è il valore dell'ETag dall'intestazione su una richiesta GET. È possibile utilizzare il comando ibmcloud hpcs uko managed-key per richiamare ETag.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

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

Eseguire l'operazione di sincronizzazione su una chiave gestita per allineare gli stati nei keystore associati.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID della chiave. È possibile utilizzare il comando ibmcloud hpcs uko managed-keys per recuperare l'UUID chiave.

-- if - match (stringa)

Obbligatorio. La precondizione dell'aggiornamento, che è il valore dell'ETag dall'intestazione su una richiesta GET. È possibile utilizzare il comando ibmcloud hpcs uko managed-key per richiamare ETag.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.

Il comando restituisce l'output simile al seguente esempio:

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

Template chiave uko hpcs

Elencare tutti i modelli chiave nell'istanza.

Se l'opzione --all-pages non è impostata, il comando richiama solo una singola pagina della raccolta.

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]

Opzioni comando

-- name (stringa)

Facoltativo. Restituisce solo i modelli il cui nome inizia con la stringa.

-- naming - scheme (stringa)

Facoltativo. Restituisce solo i modelli il cui schema di denominazione contiene la stringa.

-- vault-id (stringa)

Facoltativo. L'UUID del vault. La lunghezza deve essere di 36 caratteri. Il valore deve corrispondere all'espressione regolare /^[-0-9a-z]+$/.

-- key - algorithm (stringa)

Facoltativo. L'algoritmo dei modelli chiave restituiti. I valori che è possibile impostare sono aes, rsa, hmac, ec, des e dilithium.

-- key - size (stringa)

Facoltativo. La dimensione della chiave

- - key - size - min (stringa)

Facoltativo. La dimensione minima della chiave. Questo parametro di query non può essere utilizzato insieme al parametro di query key-size.

- - key - size - max (stringa)

Facoltativo. La dimensione massima della chiave. Questo parametro di query non può essere utilizzato insieme al parametro di query key-size.

-- keystores - type (stringa[])

Facoltativo. Tipo di keystore di riferimento. I valori che è possibile impostare sono aws_kms, azure_key_vault, ibm_cloud_kms, google_kms e cca.

-- keystores - gruppo (stringa[])

Facoltativo. Gruppo di keystore di riferimento.

-- created - at (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui ora di creazione corrisponde al parametro. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - created - at - min (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui ora di creazione è uguale o successiva al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query created_at. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - created - at - max (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui ora di creazione è uguale o precedente al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query created_at. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- updated - at (stringa)

Facoltativo. Restituire solo le chiavi gestite il cui tempo di aggiornamento corrisponde al parametro. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - updated - at - min (stringa)

Facoltativo. Restituisce solo le chiavi gestite la cui ora di aggiornamento è successiva al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query updated_at. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

- - updated - at - max (stringa)

Facoltativo. Restituire solo le chiavi gestite il cui tempo di aggiornamento è precedente al valore del parametro. Questo parametro di query non può essere utilizzato insieme al parametro di query updated_at. Il valore deve corrispondere all'espressione regolare /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- type (stringa[])

Facoltativo. I tipi di modelli restituiti. I valori che è possibile impostare sono user_defined, shadow e system.

-- state (stringa[])

Facoltativo. Restituisce solo il modello il cui stato contiene la stringa. I valori che possono essere impostati sono archived o unarchived.

-- sort (stringa[])

Facoltativo. Il criterio di ordinamento. Il valore predefinito è ["-updated_at"]. Gli elementi dell'elenco devono corrispondere all'espressione regolare /^-?[a-z0-9_.\\[\\],-]+$/.

-- limit (int64)

Facoltativo. Il numero di modelli chiave da recuperare. Il valore deve essere compreso tra 1 e 1000.

-- offset (int64)

Facoltativo. Il numero di chiavi da tralasciare. Il valore minimo è 0.

-- gestione - sistemi

Restituisce solo le chiavi gestite con i sistemi di gestione forniti. I valori che è possibile impostare sono web e workstation.

Esempio

ibmcloud hpcs uko key-templates --output json

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.

Il comando restituisce l'output simile al seguente esempio:

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

ibmcloud hpcs uko key - template - create

Creare un nuovo modello di chiave. I modelli di chiavi vengono utilizzati per combinare le informazioni necessarie per la creazione di una chiave. Con i modelli di chiavi, è possibile creare facilmente chiavi successive senza specificare alcun dettaglio.

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

Opzioni comando

-- vault (VaultReferenceInCreationRichiesta)

Obbligatorio. L'ID del vault in cui deve essere creato il modello di chiave.

-- name (stringa)

Obbligatorio. Il nome del modello. È necessario farvi riferimento quando si creano le chiavi gestite. La lunghezza deve essere compresa tra 1 e 30 caratteri. Il valore deve corrispondere all'espressione regolare /^[A-Za-z][A-Za-z0-9-]*$/.

-- type (stringa[])

Obbligatorio. Il tipo del modello. I valori che è possibile impostare sono user_defined, shadow e system.

-- state (stringa)

Obbligatorio. Lo stato del modello. I valori che possono essere impostati sono archived o unarchived.

-- naming - scheme (stringa)

Obbligatorio. Il modello di stringa che il nome del template deve seguire.

-- key (KeyProperties)

Obbligatorio. Proprietà che descrivono la chiave gestita.

-- keystores (KeystoresPropertiesCrea [])

Obbligatorio. Un array che descrive il tipo e il gruppo di keystore in cui deve essere installata la chiave gestita. La lunghezza massima è 1 item. La lunghezza minima è 1 item.

--description (stringa)

Facoltativo. La descrizione del modello di chiave. La lunghezza deve essere compresa tra 0 e 200 caratteri. Il valore deve corrispondere all'espressione regolare /(.|\\n)*/.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
Posizione	Stringa	Percorso della risorsa appena creata, relativo alla root di contesto.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

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

hpcs uko key - template - delete

Eliminare un modello di chiave dal vault. Assicurarsi che nessuna chiave gestita sia associata al modello di chiavi prima di eseguire questo comando.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID del modello. È possibile utilizzare il comando ibmcloud hpcs uko key-templates per richiamare l'UUID.

-- if - match (stringa)

Obbligatorio. La precondizione dell'aggiornamento, che è il valore dell'ETag dall'intestazione su una richiesta GET. È possibile utilizzare il comando ibmcloud hpcs uko key-template per richiamare ETag.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.

Il comando restituisce l'output simile al seguente esempio:

...
OK

ibmcloud hpcs uko key - template

Richiamare un template chiave e i relativi dettagli specificando l'ID.

ibmcloud hpcs uko key-template --id ID

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID del modello. È possibile utilizzare il comando ibmcloud hpcs uko key-templates per richiamare l'UUID.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

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

hpcs uko key - template - update

Aggiornare gli attributi di un template chiave.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID del modello. È possibile utilizzare il comando ibmcloud hpcs uko key-templates per richiamare l'UUID.

-- if - match (stringa)

Obbligatorio. La precondizione dell'aggiornamento, che è il valore dell'ETag dall'intestazione su una richiesta GET. È possibile utilizzare il comando ibmcloud hpcs uko key-template per richiamare ETag.

-- name (stringa)

Facoltativo. Il nome del modello aggiornato.

-- keystore (KeystoresPropertiesUpdate [])

Facoltativo. Un array che descrive il tipo e il gruppo di keystore in cui deve essere installata la chiave gestita. La lunghezza massima è 1 item. La lunghezza minima è 1 item.

--description (stringa)

Facoltativo. La descrizione aggiornata del modello di chiave. La lunghezza deve essere compresa tra 0 e 200 caratteri. Il valore deve corrispondere all'espressione regolare /(.|\\n)*/.

-- key (KeyPropertiesproprietà chiave)

Facoltativo. Proprietà della chiave gestita.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

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

keystore uko hpcs

Elencare tutti i keystore nell'istanza.

Se l'opzione --all-pages non è impostata, il comando richiama solo una singola pagina della raccolta.

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]

Opzioni comando

-- type (stringa[])

Facoltativo. Il tipo di keystore che si desidera richiamare. I valori che è possibile impostare sono: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms e cca.

-- name (stringa)

Facoltativo. Restituisce solo i keystore il cui nome contiene la stringa. La lunghezza deve essere compresa tra 1 e 100 caratteri. Il valore deve corrispondere all'espressione regolare /.+/.

--description (stringa)

Facoltativo. Restituisce solo i keystore la cui descrizione contiene la stringa. La lunghezza deve essere compresa tra 1 e 200 caratteri. Il valore deve corrispondere all'espressione regolare /.+/.

-- group (stringa)

Facoltativo. Il gruppo keystore. Questo parametro di query non può essere utilizzato insieme al parametro di query groups[].

-- groups (stringa[])

Facoltativo. Gruppi keystore.

-- vault-id (stringa[])

Facoltativo. L'UUID del vault. Gli elementi dell'elenco devono corrispondere all'espressione regolare /^[-0-9a-z]+$/.

-- location (stringa)

Facoltativo. Ubicazione keystore.

-- limit (int64)

Facoltativo. Il numero di keystore da richiamare. Il valore deve essere compreso tra 1 e 1000.

-- offset (int64)

Facoltativo. Il numero di chiavi da tralasciare. Il valore minimo è 0.

-- sort (stringa[])

Facoltativo. Il criterio di ordinamento. Il valore predefinito è ["-updated_at"]. Gli elementi dell'elenco devono corrispondere all'espressione regolare /^-?[a-z0-9_.\\[\\],-]+$/.

-- tutte le pagine (bool)

Facoltativo. Richiamare più richieste per visualizzare tutte le pagine della raccolta per i keystore.

Esempio

ibmcloud hpcs uko keystores --output json

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.

Il comando restituisce l'output simile al seguente esempio:

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

Creare un keystore interno o connettersi a un keystore esterno del tipo richiesto. Se si utilizza il parametro di query dry_run, non viene creato alcun keystore nel database e viene eseguito solo un test per verificare se le informazioni di connessione sono corrette. È possibile ordinare in base ai seguenti parametri: name, created_at, updated_at, vault-id.

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

Opzioni comando

-- keystore - body (KeystoreCreationKeystoreCreation)

Obbligatorio. Proprietà del keystore che si desidera creare o a cui si desidera connettersi.

--dry-run (bool)

Facoltativo. Eseguire un test per verificare se un keystore creato con determinati parametri può essere comunicato correttamente. Nessun keystore creato nel database. Il valore predefinito è false.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
Posizione	Stringa	Percorso della risorsa appena creata, relativo alla root di contesto.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

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

Keystore uko hpcs - elimina

Eliminare un keystore interno o rimuovere una connessione a un keystore esterno. Il keystore esterno sulla piattaforma remota esiste ancora dopo la rimozione della connessione.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID del keystore. È possibile utilizzare il comando ibmcloud hpcs uko keystores per richiamare l'UUID.

-- if - match (stringa)

Obbligatorio. La precondizione dell'aggiornamento, che è il valore dell'ETag dall'intestazione su una richiesta GET. È possibile utilizzare il comando ibmcloud hpcs uko keystore per richiamare ETag.

-- mode (stringa)

Facoltativo. Modalità di disconnessione dal keystore. I valori che è possibile impostare sono restrict, disconnect, deactivate e destroy. Il valore predefinito è restrict.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.

Il comando restituisce l'output simile al seguente esempio:

...
OK

keystore uko hpcs

Richiamare una connessione keystore interno o esterno di destinazione e i relativi dettagli specificando l'ID.

ibmcloud hpcs uko keystore --id ID

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID del keystore. È possibile utilizzare il comando ibmcloud hpcs uko keystores per richiamare l'UUID.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

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

Aggiornare gli attributi di un keystore interno o di una connessione keystore esterno.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID del keystore. È possibile utilizzare il comando ibmcloud hpcs uko keystores per richiamare l'UUID.

-- if - match (stringa)

Obbligatorio. La precondizione dell'aggiornamento, che è il valore dell'ETag dall'intestazione su una richiesta GET. È possibile utilizzare il comando ibmcloud hpcs uko keystore per richiamare ETag.

-- keystore - body (KeystoreUpdateKeystoreUpdate)

Obbligatorio. Le proprietà keystore che si desidera aggiornare.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

{
  "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 associate - resources - for - target - keystore

Ottenere un elenco di risorse associate a tutte le chiavi attivate in questo keystore.

Se l'opzione --all-pages non è impostata, il comando richiama solo una singola pagina della raccolta.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID del keystore. È possibile utilizzare il comando ibmcloud hpcs uko keystores per richiamare l'UUID.

-- limit (int64)

Facoltativo. Il numero di risorse da recuperare. Il valore deve essere compreso tra 1 e 1000.

-- offset (int64)

Facoltativo. Il numero di risorse da ignorare. Il valore minimo è 0.

-- sort (stringa[])

Facoltativo. Il criterio di ordinamento. Il valore predefinito è ["name"]. Gli elementi dell'elenco devono corrispondere all'espressione regolare /^-?[a-z0-9_.\\[\\],-]+$/.

-- tutte le pagine (bool)

Facoltativo. Richiamare più richieste per visualizzare tutte le pagine della raccolta per le risorse associate per il keystore.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.

Il comando restituisce l'output simile al seguente esempio:

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

Keystore uko hpcs - status

Richiamare lo stato di un keystore interno o esterno di destinazione.

ibmcloud hpcs uko keystore-status --id ID

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID del keystore. È possibile utilizzare il comando ibmcloud hpcs uko keystores per richiamare l'UUID.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.

Il comando restituisce l'output simile al seguente esempio:

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

Vault uko hpcs

Elenca tutti i vault nell'istanza.

Se l'opzione --all-pages non è impostata, il comando richiama solo una singola pagina della raccolta.

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

Opzioni comando

-- limit (int64)

Facoltativo. Il numero di vault da recuperare. Il valore massimo è 1000. Il valore minimo è 1.

-- offset (int64)

Facoltativo. Il numero di vault da ignorare. Il valore minimo è 0.

-- sort (stringa[])

Facoltativo. Il criterio di ordinamento. Il valore predefinito è ["-updated_at"]. Gli elementi dell'elenco devono corrispondere all'espressione regolare /^-?[a-z0-9_.\\[\\],-]+$/.

-- name (stringa)

Facoltativo. Restituisce solo i vault i cui nomi iniziano con la stringa. La lunghezza deve essere compresa tra 1 e 100 caratteri. Il valore deve corrispondere all'espressione regolare /.+/.

--description (stringa)

Facoltativo. Restituire solo i vault la cui descrizione contiene la stringa. La lunghezza deve essere compresa tra 1 e 200 caratteri. Il valore deve corrispondere all'espressione regolare /.+/.

-- tutte le pagine (bool)

Facoltativo. Richiamare più richieste per visualizzare tutte le pagine della raccolta per i vault.
Esempio
```
ibmcloud hpcs uko vaults --output json
```

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.

Il comando restituisce l'output simile al seguente esempio:

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

Vault - create uko hpcs

Creare un vault nell'istanza con il nome e la descrizione specificati.

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

Opzioni comando

-- name (stringa)

Obbligatorio. Un nome leggibile da assegnare al vault. Per proteggere la tua privacy, non utilizzare dati personali, come il tuo nome o la tua posizione. La lunghezza deve essere compresa tra 1 e 100 caratteri. Il valore deve corrispondere all'espressione regolare /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/.

--description (stringa)

Facoltativo. La descrizione del vault. La lunghezza deve essere compresa tra 0 e 200 caratteri. Il valore deve corrispondere all'espressione regolare /(.|\\n)*/.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

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

Elimina un vault dalla tua istanza. Assicurarsi che nessuna chiave o keystore sia collegata al vault prima di eseguire questo comando.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID del vault. È possibile utilizzare il comando ibmcloud hpcs uko vaults per richiamare l'UUID.

-- if - match (stringa)

Obbligatorio. La precondizione dell'aggiornamento, che è il valore dell'ETag dall'intestazione su una richiesta GET. È possibile utilizzare il comando ibmcloud hpcs uko vault per richiamare ETag.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.

Il comando restituisce l'output simile al seguente esempio:

...
OK

vault uko hpcs

Richiamare un vault e i relativi dettagli specificando l'ID.

ibmcloud hpcs uko vault --id ID

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID del vault. È possibile utilizzare il comando ibmcloud hpcs uko vaults per richiamare l'UUID.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

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

Vault - update uko hpcs

Aggiorna gli attributi di un vault.

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

Opzioni comando

-- id (stringa)

Obbligatorio. L'UUID del vault. È possibile utilizzare il comando ibmcloud hpcs uko vaults per richiamare l'UUID.

-- if - match (stringa)

Obbligatorio. La precondizione dell'aggiornamento, che è il valore dell'ETag dall'intestazione su una richiesta GET. È possibile utilizzare il comando ibmcloud hpcs uko vault per richiamare ETag.

-- name (stringa)

Facoltativo. Il nome aggiornato del vault vault.The deve essere compresa tra 1 e 100 caratteri. Il valore deve corrispondere all'espressione regolare /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/.

--description (stringa)

Facoltativo. Descrizione aggiornata del vault. La lunghezza deve essere compresa tra 0 e 200 caratteri. Il valore deve corrispondere all'espressione regolare /(.|\\n)*/.

Esempio

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

Output

Intestazioni:

Tabella. Intestazioni di output del comandi
Nome	Immettere	Descrizione
X - ID - correlazione	Stringa	Un identificativo univoco allegato a richieste e messaggi che consentono il riferimento a una particolare transazione o catena di eventi.
ETag	Stringa	Identificativo per una specifica versione della risorsa.

Il comando restituisce l'output simile al seguente esempio:

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

Esempi di schema di comandi CLI Unified Key Orchestrator

I seguenti esempi di schema rappresentano i dati da specificare per alcune opzioni di comandi. Questi esempi mostrano la struttura dei dati e includono i valori segnaposto per i tipi di valore previsti. Quando si esegue un comando, sostituire questi valori con i valori che si applicano al proprio ambiente come appropriato.

KeyProperties

Il seguente esempio mostra il formato dell'oggetto KeyProperties.

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

Aggiornamento KeyProperties

Il seguente esempio mostra il formato dell'oggetto KeyPropertiesUpdate.

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

Richiesta KeystoreCreation

Il seguente esempio mostra il formato dell'oggetto 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"
}

Richiesta KeystoreUpdate

Il seguente esempio mostra il formato dell'oggetto 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"
}

KeystoresPropertiesCrea[]

Il seguente esempio mostra il formato dell'oggetto KeystoresPropertiesCreate[].


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

KeystoresPropertiesAggiorna[]

Il seguente esempio mostra il formato dell'oggetto KeystoresPropertiesUpdate[].

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

Tag[]

Il seguente esempio mostra il formato dell'oggetto Tag[].

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

Richiesta VaultReferenceInCreation

Il seguente esempio mostra il formato dell'oggetto VaultReferenceInCreationRequest.

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