CLI do IBM Cloud Hyper Protect Crypto Services

O Hyper Protect Crypto Services fornece vários plug-ins da CLI do IBM Cloud® para que você execute ações para suas instâncias de serviço: plug-in da CLI de gerenciamento de chave, plug-in da CLI do Trusted Key Entry (TKE), plug-in da CLI do gerenciador de certificados e plug-in da CLI do Unified Key Orchestrator (UKO).

Plug-in da CLI do gerenciamento de chave Hyper Protect Crypto Services

O Hyper Protect Crypto Services integra-se com o plug-in da CLI do Key Protect para que seja possível usar o plug-in da CLI do Key Protect para gerenciar chaves raiz e chaves padrão em suas instâncias do Hyper Protect Crypto Services.

Para saber como configurar o plug-in da CLI do Key Protect para Hyper Protect Crypto Services, consulte Executando operações de gerenciamento de chave com a CLI.
Para a referência da CLI de gerenciamento de chave completa, consulte referência de comando da CLI Key Protect.

Plug-in da CLI do Trusted Key Entry Hyper Protect Crypto Services

É possível usar o plug-in da CLI do TKE para gerenciar unidades de criptografia que são designadas para sua conta.

Instalando o plug-in da CLI da TKE

Para instalar o plug-in da CLI da TKE, siga estas etapas:

Instale a IBM Cloud CLI.

A CLI do IBM Cloud requer Java™ 1.8.0. O prefixo para executar comandos usando a CLI do IBM Cloud é ibmcloud.
Instale o plug-in d TKE mais recente com o comando a seguir:
```
ibmcloud plugin install tke
```
Você será notificado na linha de comando quando atualizações para CLI e plug-ins do IBM Cloud estiverem disponíveis. Certifique-se de manter a sua CLI atualizada para que seja possível usar os comandos mais recentes. É possível visualizar a versão atual de todos os plug-ins instalados executando ibmcloud plugin list.
Configure a variável de ambiente CLOUDTKEFILES em sua estação de trabalho. Especifique um diretório no qual você deseja que arquivos de estação de trabalho e arquivos de estação de trabalho de assinaturas sejam criados e salvos. Crie o diretório se ele não existir.
- No sistema operacional Linux™ ou MacOS, inclua a linha a seguir no arquivo .bash_profile :
```
export CLOUDTKEFILES=<path>
```
  Por exemplo, é possível especificar o caminho para /Users/tke-files.
- No sistema operacional Windows™ , em Painel de Controle, digite environment variable na caixa de procura para localizar a janela Variáveis de Ambiente Crie uma variável de ambiente CLOUDTKEFILES e configure o valor para o caminho para os arquivos-chaves. Por exemplo, C:\users\tke-files.
A URL do terminal privado é retornada em private. Para o terminal de gerenciamento de chave, use o valor que é retornado na seção kms. A variável de ambiente KP_PRIVATE_ADDR é usada para configurar a URL do terminal de API para o terminal público e o terminal privado. Se você desejar usar o terminal público, certifique-se de configurar a variável de ambiente KP_PRIVATE_ADDR como a URL de terminal público que é retornada no campo public na seção kms.

Comandos de plug-in da CLI da TKE

Tabela 1. Descreve os comandos do plug-in do TKE CLI
Nome do comando	Descrição	Exemplo
`tke auto-init`	Inicializa automaticamente a instância de serviço.	`ibmcloud tke auto-init`
`tke auto-mk-rotate`	Gira automaticamente a chave mestra com um valor de chave mestra gerado aleatoriamente no HSM de recuperação.	`ibmcloud tke auto-mk-rotate`
`tke auto-recover`	Copia automaticamente o valor da chave mestra atual do HSM de recuperação para outras unidades de criptografia no mesmo grupo de recursos.	`ibmcloud tke auto-recover`
`tke`	Gerencia unidades de criptografia na IBM Cloud.	`ibmcloud tke`
`tke cryptounit-add`	Inclui unidades de criptografia no conjunto de unidades de criptografia com o qual trabalhar.	`ibmcloud tke cryptounit-add`
`tke cryptounit-admin-add`	Inclui um administrador de unidade de criptografia nas unidades de criptografia selecionadas.	`ibmcloud tke cryptounit-admin-add`
`tke cryptounit-admin-rm`	Remove um administrador de unidade de criptografia das unidades de criptografia selecionadas.	`ibmcloud tke cryptounit-admin-rm`
`tke cryptounit-admins`	Lista administradores instalados nas unidades de criptografia selecionadas.	`ibmcloud tke cryptounit-admins`
`tke cryptounit-compare`	Compara as definições de configuração das unidades de criptografia selecionadas.	`ibmcloud tke cryptounit-compare`
`tke cryptounit-cp-btc`	Permite funções relacionadas ao bitcoin (BTC) nas unidades de criptografia selecionadas.	`ibmcloud tke cryptounit-cp-btc`
`tke cryptounit-cp-eddsa`	Ativa as funções de algoritmos de assinatura digital de curva de Edwards (EdDSA) nas unidades de criptografia selecionadas.	`ibmcloud tke cryptounit-cp-eddsa`
`tke cryptounit-cp-sig-other`	Ativa funções de assinatura digital da DSA de curva não Elíptica, DSA de curva não de Edwards nas unidades de criptografia selecionadas.	`ibmcloud tke cryptounit-cp-sig-other`
`tke cryptounit-exit-impr`	Sai do modo de impressão nas unidades de criptografia selecionadas. (Descontinuado. Use `cryptounit-thrhld-set` como alternativa.)	`ibmcloud tke cryptounit-exit-impr`
`tke cryptounit-mk`	Exibe os registros de chave mestra para as unidades de criptografia selecionadas.	`ibmcloud tke cryptounit-mk`
`tke cryptounit-mk-clrcur`	Limpa o registro de chave mestra atual.	`ibmcloud tke cryptounit-mk-clrcur`
`tke cryptounit-mk-clrnew`	Limpa o novo registro de chave mestra.	`ibmcloud tke cryptounit-mk-clrnew`
`tke cryptounit-mk-commit`	Confirma o novo registro de chave mestra.	`ibmcloud tke cryptounit-mk-commit`
`tke cryptounit-mk-load`	Carrega o novo registro de chave mestra.	`ibmcloud tke cryptounit-mk-load`
`tke cryptounit-mk-rotate`	Promove a chave mestra no novo registro de chave mestra para o registro de chave mestra atual depois de reagrupar chaves raiz e chaves de criptografia no keystore de gerenciamento de chave.	`ibmcloud tke cryptounit-mk-rotate`
`tke cryptounit-mk-setimm`	Configura imediatamente nos registros de chave mestra.	`ibmcloud tke cryptounit-mk-setimm`
`tke cryptounit-rm`	Remove unidades de criptografia do conjunto de unidades de criptografia com o qual trabalhar.	`ibmcloud tke cryptounit-rm`
`tke cryptounit-thrhld-set`	Configura os limites de assinatura para as unidades de criptografia selecionadas.	`ibmcloud tke cryptounit-thrhld-set`
`tke cryptounit-thrhlds`	Exibe limites de assinatura para as unidades de criptografia selecionadas.	`ibmcloud tke cryptounit-thrhlds`
`tke cryptounit-zeroize`	Volta ao zero as unidades de criptografia selecionadas.	`ibmcloud tke cryptounit-zeroize`
`tke cryptounits`	Exibe as unidades criptográficas para o grupo de recursos atual.	`ibmcloud tke cryptounits`
`tke failover-enable`	Ative ou inclua unidades de criptografia de failover depois de provisionar uma instância de serviço.	`ibmcloud tke failover-enable`
`tke mk-add`	Cria e salva uma nova parte da chave mestra do EP11.	`ibmcloud tke mk-add`
`tke mk-rm`	Remove uma parte da chave mestra do EP11 dessa estação de trabalho.	`ibmcloud tke mk-rm`
`tke mks`	Lista as partes da chave mestra EP11 que estão armazenadas nesta estação de trabalho.	`ibmcloud tke mks`
`tke sigkey-add`	Gera e salva uma nova chave de assinatura.	`ibmcloud tke sigkey-add`
`tke sigkey-rm`	Remove uma chave de assinatura dessa estação de trabalho.	`ibmcloud tke sigkey-rm`
`tke sigkey-sel`	Seleciona as chaves de assinatura a serem usadas para assinar comandos.	`ibmcloud tke sigkey-sel`
`tke sigkeys`	Lista as chaves de assinatura que estão armazenadas nesta estação de trabalho.	`ibmcloud tke sigkeys`
`tke help`, `tke h`	Mostra a ajuda.	`ibmcloud tke help`

Para obter mais informações sobre cada comando, execute o comando a seguir no plug-in da CLI da TKE:

ibmcloud tke help <command_name>

Plug-in da CLI do gerenciador de certificados Hyper Protect Crypto Services

Para o plano padrão Hyper Protect Crypto Services, é possível usar o plug-in da CLI do gerenciador de certificados para gerenciar certificados e chaves de assinatura do administrador para a segunda camada de autenticação em GREP11 ou conexões de API PKCS #11.

Instalando o plug-in da CLI do gerenciador de certificados

Para instalar o plug-in da CLI do gerenciador de certificados, siga estas etapas:

Instale a IBM Cloud CLI.

A CLI do IBM Cloud requer Java™ 1.8.0. O prefixo para executar comandos usando a CLI do IBM Cloud é ibmcloud.
Instale o plug-in mais recente do gerenciador de certificados com o comando a seguir:
```
ibmcloud plugin install hpcs-cert-mgr
```
Você será notificado na linha de comandos quando as atualizações da CLI e dos plug-ins da IBM Cloud estiverem disponíveis. Certifique-se de manter a sua CLI atualizada para que seja possível usar os comandos mais recentes. É possível visualizar a versão atual de todos os plug-ins instalados executando ibmcloud plugin list.

Comandos do plug-in da CLI do Certificate manager

O seguinte lista todos os comandos da CLI do gerenciador de certificados disponíveis e seu uso correspondente. Use -h ou --help para informações de ajuda.

hpcs-cert-mgr adminkey get

Utilize este comando para recuperar a chave de assinatura do administrador do administrador de certificados.

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

Opções de comando

--crn HPCS_CRN

Obrigatório. A crn de sua instância Hyper Protect Crypto Services. É possível usar o comando ibmcloud resource service-instances --long para recuperar o crn.

-- privado

Opcional. Se você utilizar esta opção, a URL do servidor do gerenciador de certificados aponta para a rede privada. Por exemplo,: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. A region é a abreviação da área geográfica em que você faz login em IBM Cloud. Neste caso, é necessário usar a rede privada para conectar sua instância de serviço.

Exemplo

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

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

Saída

O comando retorna a saída semelhante ao exemplo a seguir:

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

command completed successfully.

hpcs-cert-mgr adminkey set

Use este comando para criar a chave de assinatura do administrador para que o administrador de certificados se conecte ao servidor do gerenciador de certificados.

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

Opções de comando

--crn HPCS_CRN

Obrigatório. A crn de sua instância Hyper Protect Crypto Services. É possível usar o comando ibmcloud resource service-instances --long para recuperar o crn.

-- privado

Opcional. Se você utilizar esta opção, a URL do servidor do gerenciador de certificados aponta para a rede privada. Por exemplo,: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. A region é a abreviação da área geográfica em que você faz login em IBM Cloud. Neste caso, é necessário usar a rede privada para conectar sua instância de serviço.

Exemplo

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

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

Saída

O comando retorna a saída semelhante ao exemplo a seguir:

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

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

command completed successfully.

hpcs-cert-mgr adminkey update

Utilize este comando para atualizar a chave de assinatura do administrador do administrador de certificados.

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

Opções de comando

--crn HPCS_CRN

Obrigatório. A crn de sua instância Hyper Protect Crypto Services. É possível usar o comando ibmcloud resource service-instances --long para recuperar o crn.

--admin-priv-key ADMIN_PRIV_KEY

Obrigatório. O caminho de arquivo da chave privada existente armazenada em sua estação de trabalho local. A chave privada é usada para assinar essa ação de comando no servidor do gerenciador de certificados da instância.

-- privado

Opcional. Se você utilizar esta opção, a URL do servidor do gerenciador de certificados aponta para a rede privada. Por exemplo,: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. A region é a abreviação da área geográfica em que você faz login em IBM Cloud. Neste caso, é necessário usar a rede privada para conectar sua instância de serviço.

Exemplo

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}

Saída

O comando retorna a saída semelhante ao exemplo a seguir:

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

Utilize este comando para excluir a chave de assinatura do administrador do administrador de certificados.

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

Opções de comando

--crn HPCS_CRN

Obrigatório. A crn de sua instância Hyper Protect Crypto Services. É possível usar o comando ibmcloud resource service-instances --long para recuperar o crn.

--admin-priv-key ADMIN_PRIV_KEY

Obrigatório. O caminho de arquivo de sua chave privada atual que está armazenada em sua estação de trabalho local. A chave privada é usada para assinar essa ação de comando no servidor do gerenciador de certificados da instância.

-- privado

Opcional. Se você utilizar esta opção, a URL do servidor do gerenciador de certificados aponta para a rede privada. Por exemplo,: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. A region é a abreviação da área geográfica em que você faz login em IBM Cloud. Neste caso, é necessário usar a rede privada para conectar sua instância de serviço.

Exemplo

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}

Saída

O comando retorna a saída semelhante ao exemplo a seguir:

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

hpcs-cert-mgr cert get

Use este comando para recuperar o certificado de cliente no servidor do gerenciador de certificados de sua instância.

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

Opções de comando

--crn HPCS_CRN

Obrigatório. A crn de sua instância Hyper Protect Crypto Services. É possível usar o comando ibmcloud resource service-instances --long para recuperar o crn.

--cert-id CERT_ID

Obrigatório. O ID da sequência de caracteres do certificado de cliente que você deseja recuperar.

--cert-store-file CERT_FILE

Opcional. O caminho de arquivo para armazenar o certificado recuperado. Se você especificar esta opção, o arquivo será criado em sua estação de trabalho local e armazenará o conteúdo do certificado.

-- privado

Opcional. Se você utilizar esta opção, a URL do servidor do gerenciador de certificados aponta para a rede privada. Por exemplo,: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. A region é a abreviação da área geográfica em que você faz login em IBM Cloud. Neste caso, é necessário usar a rede privada para conectar sua instância de serviço.

Exemplo

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

Saída

O comando retorna a saída semelhante ao exemplo a seguir:

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

command completed successfully.

hpcs-cert-mgr cert set

Use este comando para configurar certificados de cliente para o servidor gerenciador de certificados de sua instância.

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

Opções de comando

--crn HPCS_CRN

Obrigatório. A crn de sua instância Hyper Protect Crypto Services. É possível usar o comando ibmcloud resource service-instances --long para recuperar o crn.

--admin-priv-key ADMIN_PRIV_KEY

Obrigatório. O caminho de arquivo de sua chave privada atual que está armazenada em sua estação de trabalho local. A chave privada é usada para assinar essa ação de comando no servidor do gerenciador de certificados da instância.

--cert-id CERT_ID

Obrigatório. O ID da sequência de caracteres que você deseja designar ao certificado para fácil identificação.

--cert CERT_FILE

Obrigatório. O arquivo de certificado armazenado em sua estação de trabalho. Sugere-se utilizar o Gerenciador de Certificados IBM Cloud para solicitar e gerenciar certificados SSL/TLS para seus aplicativos e serviços.

-- privado

Opcional. Se você utilizar esta opção, a URL do servidor do gerenciador de certificados aponta para a rede privada. Por exemplo,: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. A region é a abreviação da área geográfica em que você faz login em IBM Cloud. Neste caso, é necessário usar a rede privada para conectar sua instância de serviço.

Exemplo

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}

Saída

O comando retorna a saída semelhante ao exemplo a seguir:

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

hpcs-cert-mgr cert list

Use este comando para listar todos os certificados gerenciados pelo administrador para o servidor do gerenciador de certificados de sua instância.

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

Opções de comando

--crn HPCS_CRN

Obrigatório. A crn de sua instância Hyper Protect Crypto Services. É possível usar o comando ibmcloud resource service-instances --long para recuperar o crn.

-- privado

Opcional. Se você utilizar esta opção, a URL do servidor do gerenciador de certificados aponta para a rede privada. Por exemplo,: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. A region é a abreviação da área geográfica em que você faz login em IBM Cloud. Neste caso, é necessário usar a rede privada para conectar sua instância de serviço.

Exemplo

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

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

Saída

O comando retorna a saída semelhante ao exemplo a seguir:

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

Use este comando para excluir certificados de cliente do servidor do gerenciador de certificados de sua instância.

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

Opções de comando

--crn HPCS_CRN

Obrigatório. A crn de sua instância Hyper Protect Crypto Services. É possível usar o comando ibmcloud resource service-instances --long para recuperar o crn.

--admin-priv-key ADMIN_PRIV_KEY

Obrigatório. O caminho de arquivo de sua chave privada atual que está armazenada em sua estação de trabalho local. A chave privada é usada para assinar essa ação de comando no servidor do gerenciador de certificados da instância.

--cert-id CERT_ID

Obrigatório. O ID da sequência de caracteres do certificado que você deseja excluir.

-- privado

Opcional. Se você utilizar esta opção, a URL do servidor do gerenciador de certificados aponta para a rede privada. Por exemplo,: cert-mgr.private.<region>.hs-crypto.cloud.ibm.com:443. A region é a abreviação da área geográfica em que você faz login em IBM Cloud. Neste caso, é necessário usar a rede privada para conectar sua instância de serviço.

Exemplo

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

Saída

O comando retorna a saída semelhante ao exemplo a seguir:

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

Plug-in da CLI do Hyper Protect Crypto Services Unified Key Orchestrator

É possível usar o plug-in da CLI Unified Key Orchestrator para gerenciar áreas seguras, keystores e chaves gerenciadas para instâncias do Hyper Protect Crypto Services com o plano Unified Key Orchestrator.

Instalando o plug-in da CLI do Unified Key Orchestrator

Para instalar o plug-in da CLI do Unified Key Orchestrator, siga estas etapas:

Instale a IBM Cloud CLI.

A CLI do IBM Cloud requer Java™ 1.8.0. O prefixo para executar comandos usando a CLI do IBM Cloud é ibmcloud.
Instale o plug-in da CLI do Unified Key Orchestrator mais recente com o comando a seguir:
```
ibmcloud plugin install hpcs
```
Você será notificado na linha de comandos quando as atualizações da CLI e dos plug-ins da IBM Cloud estiverem disponíveis. Certifique-se de manter a sua CLI atualizada para que seja possível usar os comandos mais recentes. É possível visualizar a versão atual de todos os plug-ins instalados executando ibmcloud plugin list.
Configure a variável de ambiente UKO_URL em sua estação de trabalho.
```
export UKO_URL=<UKO_endpoint_URL>
```
Substitua <UKO_endpoint_URL> por sua URL de terminal do UKO da instância É possível obter a URL de terminal em seu painel da IU da instância de serviço provisionada por meio da Visão geral > Connect > Unified Key Orchestrator URL de terminal. Ou, é possível recuperar dinamicamente a URL de terminal da API.

Comandos do plug-in da CLI do Unified Key Orchestrator

A seguir estão os comandos da CLI do Unified Key Orchestrator disponíveis e seu uso correspondente. Use -h ou --help para informações de ajuda.

hpcs uko managed-keys

Listar todas as chaves gerenciada na instância É possível classificar pelos seguintes parâmetros: label, algorithm, state, activation-date, deactivation-date, created-at, updated-at, size, vault-id.

Se a opção --all-pages não for configurada, o comando recuperará apenas uma única página da coleção

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]

Opções de comando

-- vault-id (sequência[])

Opcional. O identificador exclusivo universal (UUID) da área segura. É possível usar o comando ibmcloud hpcs uko managed-keys para recuperar o UUID. O comprimento deve ser de 36 caracteres. Os itens da lista devem corresponder à expressão regular /^[-0-9a-z]+$/..

-- algorithm (sequência[])

Opcional. O algoritmo de chaves retornadas Os valores que podem ser configurados são aes, rsa, hmac, ec, des e dilithium.

-- state (sequência[])

Opcional. O estado que as chaves retornadas devem estar. O valor padrão é ["pre_activation","active"]. Os valores que podem ser configurados são: pre_activation, active, deactivated, destroyed, compromised e destroyed_compromised.

--limit (int64)

Opcional. O número de chaves a serem recuperadas. O valor máximo é 1000.. O valor mínimo é 1. O valor padrão é 20.

--offset (int64)

Opcional. O número de chaves a serem ignoradas. O valor mínimo é 0.

-- sort (sequência[])

Opcional. A ordem de classificação.. O valor padrão é ["-updated_at"]. Os itens da lista devem corresponder à expressão regular /^-?[a-z0-9_.\\[\\],-]+$/..

-- label (sequência)

Opcional. O rótulo da chave.. O valor deve corresponder com a expressão regular /.+/.

-- activation-date (sequência)

Opcional. Retorna apenas as chaves gerenciadas cuja data de ativação corresponde ao parâmetro O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--activation-date-min (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de ativação é igual ou posterior ao valor do parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta activation_date O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--activation-date-max (sequência)

Opcional. Retorne apenas as chaves gerenciadas cuja data de ativação seja igual ou anterior ao valor do parâmetro Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta activation_date O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--deactivation-date (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de desativação corresponde ao parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta expiration_date O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--deactivation-date-min (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de desativação é igual ou posterior ao valor do parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com os parâmetros de consulta deactivation_date, expiration_date, expiration_date_min e expiration_date_max O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--deactivation-date-max (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de desativação é igual ou anterior ao valor do parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com os parâmetros de consulta deactivation_date, expiration_date, expiration_date_min e expiration_date_max O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- expiration-date (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de desativação corresponde ao parâmetro. O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--expiration-date-min (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de desativação é igual ou posterior ao valor do parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com os parâmetros de consulta deactivation_date, expiration_date, deactivation_date_min e deactivation_date_max O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--expiration-date-max (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de desativação é igual ou anterior ao valor do parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com os parâmetros de consulta deactivation_date, expiration_date, deactivation_date_min e deactivation_date_max O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- created-at (sequência)

Opcional. Retornar apenas as chaves gerenciadas cujo horário de criação corresponde ao parâmetro O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at-min (sequência)

Opcional. Retorne apenas as chaves gerenciadas cujo horário de criação seja igual ou posterior ao valor do parâmetro Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta created_at O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at-max (sequência)

Opcional. Retorna apenas chaves gerenciadas cujo horário de criação é igual ou anterior ao valor do parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta created_at O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- updated-at (sequência)

Opcional. Retornar apenas chaves gerenciadas cujo tempo de atualização corresponde ao parâmetro. O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at-min (sequência)

Opcional. Retornar apenas chaves gerenciadas cujo tempo de atualização seja posterior ao valor de parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta updated_at O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at-max (sequência)

Opcional. Retorna apenas chaves gerenciadas cujo tempo de atualização é anterior ao valor de parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta updated_at O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--girado-em-min (sequência)

Opcional. Retorna apenas as chaves gerenciadas cujo tempo de rotação é após o valor do parâmetro.

--rotacionado-no-máximo (sequência)

Opcional. Retorna apenas chaves gerenciadas cujo tempo de rotação é anterior ao valor de parâmetro.

-- size (int64)

Opcional. O tamanho da chave..

-- size-min (int64)

Opcional. O tamanho mínimo da chave. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta size

-- size-max (int64)

Opcional. O tamanho máximo da chave.. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta size

--referido-keystores-tipo (sequência[])

Opcional. Tipo de keystore referenciado. Os valores que podem ser configurados são aws_kms, azure_key_vault, ibm_cloud_kms, google_kms e cca.

--referido-keystores-nome (sequência[])

Opcional. Nome do keystore referenciado. Os itens da lista devem corresponder à expressão regular /[^,]+/..

--instances-keystore-type (sequência[])

Opcional. Tipo de keystore suportado por uma das instâncias. Os valores que podem ser configurados são aws_kms, azure_key_vault, ibm_cloud_kms, google_kms e cca.

-- template-name (sequência)

Retorna apenas as chaves gerenciadas cujo nome do modelo começa com a sequência.

-- template-id (sequência[])

Retornar apenas chaves gerenciadas com o UUID do modelo fornecido.

-- template-type (sequência[])

Retornar apenas chaves gerenciadas com o tipo de modelo fornecido. Os valores que podem ser configurados são user_defined, shadow e system..

-- sistemas de gerenciamento

Retornar apenas chaves gerenciadas com os sistemas de gerenciamento fornecidos. Os valores que podem ser configurados são web e workstation

-- todas as páginas (bool)

Opcional. Chame vários pedidos para exibir todas as páginas da coleção para chaves gerenciada

Exemplo

ibmcloud hpcs uko managed-keys --output json

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Crie uma nova chave com base no modelo fornecido O modelo deve existir em sua instância antes que seja possível executar esse comando

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

Opções de comando

-- template-name (sequência)

Obrigatório. O nome do modelo de chave a ser usado ao criar uma chave.. O comprimento deve estar entre 1 e 30 caracteres. O valor deve corresponder à expressão regular /^[A-Za-z][A-Za-z0-9-]+$/..

-- vault (VaultReferenceInCreationRequest)

Obrigatório. O ID da área segura na qual a chave gerenciada será criada.

-- label (sequência)

Obrigatório. O rótulo da chave.. O comprimento deve estar entre 1 e 255 caracteres. O valor deve corresponder à expressão regular /^[A-Za-z0-9._ \/-]+$/..

-- tags (Tag [])

Opcional. Pares chave-valor que estão associados à chave. O comprimento deve estar entre 0 e 128 itens.

--description (sequência)

Opcional. A descrição da chave gerenciada. O comprimento deve estar entre 0 e 200 caracteres. O valor deve corresponder à expressão regular /(.|\\n)*/..

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
Local	Sequência	Caminho para recurso recém-criado, relativo à raiz de contexto.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Excluir uma chave gerenciada por ID de chave da área segura. Certifique-se de que a chave esteja em um estado Destruído antes de executar esse comando

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

Opções de comando

--id (sequência)

Obrigatório. O UUID da chave.. É possível usar o comando ibmcloud hpcs uko managed-keys para recuperar o UUID chave.

-- if-match (sequência)

Obrigatório. A condição prévia da atualização, que é o valor da ETag do cabeçalho em uma solicitação GET. É possível usar o comando ibmcloud hpcs uko managed-key para recuperar a ETag.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.

O comando retorna a saída semelhante ao exemplo a seguir:

...
OK

hpcs uko managed-key

Recupere uma chave gerenciada e seus detalhes especificando o ID da chave.

ibmcloud hpcs uko managed-key --id ID

Opções de comando

--id (sequência)

Obrigatório. O UUID da chave.. É possível usar o comando ibmcloud hpcs uko managed-keys para recuperar o UUID chave.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Atualizar atributos de uma chave gerenciada. É possível modificar apenas o estado da chave separadamente de outras mudanças A mudança do estado de uma chave afeta sua disponibilidade para operações criptográficas em keystores

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]

Opções de comando

--id (sequência)

Obrigatório. O UUID da chave.. É possível usar o comando ibmcloud hpcs uko managed-keys para recuperar o UUID chave.

-- if-match (sequência)

Obrigatório. A condição prévia da atualização, que é o valor da ETag do cabeçalho em uma solicitação GET. É possível usar o comando ibmcloud hpcs uko managed-key para recuperar a ETag.

-- label (sequência)

Obrigatório. O rótulo da chave.. O comprimento deve estar entre 1 e 255 caracteres. O valor deve corresponder à expressão regular /^[A-Za-z0-9._ \/-]+$/..

-- activation-date (strfmt.Date)

Opcional. A data de ativação deve ser fornecida no formato AAAA-MM-DD.

-- expiration-date (strfmt.Date)

Opcional. A data de expiração deve ser fornecida no formato AAAA-MM-DD.

-- tags (Tag [])

Opcional. Pares chave-valor que estão associados à chave. O comprimento deve estar entre 0 e 128 itens.

--description (sequência)

Opcional. A descrição da chave gerenciada. O comprimento deve estar entre 0 e 200 caracteres. O valor deve corresponder à expressão regular /(.|\\n)*/..

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

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

hpcs uko associated-resources-for-managed-key

Obtenha uma lista de recursos associados a uma chave gerenciada no IBM Cloud Esses recursos em nuvem são protegidos pela chave especificada.

Se a opção --all-pages não for configurada, o comando recuperará apenas uma única página da coleção

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

Opções de comando

--id (sequência)

Obrigatório. O UUID da chave.. É possível usar o comando ibmcloud hpcs uko managed-keys para recuperar o UUID chave.

--limit (int64)

Opcional. O número de recursos para recuperar. O valor deve estar entre 1 e 1000.

--offset (int64)

Opcional. O número de recursos para ignorar. O valor mínimo é 0.

-- sort (sequência[])

Opcional. A ordem de classificação.. O valor padrão é ["name"]. Os itens da lista devem corresponder à expressão regular /^-?[a-z0-9_.\\[\\],-]+$/..

-- todas as páginas (bool)

Opcional. Chame vários pedidos para exibir todas as páginas da coleção para os recursos associados

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.

O comando retorna a saída semelhante ao exemplo a seguir:

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

hpcs uko managed-keys-from-keystore

Listar todas as chaves gerenciadas designadas ao keystore.

Se a opção --all-pages não for configurada, o comando recuperará apenas uma única página da coleção

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]

Opções de comando

-- uko-vault (sequência)

Obrigatório. O UUID da área segura na qual a atualização deve ocorrer É possível usar o comando ibmcloud hpcs uko vaults para recuperar o UUID.

--id (sequência)

Obrigatório. O UUID do keystore. É possível usar o comando ibmcloud hpcs uko keystores para recuperar o UUID.

-- algorithm (sequência)

Opcional. O algoritmo das chaves retornadas Os valores que podem ser configurados são aes, rsa, hmac e ec.

-- state (sequência)

Opcional. O estado que as chaves retornadas devem estar. O valor padrão é ["pre_activation","active"]. Os valores que podem ser configurados são: pre_activation, active, deactivated, destroyed.

--limit (int64)

Opcional. O número de chaves a serem recuperadas. O valor deve estar entre 1 e 1000.

--offset (int64)

Opcional. O número de chaves a serem ignoradas. O valor mínimo é 0.

-- sort (sequência[])

Opcional. A ordem de classificação.. O valor padrão é ["-updated_at"]. Os itens da lista devem corresponder à expressão regular /^-?[a-z0-9_.\\[\\],-]+$/..

-- label (sequência)

Opcional. O rótulo da chave.. O valor deve corresponder com a expressão regular /.+/.

-- activation-date (sequência)

Opcional. Retorna apenas as chaves gerenciadas cuja data de ativação corresponde ao parâmetro O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--activation-date-min (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de ativação é igual ou posterior ao valor do parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta activation_date O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--activation-date-max (sequência)

Opcional. Retorne apenas as chaves gerenciadas cuja data de ativação seja igual ou anterior ao valor do parâmetro Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta activation_date O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--deactivation-date (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de desativação corresponde ao parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta expiration_date O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--deactivation-date-min (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de desativação é igual ou posterior ao valor do parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com os parâmetros de consulta deactivation_date, expiration_date, expiration_date_min e expiration_date_max O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--deactivation-date-max (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de desativação é igual ou anterior ao valor do parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com os parâmetros de consulta deactivation_date, expiration_date, expiration_date_min e expiration_date_max O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- expiration-date (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de desativação corresponde ao parâmetro. O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--expiration-date-min (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de desativação é igual ou posterior ao valor do parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com os parâmetros de consulta deactivation_date, expiration_date, deactivation_date_min e deactivation_date_max O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--expiration-date-max (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de desativação é igual ou anterior ao valor do parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com os parâmetros de consulta deactivation_date, expiration_date, deactivation_date_min e deactivation_date_max O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- created-at (sequência)

Opcional. Retornar apenas as chaves gerenciadas cujo horário de criação corresponde ao parâmetro O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at-min (sequência)

Opcional. Retorne apenas as chaves gerenciadas cujo horário de criação seja igual ou posterior ao valor do parâmetro Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta created_at O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at-max (sequência)

Opcional. Retorna apenas chaves gerenciadas cujo horário de criação é igual ou anterior ao valor do parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta created_at O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- updated-at (sequência)

Opcional. Retornar apenas chaves gerenciadas cujo tempo de atualização corresponde ao parâmetro. O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at-min (sequência)

Opcional. Retornar apenas chaves gerenciadas cujo tempo de atualização seja posterior ao valor de parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta updated_at O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at-max (sequência)

Opcional. Retorna apenas chaves gerenciadas cujo tempo de atualização é anterior ao valor de parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta updated_at O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--rotate-at-min (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de rotação é posterior ao valor de parâmetro.

--rotate-at-max (sequência)

Opcional. Retorna apenas chaves gerenciadas cuja data de rotação é anterior ao valor de parâmetro.

-- size (int64)

Opcional. O tamanho da chave..

-- size-min (int64)

Opcional. O tamanho mínimo da chave. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta size

-- size-max (int64)

Opcional. O tamanho máximo da chave.. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta size

-- template-name (sequência)

Retorna apenas as chaves gerenciadas cujo nome do modelo começa com a sequência.

-- template-id (sequência[])

Retornar apenas chaves gerenciadas com o UUID do modelo fornecido.

-- template-type (sequência[])

Retornar apenas chaves gerenciadas com o tipo de modelo fornecido. Os valores que podem ser configurados são user_defined, shadow e system..

-- todas as páginas (bool)

Opcional. Chame vários pedidos para exibir todas as páginas da coleção para chaves gerenciada

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Retorne o status de distribuição do keystore para uma chave gerenciada.

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

Opções de comando

--id (sequência)

Obrigatório. O UUID da chave.. É possível usar o comando ibmcloud hpcs uko managed-keys para recuperar o UUID chave.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Atualize uma chave gerenciida para corresponder à versão mais recente do modelo de chave associado É possível designar, ativar ou desativar a chave nos armazenamentos de chaves no grupo definido pelo modelo de chaves

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

Opções de comando

--id (sequência)

Obrigatório. O UUID da chave.. É possível usar o comando ibmcloud hpcs uko managed-keys para recuperar o UUID chave.

-- if-match (sequência)

Obrigatório. A condição prévia da atualização, que é o valor da ETag do cabeçalho em uma solicitação GET. É possível usar o comando ibmcloud hpcs uko managed-key para recuperar a ETag.

--dry-run (booleano)

Opcional. Não crie, atualize ou exclua um recurso, somente verifique e valide se o recurso pode ser criado, atualizado ou excluído com a solicitação fornecida com êxito O valor padrão é false.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Ative uma chave gerenciadas e execute operações de instalação ou ativação de chave nos keystores no grupo de keystore associado à chave gerenciada.

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

Opções de comando

--id (sequência)

Obrigatório. O UUID da chave.. É possível usar o comando ibmcloud hpcs uko managed-keys para recuperar o UUID chave.

-- if-match (sequência)

Obrigatório. A condição prévia da atualização, que é o valor da ETag do cabeçalho em uma solicitação GET. É possível usar o comando ibmcloud hpcs uko managed-key para recuperar a ETag.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Desative uma chave gerenciada e execute operações de desativação de chave nos keystores no grupo de keystore associado à chave gerenciada.

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

Opções de comando

--id (sequência)

Obrigatório. O UUID da chave.. É possível usar o comando ibmcloud hpcs uko managed-keys para recuperar o UUID chave.

-- if-match (sequência)

Obrigatório. A condição prévia da atualização, que é o valor da ETag do cabeçalho em uma solicitação GET. É possível usar o comando ibmcloud hpcs uko managed-key para recuperar a ETag.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Destruir uma chave gerenciada e executar operações de destruição de chave em keystores no grupo de keystore associado à chave gerenciada. Essa operação não pode ser desfeita. Certifique-se de que a chave gerenciada esteja em um estado deactivated antes de executar esse comando

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

Opções de comando

--id (sequência)

Obrigatório. O UUID da chave.. É possível usar o comando ibmcloud hpcs uko managed-keys para recuperar o UUID chave.

-- if-match (sequência)

Obrigatório. A condição prévia da atualização, que é o valor da ETag do cabeçalho em uma solicitação GET. É possível usar o comando ibmcloud hpcs uko managed-key para recuperar a ETag.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Execute a operação de sincronização em uma chave gerenciada para alinhar os estados no armazenamento de chaves associados

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

Opções de comando

--id (sequência)

Obrigatório. O UUID da chave.. É possível usar o comando ibmcloud hpcs uko managed-keys para recuperar o UUID chave.

-- if-match (sequência)

Obrigatório. A condição prévia da atualização, que é o valor da ETag do cabeçalho em uma solicitação GET. É possível usar o comando ibmcloud hpcs uko managed-key para recuperar a ETag.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Listar todos os modelos de chave na instância

Se a opção --all-pages não for configurada, o comando recuperará apenas uma única página da coleção

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]

Opções de comando

--name (string)

Opcional. Retornar apenas modelos cujo nome comece com a sequência de caracteres

-- naming-scheme (sequência)

Opcional. Retornar apenas modelos cujo esquema de nomenclatura contém a sequência de caracteres

-- vault-id (sequência)

Opcional. O UUID da área segura. O comprimento deve ser de 36 caracteres. O valor deve corresponder à expressão regular /^[-0-9a-z]+$/..

-- key-algorithm (sequência)

Opcional. O algoritmo dos modelos de chave retornados. Os valores que podem ser configurados são aes, rsa, hmac, ec, des e dilithium.

-- key-size (sequência)

Opcional. O tamanho da chave

--key-size-min (sequência)

Opcional. O tamanho mínimo da chave. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta key-size

--key-size-max (sequência)

Opcional. O tamanho máximo da chave.. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta key-size

-- keystores-tipo (sequência[])

Opcional. Tipo de keystore referenciado. Os valores que podem ser configurados são aws_kms, azure_key_vault, ibm_cloud_kms, google_kms e cca.

-- keystores-grupo (sequência[])

Opcional. Grupo de keystore referenciado.

-- created-at (sequência)

Opcional. Retornar apenas as chaves gerenciadas cujo horário de criação corresponde ao parâmetro O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at-min (sequência)

Opcional. Retorne apenas as chaves gerenciadas cujo horário de criação seja igual ou posterior ao valor do parâmetro Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta created_at O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at-max (sequência)

Opcional. Retorna apenas chaves gerenciadas cujo horário de criação é igual ou anterior ao valor do parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta created_at O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- updated-at (sequência)

Opcional. Retornar apenas chaves gerenciadas cujo tempo de atualização corresponde ao parâmetro. O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at-min (sequência)

Opcional. Retornar apenas chaves gerenciadas cujo tempo de atualização seja posterior ao valor de parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta updated_at O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at-max (sequência)

Opcional. Retorna apenas chaves gerenciadas cujo tempo de atualização é anterior ao valor de parâmetro. Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta updated_at O valor deve corresponder com a expressão regular /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

-- type (sequência[])

Opcional. Os tipos de modelos retornados Valores podem ser configurados como user_defined, shadow e system.

-- state (sequência[])

Opcional. Retornar apenas o modelo cujo estado contém a sequência de caracteres Os valores que podem ser configurados são archived ou unarchived

-- sort (sequência[])

Opcional. A ordem de classificação.. O valor padrão é ["-updated_at"]. Os itens da lista devem corresponder à expressão regular /^-?[a-z0-9_.\\[\\],-]+$/..

--limit (int64)

Opcional. O número de modelos de chave para recuperar. O valor deve estar entre 1 e 1000.

--offset (int64)

Opcional. O número de chaves a serem ignoradas. O valor mínimo é 0.

-- sistemas de gerenciamento

Retornar apenas chaves gerenciadas com os sistemas de gerenciamento fornecidos. Os valores que podem ser configurados são web e workstation

Exemplo

ibmcloud hpcs uko key-templates --output json

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Crie um novo modelo de chave. Os modelos de chave são usados para combinar informações que são necessárias para criar uma chave. Com modelos de chave, é possível criar facilmente chaves subsequentes sem especificar nenhum detalhe.

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

Opções de comando

-- vault (VaultReferenceInCreationRequest)

Obrigatório. O ID da área segura onde o modelo de chave deve ser criado.

--name (string)

Obrigatório. O nome do modelo. É necessário referenciá-lo ao criar chaves gerenciadas O comprimento deve estar entre 1 e 30 caracteres. O valor deve corresponder à expressão regular /^[A-Za-z][A-Za-z0-9-]*$/..

-- type (sequência[])

Obrigatório. O tipo do modelo. Os valores que podem ser configurados são user_defined, shadow e system..

-- state (sequência)

Obrigatório. O estado do modelo. Os valores que podem ser configurados são archived ou unarchived

-- naming-scheme (sequência)

Obrigatório. O padrão de sequência que o nome do seu modelo precisa seguir

-- key (KeyProperties)

Obrigatório. Propriedades que descrevem a chave gerenciada..

-- keystores (KeystoresPropertiesCriar [])

Obrigatório. Uma matriz que descreve o tipo e o grupo de keystores nos quais a chave gerenciada será instalada. O comprimento máximo é o item 1 O comprimento mínimo é o item 1

--description (sequência)

Opcional. A descrição do modelo de chave. O comprimento deve estar entre 0 e 200 caracteres. O valor deve corresponder à expressão regular /(.|\\n)*/..

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
Local	Sequência	Caminho para recurso recém-criado, relativo à raiz de contexto.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Exclua um modelo de chave da área segura. Assegure-se de que nenhuma chave gerenciada esteja associada ao modelo de chave antes de executar esse comando.

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

Opções de comando

--id (sequência)

Obrigatório. O UUID do modelo. É possível usar o comando ibmcloud hpcs uko key-templates para recuperar o UUID.

-- if-match (sequência)

Obrigatório. A condição prévia da atualização, que é o valor da ETag do cabeçalho em uma solicitação GET. É possível usar o comando ibmcloud hpcs uko key-template para recuperar a ETag.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.

O comando retorna a saída semelhante ao exemplo a seguir:

...
OK

ibmcloud hpcs uko key-template

Recupere um modelo de chave e seus detalhes, especificando o ID.

ibmcloud hpcs uko key-template --id ID

Opções de comando

--id (sequência)

Obrigatório. O UUID do modelo. É possível usar o comando ibmcloud hpcs uko key-templates para recuperar o UUID.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Atualizar atributos de um modelo de chave.

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

Opções de comando

--id (sequência)

Obrigatório. O UUID do modelo. É possível usar o comando ibmcloud hpcs uko key-templates para recuperar o UUID.

-- if-match (sequência)

Obrigatório. A condição prévia da atualização, que é o valor da ETag do cabeçalho em uma solicitação GET. É possível usar o comando ibmcloud hpcs uko key-template para recuperar a ETag.

--name (string)

Opcional. O nome do modelo atualizado.

-- keystores (KeystoresPropertiesAtualizar [])

Opcional. Uma matriz que descreve o tipo e o grupo de armazenamentos de chaves em que a chave gerenciada deve ser instalada O comprimento máximo é o item 1 O comprimento mínimo é o item 1

--description (sequência)

Opcional. A descrição atualizada do modelo de chave. O comprimento deve estar entre 0 e 200 caracteres. O valor deve corresponder à expressão regular /(.|\\n)*/..

-- key (KeyPropertiesAtualizar)

Opcional. Propriedades da chave gerenciada..

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

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

hpcs uko keystores

Listar todos os armazenamentos de chaves na instância

Se a opção --all-pages não for configurada, o comando recuperará apenas uma única página da coleção

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]

Opções de comando

-- type (sequência[])

Opcional. O tipo de keystores que deseja recuperar. Os valores que podem ser configurados são: aws_kms, azure_key_vault, ibm_cloud_kms, google_kms e cca.

--name (string)

Opcional. Retorne apenas keystores cujo nome contenha a cadeia. O comprimento deve estar entre 1 e 100 caracteres. O valor deve corresponder com a expressão regular /.+/.

--description (sequência)

Opcional. Retorna apenas armazenamentos de chaves cuja descrição contém a cadeia de caracteres O comprimento deve estar entre 1 e 200 caracteres. O valor deve corresponder com a expressão regular /.+/.

-- group (sequência)

Opcional. O grupo de armazenamento de chaves Esse parâmetro de consulta não pode ser usado em conjunto com o parâmetro de consulta groups[]

--groups ([]sequência)

Opcional. Grupos de keystore.

-- vault-id (sequência[])

Opcional. O UUID da área segura. Os itens da lista devem corresponder à expressão regular /^[-0-9a-z]+$/..

-- localização (sequência)

Opcional. Local do keystore.

--limit (int64)

Opcional. O número de armazenamentos de chaves a serem recuperadas O valor deve estar entre 1 e 1000.

--offset (int64)

Opcional. O número de chaves a serem ignoradas. O valor mínimo é 0.

-- sort (sequência[])

Opcional. A ordem de classificação.. O valor padrão é ["-updated_at"]. Os itens da lista devem corresponder à expressão regular /^-?[a-z0-9_.\\[\\],-]+$/..

-- todas as páginas (bool)

Opcional. Chame vários pedidos para exibir todas as páginas da coleção para keystores

Exemplo

ibmcloud hpcs uko keystores --output json

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Crie um keystore interno ou conecte-se a um keystore externo do tipo solicitado. Se o parâmetro de consulta dry_run for usado, nenhum keystore será criado no banco de dados e apenas um teste será executado para verificar se as informações de conexão estão corretas. É possível classificar pelos parâmetros a seguir: name, created_at, updated_at, vault-id

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

Opções de comando

-- keystore-body (KeystoreCreation

Obrigatório. Propriedades do keystore ao qual você deseja criar ou se conectar.

--dry-run (bool)

Opcional. Execute um teste para verificar se um keystore criado com parâmetros fornecidos pode ser comunicado com êxito. Nenhum keystore é criado no banco de dados. O valor padrão é false.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
Local	Sequência	Caminho para recurso recém-criado, relativo à raiz de contexto.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

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

hpcs uko keystore-excluir

Exclua um keystore interno ou remova uma conexão com um keystore externo. O keystore externo na plataforma remota ainda existe após a remoção da conexão.

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

Opções de comando

--id (sequência)

Obrigatório. O UUID do keystore. É possível usar o comando ibmcloud hpcs uko keystores para recuperar o UUID.

-- if-match (sequência)

Obrigatório. A condição prévia da atualização, que é o valor da ETag do cabeçalho em uma solicitação GET. É possível usar o comando ibmcloud hpcs uko keystore para recuperar a ETag.

-- mode (sequência)

Opcional. Modo de desconexão do keystore. Os valores podem ser configurados como restrict, disconnect, deactivate e destroy.. O valor padrão é restrict.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.

O comando retorna a saída semelhante ao exemplo a seguir:

...
OK

hpcs uko keystore

Recupere uma conexão de keystore interno ou de keystore externo de destino e seus detalhes especificando o ID.

ibmcloud hpcs uko keystore --id ID

Opções de comando

--id (sequência)

Obrigatório. O UUID do keystore. É possível usar o comando ibmcloud hpcs uko keystores para recuperar o UUID.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

{
  "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-atualização

Atualize os atributos de um keystore interno ou de uma conexão de keystore externo.

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

Opções de comando

--id (sequência)

Obrigatório. O UUID do keystore. É possível usar o comando ibmcloud hpcs uko keystores para recuperar o UUID.

-- if-match (sequência)

Obrigatório. A condição prévia da atualização, que é o valor da ETag do cabeçalho em uma solicitação GET. É possível usar o comando ibmcloud hpcs uko keystore para recuperar a ETag.

-- keystore-body (KeystoreUpdateSolicitação)

Obrigatório. Propriedades do keystore que você deseja atualizar.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Obtenha uma lista de recursos associados a todas as chaves ativadas neste keystore.

Se a opção --all-pages não for configurada, o comando recuperará apenas uma única página da coleção

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

Opções de comando

--id (sequência)

Obrigatório. O UUID do keystore. É possível usar o comando ibmcloud hpcs uko keystores para recuperar o UUID.

--limit (int64)

Opcional. O número de recursos para recuperar. O valor deve estar entre 1 e 1000.

--offset (int64)

Opcional. O número de recursos para ignorar. O valor mínimo é 0.

-- sort (sequência[])

Opcional. A ordem de classificação.. O valor padrão é ["name"]. Os itens da lista devem corresponder à expressão regular /^-?[a-z0-9_.\\[\\],-]+$/..

-- todas as páginas (bool)

Opcional. Chame diversas solicitações para exibir todas as páginas da coleção para os recursos associados para o keystore.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Recupere o status de um keystore interno ou externo de destino.

ibmcloud hpcs uko keystore-status --id ID

Opções de comando

--id (sequência)

Obrigatório. O UUID do keystore. É possível usar o comando ibmcloud hpcs uko keystores para recuperar o UUID.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.

O comando retorna a saída semelhante ao exemplo a seguir:

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

hpcs uko vaults

Listar todas as áreas seguras na instância

Se a opção --all-pages não for configurada, o comando recuperará apenas uma única página da coleção

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

Opções de comando

--limit (int64)

Opcional. O número de áreas seguras a serem recuperados O valor máximo é 1000.. O valor mínimo é 1.

--offset (int64)

Opcional. O número de áreas seguras para ignorar. O valor mínimo é 0.

-- sort (sequência[])

Opcional. A ordem de classificação.. O valor padrão é ["-updated_at"]. Os itens da lista devem corresponder à expressão regular /^-?[a-z0-9_.\\[\\],-]+$/..

--name (string)

Opcional. Retorna apenas áreas seguras cujos nomes começam com a sequência. O comprimento deve estar entre 1 e 100 caracteres. O valor deve corresponder à expressão regular /.+/..

--description (sequência)

Opcional. Retornar apenas áreas seguras cuja descrição contém a cadeia de caracteres O comprimento deve estar entre 1 e 200 caracteres.. O valor deve corresponder à expressão regular /.+/..

-- todas as páginas (bool)

Opcional. Chame várias solicitações para exibir todas as páginas da coleção para áreas seguras
Exemplo
```
ibmcloud hpcs uko vaults --output json
```

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.

O comando retorna a saída semelhante ao exemplo a seguir:

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

hpcs uko vault-criar

Crie uma área segura na instância com o nome e a descrição especificados

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

Opções de comando

--name (string)

Obrigatório. Um nome legível para designar à área segura. Para proteger sua privacidade, não use dados pessoais, como seu nome ou localização. O comprimento deve estar entre 1 e 100 caracteres. O valor deve corresponder à expressão regular /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/..

--description (sequência)

Opcional. A descrição da área segura. O comprimento deve estar entre 0 e 200 caracteres. O valor deve corresponder à expressão regular /(.|\\n)*/..

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

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

Excluir uma área segura de sua instância. Certifique-se de que nenhuma chave ou armazenamento de chaves esteja anexado à área segura antes de executar este comando

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

Opções de comando

--id (sequência)

Obrigatório. O UUID da área segura. É possível usar o comando ibmcloud hpcs uko vaults para recuperar o UUID.

-- if-match (sequência)

Obrigatório. A condição prévia da atualização, que é o valor da ETag do cabeçalho em uma solicitação GET. É possível usar o comando ibmcloud hpcs uko vault para recuperar a ETag.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.

O comando retorna a saída semelhante ao exemplo a seguir:

...
OK

hpcs uko vault

Recuperar uma área segura e seus detalhes especificando o ID.

ibmcloud hpcs uko vault --id ID

Opções de comando

--id (sequência)

Obrigatório. O UUID da área segura. É possível usar o comando ibmcloud hpcs uko vaults para recuperar o UUID.

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

{
  "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-atualização

Atualizar atributos de uma área segura.

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

Opções de comando

--id (sequência)

Obrigatório. O UUID da área segura. É possível usar o comando ibmcloud hpcs uko vaults para recuperar o UUID.

-- if-match (sequência)

Obrigatório. A condição prévia da atualização, que é o valor da ETag do cabeçalho em uma solicitação GET. É possível usar o comando ibmcloud hpcs uko vault para recuperar a ETag.

--name (string)

Opcional. Nome atualizado da área segura vault.The deve estar entre 1 e 100 caracteres. O valor deve corresponder à expressão regular /^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/..

--description (sequência)

Opcional. Descrição atualizada da área segura. O comprimento deve estar entre 0 e 200 caracteres. O valor deve corresponder à expressão regular /(.|\\n)*/..

Exemplo

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

Saída

Cabeçalhos:

Tabela. Cabeçalhos de saída de comando..
Nome	Tipo	Descrição
X-Correlação-ID	Sequência	Um identificador exclusivo que é conectado a solicitações e mensagens que permitem referência a uma transação ou cadeia de eventos específica.
ETag	Sequência	Identificador para uma versão específica do recurso.

O comando retorna a saída semelhante ao exemplo a seguir:

{
  "id": "5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
  "name": "Test Vault Name",
  "description": "'Test Vault Name' description.",
  "created_at": "2022-03-09T10:57:43Z",
  "updated_at": "2022-03-09T10:57:43Z",
  "created_by": "IBMid-1308197YB4",
  "updated_by": "IBMid-1308197YB4",
  "recovery_key_label": "TEKMF.AES.RECOVERY.00001",
  "href": "https://<instance_ID>.uko.us-south.hs-crypto.appdomain.cloud/api/v4/vaults/5295ad47-2ce9-43c3-b9e7-e5a9482c362b",
  "keys_count": 100,
  "key_templates_count": 10,
  "keystores_count": 0
}

Unified Key Orchestrator exemplos de esquema de comandos de plug-in da CLI

Os exemplos de esquemas a seguir representam os dados que você precisa especificar para algumas opções de comandos: Estes exemplos mostram a estrutura de dados e incluem valores de item temporário para os tipos de valor esperados... Ao executar um comando, substitua esses valores pelos valores que se aplicam ao seu ambiente, conforme apropriado.

KeyProperties

O seguinte exemplo mostra o formato do objeto KeyProperties.

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

Atualização de KeyProperties

O seguinte exemplo mostra o formato do objeto KeyPropertiesUpdate.

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

Solicitação de KeystoreCreation

O seguinte exemplo mostra o formato do objeto KeystoreCreationRequest.

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

Solicitação de KeystoreUpdate

O seguinte exemplo mostra o formato do objeto KeystoreUpdateRequest.

{
  "name": "IBM Cloud Keystore",
  "description": "IBM Cloud Keystore description.",
  "groups": [
    "Production"
  ],
  "ibm_api_endpoint": "https://us-south.kms.cloud.ibm.com",
  "ibm_iam_endpoint": "https://iam.bluemix.net/identity/token",
  "ibm_api_key": "***",
  "ibm_instance_id": "c9e2e2d5-013a-409f-93cf-5393972263d7",
  "ibm_key_ring": "Key-Ring-1"
}

KeystoresPropertiesCriar[]

O seguinte exemplo mostra o formato do objeto KeystoresPropertiesCreate[].


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

KeystoresPropertiesAtualizar[]

O seguinte exemplo mostra o formato do objeto KeystoresPropertiesUpdate[].

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

Tag[]

O seguinte exemplo mostra o formato do objeto Tag[].

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

Solicitação de VaultReferenceInCreation

O seguinte exemplo mostra o formato do objeto VaultReferenceInCreationRequest.

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