CLI do IBM Storage Ceph as a Service
O plug-in IBM Storage Ceph as a Service amplia a interface de linha de comando (CLI) do IBM Cloud para permitir a execução de comandos que executam várias operações para o serviço, incluindo, entre outros, o gerenciamento de volumes, hosts, mapeamentos, credenciais de objeto e certificados.
Pré-requisitos
Antes de poder usar o plug-in IBM Storage Ceph as a Service CLI, você deve primeiro instalar a CLI IBM Cloud, fazer login na CLI e, em seguida, instalar o plug-in software-defined-storage CLI. Para obter instruções sobre como instalar
a CLI do IBM Cloud, consulte “Introdução à CLI do IBM Cloud ”.
O plug-in é compatível com as plataformas linux64, Windows® e macOS® que rodam em processadores de 64 bits.
Instale o plug-in usando o comando plugin install :
ibmcloud plugin install software-defined-storage
Depois que o plug-in estiver instalado, você poderá verificar a instalação executando o plug-in de armazenamento definido por software, que exibirá a ajuda:
ibmcloud software-defined-storage --help
A saída exibe as instruções de USAGE e os comandos compatíveis.
Atualização do plug-in
Atualize o plug-in usando o comando plugin update .
ibmcloud plugin update software-defined-storage
A versão mais recente do plug-in é baixada e substitui os comandos atuais do serviço de plug-in. Se não houver novas atualizações disponíveis, a mensagem No updates are available será exibida.
Você é notificado na linha de comando quando há atualizações disponíveis para a CLI do IBM Cloud e para os plug-ins. 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.
Índice de comando
Cada operação traz uma explicação sobre o que ela faz, como usá-la e quaisquer parâmetros opcionais ou obrigatórios. A menos que especificados como opcionais, quaisquer parâmetros listados são necessários.
O plug-in da CLI ainda não é compatível com o conjunto completo de recursos disponíveis no armazenamento definido por software.
armazenamento definido por software
software-defined-storage- uma definição OpenAPI para a CLI IBM Storage Ceph as a Service na plataforma IBM Cloud.
ibmcloud software-defined-storage [command] [options]
Outros nomes de software-defined-storage: sds
Armazenamento de bloco
ibmcloud sds volume-create
Use este comando para criar um novo volume com a capacidade especificada.
ibmcloud sds volume-create --capacity CAPACITY [--name NAME] [--source-snapshot (SOURCE-SNAPSHOT | @SOURCE-SNAPSHOT-FILE) | --source-snapshot-id SOURCE-SNAPSHOT-ID]
Outros nomes de volume-create: volc
Exemplo: Criação de um novo volume
ibmcloud sds volume-create \
--capacity 10 \
--name my-volume \
--url $sds_endpoint
Exemplo: Restaurando um volume a partir de um snapshot
ibmcloud sds volume-create \
--name test-volume-restored \
--source-snapshot-id r134-eda57df4-41f2-48d8-812d-3d81955b6a1a \
--capacity 10 \
--url $sds_endpoint
Ao restaurar um volume a partir de um snapshot, a capacidade deve ser igual ou superior à capacidade do volume original.
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
Capacidade do volume (em gigabytes).
- Sinalização:
--capacity CAPACITY
- Sinalização:
-
Nome do volume.
- Sinalização:
--name NAME
Se você não especificar um nome para o novo volume, o sistema gerará um nome que é uma lista hifenizada de palavras selecionadas aleatoriamente.
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
-
O snapshot de origem a partir do qual esse volume foi criado.
- Sinalização:
--source-snapshot
Use essa opção se estiver criando o volume a partir de um instantâneo.
- Sinalização:
-
Identificador de instantâneo exclusivo do recurso.
- Sinalização:
--source-snapshot-id
Use essa opção se estiver criando o volume a partir de um instantâneo.
- Sinalização:
ibmcloud sds volume
Use este comando para obter detalhes sobre um único volume.
ibmcloud sds volume --volume-id VOLUME-ID --url string
Outros nomes de volume: vol
Exemplo de comando:
ibmcloud sds volume \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
O identificador de volume.
- Sinalização:
--volume-id VOLUME-ID
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds volume-update
Use este comando juntamente com as novas informações fornecidas no parâmetro “patch” do volume para atualizar a capacidade ou o nome do volume.
Você pode alterar apenas um valor de parâmetro por vez no comando. Não há suporte para mais de uma alteração no mesmo comando.
ibmcloud sds volume-update --volume-id VOLUME-ID [--volume-patch VOLUME-PATCH | @VOLUME-PATCH-FILE] --url string
Outros nomes de volume-update: volu
Exemplo de comando:
ibmcloud sds volume-update \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--capacity 38 \
--name my-volume-updated \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
O identificador de volume.
- :
--volume-id VOLUME-ID
- :
-
Capacidade do volume (em gigabytes).
- Sinalização:
--capacity CAPACITY
- Sinalização:
-
Nome do volume.
- Sinalização:
--name NAME
- Sinalização:
-
Objeto JSON [opcional] que contém as informações do volume, como um caminho para um arquivo JSON.
- Sinalização:
--volume-patch VOLUME-PATCH
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds volume-delete
Use este comando para excluir um único volume.
ibmcloud sds volume-delete --volume-id VOLUME-ID --url string
Outros nomes de volume-delete: vold
Exemplo de comando:
ibmcloud sds volume-delete \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
O identificador de volume.
- :
--volume-id VOLUME-ID
- :
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds volumes
Use este comando para listar todos os volumes.
ibmcloud sds volumes --help [--limit LIMIT] [--name NAME] --url string
Outros nomes de volumes: vols
Exemplo de comando:
ibmcloud sds volumes --help \
--limit 10 \
--name my-volume \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
O número de recursos a serem exibidos em uma página. O valor padrão é 1. O valor-limite máximo é 1000.
- Sinalização:
--limit int
- Sinalização:
-
Filtrar por nome na coleção de recursos. Você pode especificar de 0 a 200 caracteres no comprimento da cadeia.
- Sinalização:
--name string
- Sinalização:
Hosts
ibmcloud sds host-create
Use este comando para criar um novo host.
ibmcloud sds host-create --name NAME --nqn NQN [--volume-mappings VOLUME-MAPPINGS | @VOLUME-MAPPINGS-FILE] --url string --psk string
Outros nomes de host-create: hstc
Exemplo de comando:
ibmcloud sds host-create \
--name my-host \
--nqn nqn.2014-06.org:9345 \
--volume-mappings '[{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}]' \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
NVMe Qualified Name (NQN) do host configurado no ambiente do cliente. O comprimento máximo suportado é de 223 bytes.
- Sinalização:
--nqn NQN
- Sinalização:
-
Nome do novo host. Certifique-se de que o novo nome seja exclusivo.
- Sinalização:
--name NAME
Se você não especificar um nome para o novo host, o sistema gerará um nome que é uma lista hifenizada de palavras selecionadas aleatoriamente.
- Sinalização:
-
PSK para o novo host. As suítes de criptografia com chave pré-compartilhada do Transport Layer Security ( TLS-PSK) são um conjunto de protocolos criptográficos que proporcionam comunicação segura com base em chaves pré-compartilhadas (PSKs).
- Sinalização:
--psk string
- Sinalização:
-
O identificador exclusivo do volume a ser mapeado para esse host. Deve estar no formato
[{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}].- Sinalização:
--volume-mappings VOLUME-MAPPINGS
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds host
Use este comando para obter detalhes sobre um único host.
ibmcloud sds host --host-id HOST-ID --url string
Exemplo de comando:
ibmcloud sds host \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
ID do host cujos detalhes você deseja visualizar
- Sinalização:
--host-id HOST-ID
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds hosts
Use este comando para listar todos os hosts.
ibmcloud sds hosts [--limit LIMIT] --url string
Outros nomes de hosts: hsts
Exemplo de comando:
ibmcloud sds hosts \
--limit 10 \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
Número de recursos a serem exibidos em uma página.
- Sinalização:
--limit LIMIT
- Sinalização:
-
A inclusão dessa opção filtra a coleção de recursos por nome.
- Sinalização:
--name NAME
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds host-update
Use este comando para atualizar um host.
ibmcloud sds host-update --host-id HOST-ID [--host-patch HOST-PATCH | @HOST-PATCH-FILE] --url string
Outros nomes de host-update: hstu
Exemplo de comando:
ibmcloud sds host-update \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--name my-host
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
ID do host cujos detalhes você deseja atualizar
- Sinalização:
--host-id HOST-ID
- Sinalização:
-
[Opcional] Especifique o conteúdo do JSON Merge-Patch para
host_update.- Sinalização:
--host-patch HOST-PATCH
- Sinalização:
-
Nome do novo host. Certifique-se de que o novo nome seja exclusivo.
- Sinalização:
--name NAME
Se você não especificar um nome para o novo host, o sistema gerará um nome que é uma lista hifenizada de palavras selecionadas aleatoriamente.
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds host-mapping-create
Use este comando para mapear um volume a um host.
ibmcloud sds host-mapping-create --host-id HOST-ID [--volume (VOLUME | @VOLUME-FILE) | --volume-id VOLUME-ID]
Outros nomes de host-mapping-create: hstmc
Exemplo de comando:
ibmcloud sds host-mapping-create \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--volume '{"id": "r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39"}' \
--url $sds_endpoint
Ou
ibmcloud sds host-mapping-create \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
Especifique o ID do host cujos detalhes você deseja visualizar
- Sinalização:
--host-id HOST-ID
- Sinalização:
-
Especifique o identificador de volume exclusivo.
- Sinalização:
--volume-id VOLUME-ID
- Sinalização:
-
O identificador exclusivo do volume a ser mapeado para esse host. Deve estar no formato
[{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}].- Sinalização:
--volume VOLUME-ID
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds host-mappings
Use este comando para visualizar todos os mapeamentos de um host.
ibmcloud sds host-mappings --host-id HOST-ID
Outros nomes de host-mappings: hstms
Exemplo de comando:
ibmcloud sds host-mappings \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
ID do host cujos detalhes você deseja visualizar
- Sinalização:
--host-id HOST-ID
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds host-mapping
Use este comando para visualizar o mapeamento de um único host.
ibmcloud sds host-mapping --host-id HOST-ID --volume-mapping-id VOLUME-MAPPING-ID
Outros nomes de host-mapping: hstm
Exemplo de comando:
ibmcloud sds host-mapping \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--volume-mapping-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
ID do host cujos detalhes você deseja visualizar
- Sinalização:
--host-id HOST-ID
- Sinalização:
-
Identificador exclusivo de mapeamento de volume. Essa ID pode ser encontrada ao visualizar o volume associado ou o host no qual você deseja concluir essa operação.
- Sinalização:
--volume-mapping-id VOLUME-MAPPING_ID
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds host-delete
Use este comando para excluir um host.
ibmcloud sds host-delete --host-id HOST-ID --url string
Outros nomes de host-delete: hstd
Exemplo de comando:
ibmcloud sds host-delete \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
ID do host cujos detalhes você deseja visualizar
- Sinalização:
--host-id HOST-ID
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds host-mapping-delete
Use este comando para excluir um único mapeamento de volume de um host.
ibmcloud sds host-mapping-delete --host-id HOST-ID --volume-mapping-id VOLUME-MAPPING-ID
Outros nomes de host-mapping-delete: hstmd
Exemplo de comando:
ibmcloud sds host-mapping-delete \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--volume-mapping-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
ID do host cujos detalhes você deseja visualizar
- Sinalização:
--host-id HOST-ID
- Sinalização:
-
Identificador exclusivo de mapeamento de volume. Essa ID pode ser encontrada ao visualizar o volume associado ou o host no qual você deseja concluir essa operação.
- Sinalização:
--volume-mapping-id VOLUME-MAPPING_ID
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds host-mapping-delete-all
Use este comando para excluir todos os mapeamentos de volume associados a um host.
ibmcloud sds host-mapping-delete-all --host-id HOST-ID
Outros nomes de host-vol-delete-all: hstmda
Exemplo de comando:
ibmcloud sds host-mapping-delete-all \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
ID do host cujos detalhes você deseja visualizar
- Sinalização:
--host-id HOST-ID
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
Armazenamento de objeto
ibmcloud sds cred-create
Use este comando para atualizar as credenciais de uma conta de armazenamento ou criá-las, caso ainda não existam.
ibmcloud sds cred-create --access-key ACCESS-KEY --url string
Outros nomes de cred-create: crc
Exemplo de comando:
ibmcloud sds cred-create \
--access-key mytestkey
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
Define a chave de acesso para a instância do serviço.
- Sinalização:
--access-key ACCESS-KEY
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds cred-delete
Use este comando para excluir uma credencial de serviço.
ibmcloud sds cred-delete --access-key ACCESS-KEY --url string
Outros nomes de cred-delete: crd
Exemplo de comando:
ibmcloud sds cred-delete \
--access-key mytestkey
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
Define a chave de acesso para a instância do serviço.
- Sinalização:
--access-key ACCESS-KEY
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds creds
Use este comando para recuperar as credenciais de uma conta de armazenamento específica.
ibmcloud sds creds --url string
Outros nomes de creds: crl
Exemplo de comando:
ibmcloud sds creds \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
- Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds cert-types
Use este comando para obter a lista dos tipos de certificados configurados no SSL.
ibmcloud sds cert-types --url string
Outros nomes de cert-types: crtt
Exemplo de comando:
ibmcloud sds cert-types \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
- Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds cert-create
Use este comando para criar um novo certificado do tipo “ SSL ” caso ainda não exista um.
ibmcloud sds cert-create --cert CERT --body BODY --url string
Outros nomes de cert-create: crtc
Exemplo de comando:
ibmcloud sds cert-create \
--cert s3 \
--body tempdir/test-file.txt \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
O corpo da solicitação que contém o certificado “ TLS ”. A CLI aceita o arquivo de certificado no formato
.pem.- Sinalização:
--body BODY
- Sinalização:
-
O tipo de certificado que deve ser usado na solicitação. Os valores aceitáveis incluem: - s3.
- Sinalização:
--cert CERT
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds cert-update
Use este comando para atualizar um certificado existente do SSL.
ibmcloud sds cert-update --cert CERT --body BODY --url string
Outros nomes de cert-update: crtu
Exemplo de comando:
ibmcloud sds cert-update \
--cert s3 \
--body tempdir/test-file.pem \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
O corpo da solicitação que contém o certificado “ TLS ”. A CLI aceita o arquivo de certificado no formato
.pem.- Sinalização:
--body BODY
- Sinalização:
-
O tipo de certificado que deve ser usado na solicitação. Os valores aceitáveis incluem: - s3.
- Sinalização:
--cert CERT
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds cert
Use este comando para obter a data de validade e o status do certificado “ SSL ”.
ibmcloud sds cert --cert CERT --url string
Exemplo de comando:
ibmcloud sds cert \
--cert s3
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
O tipo de certificado que deve ser usado na solicitação. Os valores aceitáveis incluem: - s3.
- Sinalização:
--cert CERT
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
ibmcloud sds cert-delete
Use este comando para excluir um certificado do SSL.
ibmcloud sds cert-delete --cert CERT --url string
Outros nomes de cert-delete: crtd
Exemplo de comando:
ibmcloud sds cert-delete \
--cert s3
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
O tipo de certificado que deve ser usado na solicitação. Os valores aceitáveis incluem: - s3.
- Sinalização:
--cert CERT
- Sinalização:
-
Endpoint da API no formulário URL.
- Sinalização:
--url string
- Sinalização:
Comandos de instantâneos
ibmcloud sds volume-snapshot-create
Use este comando para criar um instantâneo de um volume.
ibmcloud sds volume-snapshot-create [--source-volume (SOURCE-VOLUME | @SOURCE-VOLUME-FILE) | --source-volume-id SOURCE-VOLUME-ID] [--name NAME]
Outros nomes de volume-snapshot-create: vsnapc
Exemplo de comando:
ic sds volume-snapshot-create --source-volume-id r134-87a59338-a801-4090-a657-72867fc9ba44
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
O ID do volume de bloco onde o novo instantâneo precisa ser criado.
- Sinalização:
--source-volume-id
- Sinalização:
-
Nome exclusivo para o instantâneo. Parâmetro opcional.
- Sinalização:
--name
- Sinalização:
ibmcloud sds volume-snapshot
Use este comando para obter detalhes de um único snapshot.
ibmcloud sds volume-snapshot --snap-id SNAP-ID
Outros nomes de volume-snapshot: vsnap
Exemplo de comando:
ibmcloud sds volume-snapshot \
--snap-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
- Identificador de instantâneo para o qual você deseja recuperar os detalhes.
- Sinalização:
--snap-id
- Sinalização:
ibmcloud sds volume-snapshots
Use este comando para listar todos os snapshots.
ibmcloud sds volume-snapshots [--start START] [--limit LIMIT] [--name NAME] [--source-volume-id SOURCE-VOLUME-ID]
Outros nomes de volume-snapshots: vsnaps
Exemplo de comando:
ibmcloud sds volume-snapshots \
--start r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--limit 20 \
--name my-host \
--source-volume-id exampleString \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
Os seguintes parâmetros são opcionais:
-
Especifica a ID do recurso para iniciar a página de resultados. Útil para paginação em grandes coleções.
- Sinalização:
--start
- Sinalização:
-
Define o número máximo de recursos (instantâneos) a serem retornados por página.
- Sinalização:
--limit
- Sinalização:
-
Filtra os resultados para incluir apenas instantâneos com um nome que corresponda à cadeia de caracteres fornecida.
- Sinalização:
--name
- Sinalização:
-
Filtra os resultados para incluir apenas os instantâneos que pertencem ao ID do volume de origem especificado.
- Sinalização:
source-volume-id
- Sinalização:
-
Ao listar instantâneos de volume, essa opção fará automaticamente várias solicitações para recuperar e exibir todas as páginas de resultados, para que você veja a coleção inteira sem precisar paginar manualmente os resultados.
- Sinalização:
all-pages
- Sinalização:
ibmcloud sds volume-snapshot-update
Use este comando para atualizar um snapshot.
ibmcloud sds volume-snapshot-update --snap-id SNAP-ID [--snapshot-patch SNAPSHOT-PATCH | @SNAPSHOT-PATCH-FILE]
Outros nomes de volume-snapshot-update: vsnapu
Exemplo de comando:
ibmcloud sds volume-snapshot-update \
--snap-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--name snap-2-updated \
--url $sds_endpoint
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
(Obrigatório) O identificador exclusivo do snapshot que você deseja atualizar.
- Sinalização:
--snap-id
- Sinalização:
-
Especifica o nome do snapshot que precisa ser atualizado.
- Sinalização:
--name
- Sinalização:
-
Forneça o conteúdo do JSON Merge-Patch para atualizar o snapshot. Pode ser uma cadeia de caracteres JSON diretamente no comando ou um caminho para um arquivo JSON que contenha os dados do patch. Isso permite que você atualize campos específicos do snapshot.
- Sinalização:
--snapshot-patch
- Sinalização:
ibmcloud sds volume-snapshot-delete
Use este comando para excluir um único snapshot.
ibmcloud sds volume-snapshot-delete --snap-id SNAP-ID
Outros nomes de volume-snapshot-delete: vsnapd
Exemplo de comando:
ibmcloud sds volume-snapshot-delete \
--snap-id r134-76a4e08c-aa22-4fd3-9eb5-5cae0e78a285 \
--url $sds_endpoint
Are you sure you want to delete? [y/n]> y
...
OK
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
Para forçar a execução do comando
- Bandeira:
-f,--force
- Bandeira:
-
Identificador exclusivo do snapshot que você deseja excluir.
- Sinalização:
--snap-id
- Sinalização:
ibmcloud sds volume-snapshots-delete
Use este comando para excluir todos os instantâneos de um volume.
ibmcloud sds volume-snapshots-delete [--source-volume-id SOURCE-VOLUME-ID]
Outros nomes de volume-snapshots-delete: vsnapsd
Exemplo de comando:
ibmcloud sds volume-snapshots-delete \
--source-volume-id r134-76a4e08c-aa22-4fd3-9eb5-5cae0e78a285 \
--url $sds_endpoint
Are you sure you want to delete? [y/n]> y
...
OK
O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Você pode definir o URL uma vez e não precisar adicioná-lo a cada comando. Para obter orientação sobre como definir o URL, consulte Comandos de configuração.
Parâmetros a serem fornecidos:
-
Para forçar a execução do comando
- Bandeira:
-f,--force
- Bandeira:
-
Filtra a operação para afetar somente os recursos (como instantâneos) que têm uma propriedade
source_volume-idcorrespondente ao identificador especificado. Usado para direcionar todos os snapshots para um volume específico.- Sinalização:
--source-volume-id
- Sinalização:
Comandos do Config
Config O comando pode ser usado para controlar ou visualizar a configuração persistente das opções globais.
Para controlar ou visualizar as configurações persistentes, execute o comando ibmcloud sds config junto com as opções globais para listar, definir e cancelar a definição dos valores de configuração.
Você pode definir a variável url de modo que não precise usar o sinalizador --url ao usar o comando sds.
ibmcloud sds config
Exemplo de configuração da opção url.
pc@mac ~ % ibmcloud sds config set url http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
OK
Exemplo que mostra como usar o comando sem o conjunto de configurações.
pc@mac ~ % ibmcloud sds volumes --url $endpoint
O exemplo mostra como usar o comando com o url configurado.
pc@mac ~ % ibmcloud sds volumes
Opções do comando Config
-
get- Recupera o valor configurado atualmente definido de uma opção. -
list- Recupera todos os valores configurados atualmente definidos. -
set- Definir um valor de configuração para uma opção. -
unset- Desativar o valor de configuração de uma opção.
ibmcloud sds config get
Use este comando para recuperar o valor definido atualmente para uma opção específica.
Quando a opção Get é usada junto com a opção url, o valor atualmente definido para a opção 'url' é recuperado.
ibmcloud sds config get url
Veja o exemplo de saída.
pc@mac ~ % ibmcloud sds config get url
http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
ibmcloud sds config list
Use este comando para recuperar e visualizar todos os valores configurados atualmente.
ibmcloud sds config list
Veja o exemplo de saída.
pc@mac ~ % ibmcloud sds config list
url
http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
ibmcloud sds config set
Use este comando para definir novos valores para uma opção específica.
ibmcloud sds config set [url]
Quando a opção set é usada junto com a opção url, o valor da opção 'url' é definido.
Veja o exemplo com a opção url.
pc@mac ~ % ibmcloud sds config set url http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
ibmcloud sds config unset
Use este comando para redefinir os valores atualmente configurados para uma opção específica.
ibmcloud sds config unset [url]
Quando a opção unset é usada junto com a opção url, o valor configurado atualmente para a opção 'url' é redefinido.
Próximas etapas
Execute ibmcloud sds --help para obter mais informações sobre os comandos que você pode executar.