Comandos gerais da CLI do IBM Cloud (ibmcloud)

A interface da linha de comandos da IBM Cloud® fornece um conjunto de comandos que são agrupados por espaço de nomes para que os usuários interajam com a IBM Cloud.

A CLI do IBM Cloud oferece suporte aos seguintes comandos, incluindo seus nomes, argumentos, opções, pré-requisitos, descrições e exemplos.

Pré-requisitos globais

Os pré-requisitos para cada comando descrevem quais ações são necessárias antes de executar o comando. Eles podem incluir uma ou mais das ações a seguir:

Terminal: Use o comando ibmcloud api para configurar um terminal de API.
Efetuar login: Use o comando ibmcloud login para efetuar login. Se você fizer login com um ID federado, use a opção --sso para se autenticar com uma senha de uso único. Ou use a opção --apikey para autenticar com uma chave de API.
Target: Use o comando ibmcloud target para definir ou visualizar a conta ou região de destino.

Opções globais

As opções a seguir estão disponíveis para a maioria dos comandos na CLI do IBM Cloud. Para verificar se uma opção está disponível para um comando específico, use a opção -h, --help com o comando.

`--output FORMAT`

Especifica um formato de saída. Somente JSON é suportado.

Exemplos

Imprimir grupos de recursos disponíveis em formato JSON:

ibmcloud resource groups --output json

`-q, --quiet`

Suprime mensagens detalhadas. Mensagens de prompt como Getting information from... as ... não serão exibidas se -q, --quiet for especificado.

Exemplos

Imprimir grupos de recursos disponíveis no modo silencioso:

ibmcloud resource groups -q

ajuda do IBM Cloud

Exibe a ajuda geral para comandos integrados de primeiro nível e namespaces suportados da CLI do IBM Cloud ou a ajuda para um comando ou um namespace integrado específico.

ibmcloud help [COMMAND|NAMESPACE]

Pré-requisitos

Nenhum.

Opções de comando

COMMAND|NAMESPACE: O comando ou namespace para o qual a ajuda é exibida. Se não especificado, a ajuda geral para a CLI do IBM Cloud será mostrada. Opcional.

Exemplos

Exiba a ajuda geral para a CLI do IBM Cloud:

ibmcloud help

Exiba a ajuda para o comando dev:

ibmcloud help dev

ibmcloud assist

Alias: ai

Faça uma pergunta ao assistente de IA que usa o site watsonx. Para obter mais informações sobre os recursos e as limitações, consulte Obtendo ajuda do assistente de IA.

ibmcloud assist "MY_QUERY"

O conteúdo gerado pelo assistente de IA pode incluir erros ou estar incorreto.

Pré-requisitos

Use o comando ibmcloud login para efetuar login. Se estiver fazendo login com um ID federado, use a opção --sso para autenticar com um código de acesso de uso único ou use a opção --apikey para autenticar com uma chave de API.

Opções de comando

Nenhum.

Exemplos

ibmcloud assist "How do I update the CLI?"

Se estiver usando aspas ou pontos de exclamação como parte de sua consulta, certifique-se de escapar de cada caractere usando \. Para obter mais informações, consulte Uso de aspas com cadeias de caracteres em IBM Cloud CLI.

ibmcloud version

Alias: v

Imprimir a versão da CLI do IBM Cloud.

ibmcloud version

Pré-requisitos

Nenhum.

Opções de comando

Nenhum.

Exemplos

Imprimir a versão da CLI do IBM Cloud:

ibmcloud version

ibmcloud api

Configure ou visualize o terminal da API do IBM Cloud.

ibmcloud api [API_ENDPOINT] [--unset] [--skip-ssl-validation] [--vpc]

Pré-requisitos

Nenhum.

Opções de comando

API_ENDPOINT: O terminal de API que é direcionado, por exemplo, https://cloud.ibm.com. Se nem a opção API_ENDPOINT nem a opção --unset forem especificadas, o terminal de API atual será exibido. Opcional.
--skip-ssl-validation: Validação SSL de bypass de solicitações de HTTP. Essa opção não é recomendada.
--vpc: Use uma conexão VPC para um terminal de API privado. Para obter mais informações sobre como configurar o uso de uma conexão VPC para um endpoint de API privado, consulte Configuração de um gateway de endpoint privado(necessário para uso de VPC).
--unset: Remova a configuração do terminal de API.

Exemplos

Defina o ponto de extremidade da API como cloud.ibm.com:

ibmcloud api cloud.ibm.com

Configurar o terminal de API para cloud.ibm.com e efetuar bypass da validação de SSL.

ibmcloud api https://cloud.ibm.com --skip-ssl-validation

Visualize o terminal de API atual:

ibmcloud api

Remova o terminal de API:

ibmcloud api --unset

Ibmcloud config

Grava valores padrão no arquivo de configuração.

ibmcloud config --http-timeout TIMEOUT_IN_SECONDS | --trace (true|false|path/to/file) |
         --color (true|false) | --locale (LOCALE|CLEAR) | --check-version (true|false)

Pré-requisitos

Nenhum.

Opções de comando

--check-version: Ative ou desative a verificação de versão da CLI. Os valores válidos são true ou false.
--color: Ative ou desative a saída de cor. Essa opção está desativada por padrão. Os valores válidos são true ou false.
--http-timeout: O valor de tempo limite para solicitações de HTTP em segundos. O valor padrão é 60 segundos.
--locale: Configure um código padrão de idioma. Se nenhum valor for especificado, o código de idioma anterior será excluído.
--sso-otp: Defina o estilo de recuperação do código de acesso de uso único (OTP) do logon único (SSO). O valor padrão é manual e requer interação do usuário. A configuração auto iniciará o navegador padrão automaticamente e aceitará o token.
--alpha-commands: Classificar comandos não categorizados em ordem alfabética
--trace: Rastreie solicitações de HTTP para o terminal ou arquivo especificado. Os valores válidos são true ou false.

É possível especificar somente uma das opções de cada vez.

Exemplos

Defina o tempo limite da solicitação HTTP para 30 segundos:

ibmcloud config --http-timeout 30

Ative a saída de rastreio para solicitações de HTTP:

ibmcloud config --trace true

Rastreie solicitações de HTTP para o arquivo /home/usera/my_trace:

ibmcloud config --trace /home/usera/my_trace

Desative a saída de cor:

ibmcloud config --color false

Configurar o código de idioma para zh_Hans:

ibmcloud config --locale zh_Hans

Limpe as configurações do código de idioma:

ibmcloud config --locale CLEAR

Habilite a aceitação automática da senha de uso único do SSO:

ibmcloud config --sso-otp auto

Permitir a classificação de comandos não categorizados em ordem alfabética

ibmcloud config --alpha-commands true

ibmcloud login

Efetue login na CLI do IBM Cloud:

ibmcloud login [-a API_ENDPOINT] [--sso] [-u USERNAME] [-p PASSWORD] [--apikey KEY | @KEY_FILE] [--cr-token (TOKEN | @CR_TOKEN_FILE) | --vpc-cri] [--profile PROFILE_ID | PROFILE_NAME | PROFILE_CRN] [-c (ACCOUNT_ID | ACCOUNT_OWNER_USER_ID) | --no-account] [--accept] [-g (RESOURCE_GROUP_NAME | RESOURCE_GROUP_ID)] [-r REGION | --no-region] [--vpc]

-a API_ENDPOINT: O terminal de API. Por exemplo, cloud.ibm.com. Ou use private.cloud.ibm.com para fazer login usando um ponto de extremidade privado. O uso desse sinalizador salva o endpoint da API no arquivo de configuração.
--sso: Especifique essa opção para efetuar login com um ID federado. Essa opção solicita que você se autentique com seu provedor de conexão única e insira uma senha descartável para efetuar login.
-U username: O nome do usuário. Opcional.
-p password: A senha do usuário. Opcional.
--apikey API_KEY ou @API_KEY_FILE_PATH: O conteúdo da chave de API ou o caminho de um arquivo-chave de API indicado pelo símbolo @.
--cr-token TOKEN or @CR_TOKEN_FILE_PATH: O conteúdo do token de recurso de cálculo ou o caminho de um arquivo token de recurso de cálculo indicado pelo símbolo @. Se fornecido, o sinalizador --profile ou a variável de ambiente IBMCLOUD_CR_PROFILE também deve ser fornecido ou configurado.
--vpc-cri: Faça login como uma identidade de recurso de computação VPC VSI. Para obter mais informações, consulte Fazer login como uma identidade de recurso de computação de instância de servidor virtual.
--profile PROFILE_ID, PROFILE_NAME ou PROFILE_CRN: O nome, a ID ou o CRN do perfil de IAM confiável vinculado é usado quando você obtém o token de acesso ao IAM. Se fornecido, a sinalização --cr-token, a variável de ambiente IBMCLOUD_CR_TOKEN ou a sinalização --vpc-cri também deverão ser fornecidas ou configuradas. Se você estiver se autenticando como um recurso de computação VPC VSI, é possível especificar apenas um CRN ou ID de perfil confiável.
-c ACCOUNT_ID: O ID da conta de destino. Essa opção é exclusiva da opção --no-account.
--no-account: Login forçado sem a conta. Essa opção não é recomendada e é exclusiva com a opção -c.
--accept: Aceite um convite para se associar à conta de destino. A conta fornecida deve ser um ID de conta válido.
-g RESOURCE_GROUP: O nome ou o ID do grupo de recursos de destino. Opcional.
-r REGION: O nome da região de destino. Por exemplo, us-south ou eu-gb.
--no-region: Login forçado sem ter uma região como destino.
--skip-ssl-validation: Ignore a validação de SSL de solicitações de HTTP. Essa opção não é recomendada.
--vpc: Use uma conexão VPC para um terminal de API privado. Para obter mais informações sobre como fazer login usando uma conexão VPC para um ponto de extremidade de API privado, consulte Fazer login na CLI com um ponto de extremidade privado. Para obter informações sobre como configurar uma conexão VPC para usar um endpoint de API privado, consulte Configuração de um gateway de endpoint privado(necessário para uso de VPC).

Efetuar login interativamente:

ibmcloud login

Efetue login em um terminal privado:

ibmcloud login -a private.cloud.ibm.com

Há suporte para duas regiões: us-south e us-east.

Faça login em um ponto de extremidade privado com VPC:

ibmcloud login -a private.cloud.ibm.com --vpc

Faça login com um nome de usuário e senha e defina uma conta de destino:

ibmcloud login -u username -p password -c MyAccountID

Faça login com o ID federado e defina uma conta de destino:

ibmcloud login --sso -c MyAccountID

Use uma chave de API com uma conta associada:

ibmcloud login --apikey api-key-string

ibmcloud login --apikey @filename

Use uma chave de API sem nenhuma conta associada:

ibmcloud login --apikey api-key-string -c MyAccountID

ibmcloud login --apikey @fileName -c MyAccountID

Se a chave de API tiver uma conta associada, a alternância para outra conta não será suportada.

Efetue login como um usuário específico com um ID federado:

ibmcloud login --sso

Em seguida, a CLI fornece um link de URL e solicita a senha:

Get One Time Code from https://identity-1.us-south.iam.cloud.ibm.com/identity/passcode to proceed.
Open the URL in the default browser? [Y/n] >

Abra o link em um navegador para obter uma senha. Insira a senha no console para efetuar login.

Além de usar o link URL fornecido pela CLI, você pode iniciar o console IBM Cloud e fazer login. No console IBM Cloud, vá para o ícone Avatar ícone Fazer login na CLI e na API. Copie o comando IBM Cloud CLI passcode e digite-o. Use esse método para fazer login em IBMid com sua conta Google ou se você conectou sua conta de nuvem a uma instância IBM Cloud App ID.

Faça login como um IBM Kubernetes Service Compute Resource vinculado a um perfil confiável:

ibmcloud login --cr-token token-string --profile trusted_profile_name_id_or_crn

ibmcloud login --cr-token @filename --profile trusted_profile_name_id_or_crn

IBMCLOUD_CR_TOKEN=@filename ibmcloud login --profile trusted_profile_name_id_or_crn

IBMCLOUD_CR_TOKEN=@filename IBMCLOUD_CR_PROFILE=trusted_profile_name_id_or_crn ibmcloud login

Para obter mais informações sobre como fazer login como um recurso de computação IBM Kubernetes Service, consulte Fazer login com um token de recurso de computação.

Faça login como um recurso de computação VPC VSI usando o perfil confiável padrão vinculado durante o provisionamento da instância:

ibmcloud login --vpc-cri

Efetue login como um Recurso de cálculo de VSI do VPC vinculado ao perfil confiável especificado:

ibmcloud login --vpc-cri --profile trusted_profile_id_or_crn

IBMCLOUD_CR_PROFILE=trusted_profile_id_or_crn ibmcloud login --vpc-cri

Para obter mais informações sobre como efetuar login como um recurso de cálculo de VSI do VPC, consulte Efetuando login como uma identidade de recurso de cálculo de instância de servidor virtual.

Aceitar um convite para ingressar em uma nova conta:

ibmcloud login -c TargetedAccountID --accept

ibmcloud logout

Efetuar logout da CLI:

ibmcloud logout

Pré-requisitos

Nenhum.

regiões ibmcloud

Visualizar as informações para todas as regiões no IBM Cloud:

ibmcloud regions

Pré-requisitos

Use o comando ibmcloud api para configurar um terminal de API.

ibmcloud target

Definir ou visualizar a conta ou região de destino:

ibmcloud target [-r REGION_NAME | --unset-region] [-c ACCOUNT_ID] [-g RESOURCE_GROUP | --unset-resource-group]

Pré-requisitos

Use o comando ibmcloud api para configurar um terminal de API.
Use o comando ibmcloud login para efetuar login. Se estiver fazendo login com um ID federado, use a opção --sso para autenticar com um código de acesso de uso único ou use a opção --apikey para autenticar com uma chave de API.

Opções de comando

-c ACCOUNT_ID: O ID da conta de destino. Opcional.
-r REGION: O nome da região de destino, por exemplo, us-south ou eu-gb. Opcional.
-g RESOURCE_GROUP: O nome do grupo de recursos de destino. Opcional.
--unset-region: Limpe a região de destino.
--unset-resource-group: Limpe o grupo de recursos de destino.

Se nenhuma das opções for especificada, a conta e a região atuais serão exibidas.

Exemplos

Defina a conta corrente:

ibmcloud target -c MyAccountID

Alterne para uma nova região:

ibmcloud target -r eu-gb

Visualize a conta corrente e a região:

ibmcloud target

Atualizar ibmcloud

Atualizar a CLI para a versão mais recente:

ibmcloud update [-f]

Pré-requisitos

Nenhum.

Opções de comando

-f: Force uma atualização sem confirmação. Privilégio de administrador é necessário.

Comandos gerais de serviço de infraestrutura clássica

Use comandos de infraestrutura clássica na CLI do IBM Cloud para configurar e gerenciar serviços de infraestrutura.

Execute o comando ibmcloud sl para ver a lista de comandos disponíveis:

USAGE:
   ibmcloud sl command [arguments...] [options...]

COMMANDS:
   block           Classic infrastructure Block Storage
   call-api        Call arbitrary API endpoints
   file            Classic infrastructure File Storage
   dns             Classic infrastructure Domain Name System
   globalip        Classic infrastructure Global IP addresses
   hardware        Classic infrastructure hardware servers
   image           Classic infrastructure Compute images
   ipsec           Classic infrastructure IPSEC VPN
   order           Classic infrastructure Orders
   placement-group Classic infrastructure Placement Group
   security        Classic infrastructure SSH Keys and SSL Certificates
   securitygroup   Classic infrastructure network security groups
   subnet          Classic infrastructure Network subnets
   ticket          Classic infrastructure Manage Tickets
   user            Classic infrastructure Manage Users
   vlan            Classic infrastructure Network VLANs
   vs              Classic infrastructure Virtual Servers
   help            Print command usage message

Para visualizar informações da ajuda sobre um comando, execute o comando a seguir:

ibmcloud sl [command] -h

Para obter informações detalhadas sobre cada comando, consulte os tópicos de referência relacionados nesta documentação.

O comando ibmcloud sl init não está mais disponível como a versão da CLI 0.14. Para instalar a versão mais recente da CLI, consulte Instalando a CLI do IBM Cloud independente.

ibmcloud sl help

Visualizar as informações da ajuda para todos os comandos para operar o ambiente de infraestrutura clássica:

ibmcloud sl help