Comandos generales de la CLI de IBM Cloud (ibmcloud)

La interfaz de línea de comandos de IBM Cloud® proporciona un conjunto de comandos que se agrupan por espacio de nombres para que los usuarios interactúen con IBM Cloud.

La CLI de IBM Cloud admite los siguientes comandos, incluidos sus nombres, argumentos, opciones, requisitos previos, descripciones y ejemplos.

Requisitos previos globales

Los requisitos previos de cada comando describen qué acciones se requieren para poder ejecutar el comando. Los requisitos previos pueden incluir una o varias de las acciones siguientes:

Punto final
Utilice el comando ibmcloud api para establecer un punto final de API.
Iniciar sesión
Utilice el comando ibmcloud login para iniciar la sesión. Si inicia sesión con un ID federado, utilice la opción --sso para autenticarse con una contraseña de un solo uso. O bien utilice la opción --apikey para autenticarse con una clave de API.
Destino
Utilice ibmcloud target comando para establecer o ver la cuenta o región de destino.

Opciones globales

Las siguientes opciones están disponibles para la mayoría de los comandos de la CLI de IBM Cloud. Para comprobar si hay una opción disponible para un comando específico, utilice la opción -h, --help con el comando.

--output FORMAT

Especifica un formato de salida. Solo se admite JSON.

Ejemplos

Imprimir los grupos de recursos disponibles en formato JSON:

ibmcloud resource groups --output json

-q, --quiet

Suprime los mensajes detallados. Los mensajes de solicitudes como Getting information from... as ... no se visualizan si se especifica -q, --quiet.

Ejemplos

Imprimir los grupos de recursos disponibles en modalidad silenciosa:

ibmcloud resource groups -q

ibmcloud help

Muestra la ayuda general para comandos incorporados de primer nivel y espacios de nombres soportados de la CLI de IBM Cloud, o la ayuda para un comando o un espacio de nombres incorporado específico.

ibmcloud help [COMMAND|NAMESPACE]

Requisitos previos

Ninguna.

Opciones de comando

COMMAND|NAMESPACE
Comando o espacio de nombres para el que se visualiza ayuda. Si no se especifica, se mostrará la ayuda general de la CLI de IBM Cloud. Opcional.

Ejemplos

Mostrar ayuda general de la CLI de IBM Cloud:

ibmcloud help

Mostrar ayuda para el comando dev:

ibmcloud help dev

ibmcloud assist

Alias: ai

Formule una pregunta al asistente de inteligencia artificial que utiliza watsonx. Para obtener más información sobre las capacidades y limitaciones, consulta Obtener ayuda del asistente de IA.

ibmcloud assist "MY_QUERY"

El contenido generado por el asistente de IA puede incluir errores o ser incorrecto.

Requisitos previos

  • Utilice el comando ibmcloud login para iniciar la sesión. Si inicia sesión con un ID federado, utilice la opción --sso para autenticarse con un código de acceso de un solo uso, o utilice la opción --apikey para autenticarse con una clave API.

Opciones de comando

Ninguna.

Ejemplos

ibmcloud assist "How do I update the CLI?"

Si utiliza comillas o signos de exclamación en su consulta, asegúrese de escapar cada carácter con \. Para obtener más información, consulte Uso de comillas con cadenas en IBM Cloud CLI.

ibmcloud version

Alias: v

Imprima la versión de la CLI de IBM Cloud.

ibmcloud version

Requisitos previos

Ninguna.

Opciones de comando

Ninguna.

Ejemplos

Imprima la versión de la CLI de IBM Cloud:

ibmcloud version

ibmcloud api

Establecer o visualizar el punto final de su API de IBM Cloud.

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

Requisitos previos

Ninguna.

Opciones de comando

API_ENDPOINT
Punto final de API de destino, por ejemplo, https://cloud.ibm.com. Si no se especifican ambas opciones API_ENDPOINT y --unset, se mostrará el punto final de API actual. Opcional.
--skip-ssl-validation
Ignorar la validación SSL de las solicitudes HTTP. No se recomienda esta opción.
--vpc
Utilice una conexión VPC para un punto final de API privado. Para obtener más información sobre cómo configurar el uso de una conexión VPC para un punto final de API privado, consulte Configuración de una puerta de enlace de punto final privado(necesario para el uso de VPC).
--unset
Elimina la configuración del punto final de la API.

Ejemplos

Establezca el punto final de la API en cloud.ibm.com:

ibmcloud api cloud.ibm.com

Establecer el punto final de la API en cloud.ibm.com y omitir la validación SSL.

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

Visualizar el punto final de la API actual:

ibmcloud api

Eliminar el punto final de la API:

ibmcloud api --unset

ibmcloud config

Escribir valores predeterminados en el archivo de configuración.

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

Requisitos previos

Ninguna.

Opciones de comando

--check-version
Habilitar o inhabilitar la comprobación de la versión de la CLI. Los valores válidos son true o false.
--color
Habilitar o inhabilitar la salida de color. Esta opción está inhabilitada de forma predeterminada. Los valores válidos son true o false.
--http-timeout
Valor de tiempo de espera para solicitudes HTTP en segundos. El valor predeterminado es de 60 segundos.
--locale
Establecer un entorno local predeterminado. Si no se especifica ningún valor, se suprime el entorno local anterior.
--sso-otp
Establezca el estilo de recuperación del código de acceso de un solo uso (OTP) del inicio de sesión único (SSO). El valor por defecto es manual y requiere la interacción del usuario. La configuración auto iniciará automáticamente el navegador predeterminado y aceptará el token.
--alpha-commands
Ordenar alfabéticamente los comandos no categorizados
--trace
Rastrear solicitudes HTTP al terminal o archivo especificado. Los valores válidos son true o false.

Solo puede especificar una de las opciones a la vez.

Ejemplos

Establezca el tiempo de espera de la solicitud HTTP en 30 segundos:

ibmcloud config --http-timeout 30

Habilitar la salida de rastreo para las solicitudes HTTP:

ibmcloud config --trace true

Rastrear solicitudes HTTP en el archivo /home/usera/my_trace:

ibmcloud config --trace /home/usera/my_trace

Inhabilitar la salida de color:

ibmcloud config --color false

Establecer el entorno local en zh_Hans:

ibmcloud config --locale zh_Hans

Borrar los valores de entorno local:

ibmcloud config --locale CLEAR

Activar la aceptación automática del código de acceso de un solo uso SSO:

ibmcloud config --sso-otp auto

Permitir ordenar alfabéticamente comandos no categorizados

ibmcloud config --alpha-commands true

ibmcloud login

Inicie sesión en la CLI de 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]

Requisitos previos

Ninguna.

Opciones de comando

-a API_ENDPOINT
El punto final de API. Por ejemplo, cloud.ibm.com. O bien, utilice private.cloud.ibm.com para iniciar sesión mediante un endpoint privado. El uso de este indicador guarda el punto final de la API en el archivo de configuración.
--sso
Especifique esta opción para iniciar una sesión con un ID federado. Si utiliza esta opción, se le solicitará que se autentique con su proveedor de inicio de sesión único y que especifique un código de acceso de un solo uso para iniciar la sesión.
-U nombreusuario
El nombre de usuario. Opcional.
-p password
Contraseña del usuario. Opcional.
--apikey API_KEY o @API_KEY_FILE_PATH
Contenido de clave de API o la vía de acceso a un archivo de clave de API indicado mediante el símbolo @.
--cr-token TOKEN o @CR_TOKEN_FILE_PATH
El contenido de la señal de recurso de cálculo o la vía de acceso de un archivo de señal de recurso de cálculo indicado mediante el símbolo @. Si se proporciona, también debe proporcionarse o establecerse la variable de entorno --profile o la variable de entorno IBMCLOUD_CR_PROFILE.
--vpc-cri
Inicie sesión como una identidad de recurso informático VPC VSI. Para obtener más información, consulte Inicio de sesión como identidad de recurso informático de instancia de servidor virtual.
--profile PROFILE_ID, PROFILE_NAME, o PROFILE_CRN
El nombre, ID o CRN del perfil IAM de confianza vinculado se utiliza cuando se obtiene el token de acceso IAM. Si se proporciona, también se debe proporcionar o establecer el distintivo --cr-token, la variable de entorno IBMCLOUD_CR_TOKEN o el distintivo --vpc-cri. Si se está autenticando como recurso informático VPC VSI, sólo se admite la especificación de un CRN o ID de perfil de confianza.
-c ACCOUNT_ID
ID de la cuenta de destino. Esta opción es exclusiva de la opción --no-account.
--no-account
Inicio de sesión forzado sin la cuenta. Esta opción no se recomienda, y es excluyente con la opción -c.
--accept
Aceptar una invitación para unirse a la cuenta de destino. La cuenta que se proporcione debe ser un ID de cuenta válido.
-g RESOURCE_GROUP
Nombre o ID del grupo de recursos de destino. Opcional.
-r REGION
El nombre de la región de destino. Por ejemplo, us-south o eu-gb.
--no-region
Inicio de sesión forzado sin definir una región como destino.
--skip-ssl-validation
Ignorar la validación SSL de las solicitudes HTTP. No se recomienda esta opción.
--vpc
Utilice una conexión VPC para un punto final de API privado. Para obtener más información sobre cómo iniciar sesión mediante una conexión VPC para un punto final de API privado, consulte Cómo iniciar sesión en la CLI con un punto final privado. Para obtener información sobre cómo configurar una conexión de VPC para usar un punto final de API privado, consulte Configuración de una puerta de enlace de punto final privado(necesario para el uso de VPC).

Ejemplos

Iniciar sesión de forma interactiva:

ibmcloud login

Iniciar sesión en un punto final privado:

ibmcloud login -a private.cloud.ibm.com

Se admiten dos regiones: us-south y us-east.

Inicie sesión en un endpoint privado con VPC:

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

Inicie sesión con un nombre de usuario y una contraseña, y establezca una cuenta de destino:

ibmcloud login -u username -p password -c MyAccountID

Inicie sesión con el ID federado y establezca una cuenta de destino:

ibmcloud login --sso -c MyAccountID

Utilizar una clave de API con una cuenta asociada:

ibmcloud login --apikey api-key-string
ibmcloud login --apikey @filename

Utilizar una clave de API sin una cuenta asociada:

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

Si la clave de API tiene asociada una cuenta, no se permite conmutar a otra cuenta.

Iniciar sesión como un usuario específico con un ID federado:

ibmcloud login --sso

A continuación, la CLI proporcionará un enlace de URL y le solicitará el código de acceso:

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 el enlace en un navegador para obtener un código de acceso. Especifique el código de acceso en la consola para iniciar la sesión.

Además de utilizar el enlace URL proporcionado por la CLI, puede iniciar la consola IBM Cloud e iniciar sesión. En la consola IBM Cloud, vaya al Avatar icono Avatar icono Iniciar sesión en CLI y API. Copie el comando IBM Cloud CLI passcode e introdúzcalo. Utilice este método para iniciar sesión en IBMid con su cuenta de Google o si ha conectado su cuenta en la nube con una instancia de IBM Cloud App ID.

Inicie sesión como un recurso informático IBM Kubernetes Service vinculado a un perfil de confianza:

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 obtener más información sobre el inicio de sesión como recurso informático de IBM Kubernetes Service, consulte Inicio de sesión con un token de recurso informático.

Inicie sesión como un recurso informático VPC VSI utilizando el perfil de confianza predeterminado vinculado durante el aprovisionamiento de instancias:

ibmcloud login --vpc-cri

Inicie sesión como un recurso de cálculo de VPC VSI enlazado al perfil de confianza especificado:

ibmcloud login --vpc-cri --profile trusted_profile_id_or_crn
IBMCLOUD_CR_PROFILE=trusted_profile_id_or_crn ibmcloud login --vpc-cri

Para obtener más información sobre cómo iniciar la sesión como un recurso de cálculo de VPC VSI, consulte Inicio de sesión como una identidad de recurso de cálculo de instancia de servidor virtual.

Aceptar una invitación para unirse a una nueva cuenta:

ibmcloud login -c TargetedAccountID --accept

ibmcloud logout

Finalizar la sesión de la CLI:

ibmcloud logout

Requisitos previos

Ninguna.

ibmcloud regions

Visualizar la información para todas las regiones en IBM Cloud:

ibmcloud regions

Requisitos previos

Utilice el comando ibmcloud api para establecer un punto final de API.

ibmcloud target

Establecer o ver la cuenta o región de destino:

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

Requisitos previos

  • Utilice el comando ibmcloud api para establecer un punto final de API.
  • Utilice el comando ibmcloud login para iniciar la sesión. Si inicia sesión con un ID federado, utilice la opción --sso para autenticarse con un código de acceso de un solo uso, o utilice la opción --apikey para autenticarse con una clave API.

Opciones de comando

-c ACCOUNT_ID
ID de la cuenta de destino. Opcional.
-r REGION
Nombre de la región de destino, por ejemplo, us-south o eu-gb. Opcional.
-g RESOURCE_GROUP
Nombre del grupo de recursos de destino. Opcional.
--unset-region
Borrar la región de destino.
--unset-resource-group
Borrar el grupo de recursos de destino.

Si no se especifica ninguna de las opciones, se muestran la cuenta y la región actuales.

Ejemplos

Configura la cuenta corriente:

ibmcloud target -c MyAccountID

Cambiar a una nueva región:

ibmcloud target -r eu-gb

Ver la cuenta corriente y la región:

ibmcloud target

ibmcloud update

Actualizar la CLI a la versión más reciente:

ibmcloud update [-f]

Requisitos previos

Ninguna.

Opciones de comando

-f
Forzar una actualización sin confirmación. Se necesita el privilegio raíz.

Comandos generales de servicio de la infraestructura clásica

Utilice los comandos de la infraestructura clásica en la CLI de IBM Cloud para configurar y gestionar los servicios de infraestructura.

Ejecute el comando ibmcloud sl para ver la lista de comandos disponibles:

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 ver información de ayuda acerca de un comando, ejecute el siguiente comando:

ibmcloud sl [command] -h

Para obtener información detallada de cada comando, consulte los temas relacionados en esta documentación.

El comando ibmcloud sl init ya no está disponible a partir de la versión 0.14 de la CLI. Para instalar la versión más reciente de la CLI, consulte Instalación de la CLI de IBM Cloud autónoma.

ibmcloud sl help

Ver la información de ayuda para todos los comandos que funcionan en el entorno de la infraestructura clásica:

ibmcloud sl help