Commandes générales de l'interface de ligne de commande IBM Cloud (ibmcloud)

L'interface de ligne de commande IBM Cloud® fournit un ensemble de commandes qui sont regroupées par espace de nom pour que les utilisateurs puissent interagir avec IBM Cloud.

L'interface CLI IBM Cloud Prend en charge les commandes suivantes, y compris leurs noms, arguments, options, conditions préalables, descriptions et exemples.

Prérequis globaux

Les prérequis de chaque commande décrivent les actions qui doivent être réalisées avant de lancer la commande. Les prérequis peuvent inclure une ou plusieurs des actions suivantes :

Noeud final: Utilisez le " commande ibmcloud api pour définir un point de terminaison de l'API.
Se connecter: Utilisez la commande 'ibmcloud login pour vous connecter. Si vous vous connectez avec un identifiant fédéré, utilisez l'option " --sso pour vous authentifier avec un code à usage unique. Ou bien, utilisez l'option --apikey pour vous authentifier avec une clé d'API.
Cible: Utilisez la commande ibmcloud target pour définir ou afficher le compte cible ou la région.

Options globales

Les options suivantes sont disponibles pour la plupart des commandes de l'interface de ligne de commande IBM Cloud. Pour vérifier qu'une option est disponible pour une commande spécifique, utilisez l'option -h, --help avec la commande.

`--output FORMAT`

Spécifie un format de sortie. Seul JSON est pris en charge.

Exemples

Imprimer les groupes de ressources disponibles au format JSON :

ibmcloud resource groups --output json

`-q, --quiet`

Supprimer les messages prolixes. Les messages d'invite, tels Getting information from... as ... ne s'affichent pas si la mention -q, --quiet est spécifiée.

Exemples

Imprimer les groupes de ressources disponibles en mode silencieux :

ibmcloud resource groups -q

ibmcloud aide

Affiche l'aide générale pour les commandes intégrées de premier niveau et les espaces de nom pris en charge de l'interface de ligne de commande IBM Cloud, ou l'aide d'une commande intégrée ou d'un espace de nom spécifique.

ibmcloud help [COMMAND|NAMESPACE]

Prérequis

Aucun

Options de commande

COMMAND|NAMESPACE: Commande ou espace de nom pour lequel afficher l'aide. Si la commande ou l'espace de nom n'est pas spécifié, l'aide générale de l'interface de ligne de commande IBM Cloud est affichée. Facultatif.

Exemples

Afficher l'aide générale pour l'interface de ligne de commande IBM Cloud :

ibmcloud help

Afficher l'aide pour la commande dev :

ibmcloud help dev

ibmcloud assist

Posez une question à l'assistant IA qui utilise watsonx. Pour plus d'informations sur les capacités et les limites, voir Obtenir de l'aide de l'assistant IA.

ibmcloud assist "MY_QUERY"

Le contenu généré par l'assistant IA peut comporter des erreurs ou être incorrect.

Prérequis

Utilisez la commande ibmcloud login pour vous connecter. Si vous vous connectez avec un identifiant fédéré, utilisez l'option " --sso pour vous authentifier avec un code d'accès à usage unique, ou utilisez l'option " --apikey pour vous authentifier avec une clé API.

Options de commande

Aucun

Exemples

ibmcloud assist "How do I update the CLI?"

Si vous utilisez des guillemets ou des points d'exclamation dans votre requête, assurez-vous d'échapper à chaque caractère en utilisant " \. Pour plus d'informations, voir Utilisation des guillemets avec les chaînes de caractères dans IBM Cloud CLI.

ibmcloud version

Imprimer la version de l'interface de ligne de commande IBM Cloud.

ibmcloud version

Prérequis

Aucun

Options de commande

Aucun

Exemples

Imprimer la version de l'interface de ligne de commande IBM Cloud :

ibmcloud version

ibmcloud api

Définir ou afficher le noeud final d'API IBM Cloud.

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

Prérequis

Aucun

Options de commande

API_ENDPOINT: Noeud final d'API ciblé. Par exemple, https://cloud.ibm.com. Si aucune des options API_ENDPOINT et --unset n'est spécifiée, le noeud final d'API en cours est affiché. Facultatif.
--skip-ssl-validation: Ignorer la validation SSL des demandes HTTP. Cette option n'est pas recommandée.
--vpc: Utilisez une connexion VPC pour un nœud final d'API privé. Pour plus d'informations sur la configuration de l'utilisation d'une connexion VPC pour un noeud final d'API privé, voir Configuration d'une passerelle de noeud final privé(requise pour l'utilisation de VPC).
--unset: Supprimer le paramètre de noeud final d'API.

Exemples

Définir le point de terminaison de l'API à " cloud.ibm.com:

ibmcloud api cloud.ibm.com

Définissez le noeud final de l'API sur cloud.ibm.com et ignorer la validation SSL.

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

Afficher le noeud final d'API en cours :

ibmcloud api

Retirer le noeud final d'API :

ibmcloud api --unset

ibmcloud config

Ecrit les valeurs par défaut dans le fichier de configuration.

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

Prérequis

Aucun

Options de commande

--check-version: Active ou désactive la vérification de la version de l'interface de ligne de commande. Les valeurs valides sont true ou false.
--color: Active ou désactive la sortie en couleurs. Cette option est désactivée par défaut. Les valeurs valides sont true ou false.
--http-timeout: Délai d'attente, en secondes, pour les demandes HTTP. La valeur par défaut est 60 secondes.
--locale: Définit un environnement local par défaut. Si aucune valeur n'est spécifiée, l'environnement local précédent est supprimé.
--sso-otp: Définir le style de récupération du code de passe à usage unique (OTP) pour l'authentification unique (SSO). La valeur par défaut est " manual et nécessite une interaction avec l'utilisateur. Le paramètre " auto lancera automatiquement le navigateur par défaut et acceptera le jeton.
--trace: Consigne la trace des demandes HTTP sur le terminal ou dans le fichier spécifié. Les valeurs valides sont true ou false.

Vous ne pouvez spécifier qu'une seule des options à la fois.

Exemples

Fixer le délai d'attente des requêtes HTTP à 30 secondes :

ibmcloud config --http-timeout 30

Activer la sortie de trace pour les demandes HTTP :

ibmcloud config --trace true

Consigne la trace des demandes HTTP dans le fichier /home/usera/my_trace :

ibmcloud config --trace /home/usera/my_trace

Désactiver la sortie couleur :

ibmcloud config --color false

Définir l'environnement local sur zh_Hans :

ibmcloud config --locale zh_Hans

Effacer les paramètres d'environnement local :

ibmcloud config --locale CLEAR

Activer l'acceptation automatique du code de passe à usage unique SSO :

ibmcloud config --sso-otp auto

ibmcloud login

Connectez-vous à l'interface de ligne de commande d'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: Noeud final de l'API. Par exemple, cloud.ibm.com. Vous pouvez également utiliser " private.cloud.ibm.com pour vous connecter en utilisant un point d'accès privé. L'utilisation de cet indicateur permet de sauvegarder le noeud final d'API dans le fichier de configuration.
--sso: Spécifiez cette option pour vous connecter avec un ID fédéré. Lorsque vous utilisez cette option, vous êtes invité à vous authentifier auprès de votre fournisseur de connexion unique et à entrer un code d'accès unique pour vous connecter.
-U nom_utilisateur: Nom de l'utilisateur. Facultatif.
-p mot_de_passe: Mot de passe de l'utilisateur. Facultatif.
--apikey API_KEY or @API_KEY_FILE_PATH: Contenu de clé d'API ou chemin d'un fichier de clés d'API indiqué par le symbole @.
--cr-token TOKEN ou @CR_TOKEN_FILE_PATH: Le contenu du jeton de ressource de traitement ou le chemin d'un fichier de jeton de ressource de traitement indiqué par le symbole @. Si cette option est fournie, l'indicateur --profile ou la variable d'environnement IBMCLOUD_CR_PROFILE doivent également être fournis ou définis.
--vpc-cri: Se connecter en tant qu'identité de ressource de calcul VSI VPC. Pour plus d'informations, voir Connexion en tant qu'identité de ressource de calcul d'instance de serveur virtuel.
--profile PROFILE_ID, PROFILE_NAME, ou PROFILE_CRN: Le nom, l'ID ou le CRN du profil IAM de confiance lié est utilisé lorsque vous obtenez le jeton d'accès IAM. S'il est fourni, l'indicateur --cr-token, la variable d'environnement IBMCLOUD_CR_TOKEN ou l'indicateur --vpc-cri doivent également être fournis ou définis. Si vous vous authentifiez en tant que ressource informatique VPC VSI, vous ne pouvez spécifier qu'un CRN ou un ID de profil de confiance.
-c ACCOUNT_ID: ID du compte cible. Cette option est exclusive de l'option " --no-account
--no-account: Connexion forcée sans le compte. Cette option n'est pas recommandée et elle exclut l'option -c.
--accept: Accepter une invitation à rejoindre le compte ciblé. Le compte fourni doit être un identifiant de compte valide.
-g RESOURCE_GROUP: Nom ou ID du groupe de ressources cible. Facultatif.
-r REGION: Nom de la région cible. Par exemple, us-south ou eu-gb.
--no-region: Connexion forcée sans cibler une région.
--skip-ssl-validation: Ignorer la validation SSL des demandes HTTP. Cette option n'est pas recommandée.
--vpc: Utilisez une connexion VPC pour un nœud final d'API privé. Pour plus d'informations sur la connexion à l'aide d'une connexion VPC pour un noeud final d'API privé, voir Connexion à l'interface de ligne de commande avec un noeud final privé. Pour plus d'informations sur la configuration d'une connexion VPC pour utiliser un noeud final d'API privé, voir Configuration d'une passerelle de noeud final privé(requise pour l'utilisation VPC).

Se connecter de manière interactive :

ibmcloud login

Se connecter à un noeud final privé :

ibmcloud login -a private.cloud.ibm.com

Deux régions sont prises en charge : us-south et " us-east.

Connectez-vous avec un nom d'utilisateur et un mot de passe, et définissez un compte cible :

ibmcloud login -u username -p password -c MyAccountID

Connectez-vous avec un ID fédéré et définissez un compte cible:

ibmcloud login --sso -c MyAccountID

Utilisez une clé d'API avec un compte associé :

ibmcloud login --apikey api-key-string

ibmcloud login --apikey @filename

Utilisez une clé d'API sans compte associé :

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

ibmcloud login --apikey @fileName -c MyAccountID

Si un compte est associé à la clé d'API, le passage à un autre compte n'est pas pris en charge.

Connectez-vous en tant qu'utilisateur spécifique avec un ID fédéré :

ibmcloud login --sso

L'interface de ligne de commande fournit ensuite un lien d'URL et vous demande de fournir un code d'accès :

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] >

Ouvrez le lien dans un navigateur pour obtenir un code d'accès. Entrez le code d'accès dans la console pour vous connecter.

En plus d'utiliser le lien URL fourni par le CLI, vous pouvez lancer la console IBM Cloud et vous connecter. Dans la console 'IBM Cloud, vers l'icône 'Avatar '![icône Avatar](../../../icons/i-avatar-icon.svg " "Avatar") > 'Connexion à la CLI et à l'API. Copiez la commande de code d'accès à l'interface de ligne de commande IBM Cloud et entrez-la. Utilisez cette méthode pour vous connecter à votre IBMid avec votre Google ou si vous avez connecté votre compte cloud avec une instance IBM Cloud App ID.

Connectez-vous en tant que ressource de calcul 'IBM 'Kubernetes Service liée à un profil de confiance :

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

Pour plus d'informations sur la connexion en tant que IBM Kubernetes Service ressource de calcul, voir Logging in with a Compute Resource token.

Connectez-vous en tant que ressource informatique VSI VPC en utilisant le profil de confiance par défaut lié lors du provisionnement de l'instance :

ibmcloud login --vpc-cri

Connectez-vous en tant que ressource de calcul d'instance de serveur virtuel VPC associée au profil sécurisé spécifié :

ibmcloud login --vpc-cri --profile trusted_profile_id_or_crn

IBMCLOUD_CR_PROFILE=trusted_profile_id_or_crn ibmcloud login --vpc-cri

Pour plus d'informations sur la connexion en tant que ressource de calcul d'instance de serveur virtuel VPC, voir Connexion en tant qu'identité de ressource de calcul d'instance de serveur virtuel.

Accepter une invitation à rejoindre un nouveau compte :

ibmcloud login -c TargetedAccountID --accept

ibmcloud déconnexion

Se déconnecter de l'interface de ligne de commande :

ibmcloud logout

Prérequis

Aucun

ibmcloud régions

Afficher les informations pour toutes les régions dans IBM Cloud :

ibmcloud regions

Prérequis

Utilisez la commande ibmcloud api pour définir un noeud final d'API.

ibmcloud cible

Définir ou afficher le compte ou la région cible :

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

Prérequis

Utilisez la commande ibmcloud api pour définir un noeud final d'API.
Utilisez la commande ibmcloud login pour vous connecter. Si vous vous connectez avec un identifiant fédéré, utilisez l'option " --sso pour vous authentifier avec un code d'accès à usage unique, ou utilisez l'option " --apikey pour vous authentifier avec une clé API.

Options de commande

-c ACCOUNT_ID: ID du compte cible. Facultatif.
-r REGION: Nom de la région cible, par exemple, us-south ou eu-gb. Facultatif.
-g RESOURCE_GROUP: Nom du groupe de ressources cible. Facultatif.
--unset-region: Effacer la région ciblée.
--unset-resource-group: Effacer le groupe de ressources ciblé.

Si aucune option n'est spécifiée, le compte courant et la région sont affichés.

Exemples

Définissez le compte en cours:

ibmcloud target -c MyAccountID

Basculer vers une nouvelle région :

ibmcloud target -r eu-gb

Afficher le compte en cours et la région:

ibmcloud target

ibmcloud mise à jour

Mettre à jour l'interface de ligne de commande vers la version la plus récente :

ibmcloud update [-f]

Prérequis

Aucun

Options de commande

-f: Forcer une mise à jour sans confirmation. Privilège de superutilisateur (root) requis.

Commandes générales du service d'infrastructure classique

Utilisez les commandes de l'infrastructure classique dans l'interface de ligne de commande (CLI) IBM Cloud pour configurer et gérer les services de l'infrastructure.

Exécutez la commande ibmcloud sl pour consulter la liste des commandes 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

Pour afficher les informations d'aide sur une commande, exécutez la commande suivante :

ibmcloud sl [command] -h

Pour obtenir des informations détaillées sur chaque commande, consultez les rubriques de référence correspondantes dans cette documentation.

La commande ibmcloud sl init n'est plus disponible depuis la version 0.14 de l'interface de ligne de commande. Pour installer la version la plus récente de l'interface de ligne de commande, voir Installation de l'interface de ligne de commande IBM Cloud autonome.

ibmcloud sl aide

Afficher des informations d'aide pour toutes les commandes exécutées dans un environnement d'infrastructure classique :

ibmcloud sl help