Comandi generali della CLI IBM Cloud (ibmcloud)

L'interfaccia riga di comando (CLI, Command Line Interface) IBM Cloud® fornisce una serie di comandi raggruppati in base allo spazio dei nomi per consentire agli utenti di interagire con IBM Cloud.

La CLI di IBM Cloud supporta i seguenti comandi, con i relativi nomi, argomenti, opzioni, prerequisiti, descrizioni ed esempi.

Prerequisiti globali

I prerequisiti per ciascun comando descrivono quali azioni sono necessarie prima di eseguire il comando. I prerequisiti possono includere una o più delle seguenti azioni:

Endpoint: Utilizza il comando ibmcloud api per impostare un endpoint API.
Accedi: Utilizza il comando ibmcloud login per eseguire l'accesso. Se si accede con un ID federato, utilizzare l'opzione --sso per autenticarsi con un codice di accesso unico. Oppure utilizza l'opzione --apikey per l'autenticazione tramite una chiave API.
Destinazione: Utilizzare il comando ibmcloud target per impostare o visualizzare l'account o la regione di destinazione.

Opzioni globali

Le seguenti opzioni sono disponibili per la maggior parte dei comandi nella CLI IBM Cloud. Per controllare se un'opzione è disponibile per uno specifico comando, utilizza l'opzione -h, --help con il comando.

`--output FORMAT`

Specifica un formato di output. È supportato solo JSON.

Esempi

Stampa i gruppi di risorse disponibili nel formato JSON:

ibmcloud resource groups --output json

`-q, --quiet`

Elimina i messaggi dettagliati. I messaggi di richiesta come Getting information from... as ... non vengono visualizzati se viene specificato -q, --quiet.

Esempi

Stampa i gruppi di risorse disponibili nella modalità quiet:

ibmcloud resource groups -q

guida ibmcloud

Visualizza la guida generale per gli spazi dei nomi supportati e i comandi integrati di primo livello della CLI IBM Cloud o la guida per uno spazio dei nomi o un comando integrato specifico.

ibmcloud help [COMMAND|NAMESPACE]

Prerequisiti

Nessuno.

Opzioni comando

COMMAND|NAMESPACE: Il comando o lo spazio dei nomi per cui viene visualizzata la guida. Se non viene specificata, viene visualizzata la guida generale per la CLI IBM Cloud. Facoltativo.

Esempi

Visualizza la guida generale per la CLI IBM Cloud:

ibmcloud help

Visualizza la guida per il comando dev:

ibmcloud help dev

ibmcloud assist

Alias: ai

Fate una domanda all'assistente AI che utilizza watsonx. Per ulteriori informazioni sulle capacità e le limitazioni, consultare la sezione Ottenere aiuto dall'assistente AI.

ibmcloud assist "MY_QUERY"

I contenuti generati dall'assistente AI potrebbero contenere errori o non essere corretti.

Prerequisiti

Utilizza il comando ibmcloud login per accedere. Se si accede con un ID federato, utilizzare l'opzione --sso per autenticarsi con un codice di accesso unico, oppure utilizzare l'opzione --apikey per autenticarsi con una chiave API.

Opzioni comando

Nessuno.

Esempi

ibmcloud assist "How do I update the CLI?"

Se si utilizzano citazioni o punti esclamativi come parte della query, assicurarsi di sfuggire a ogni carattere utilizzando \. Per ulteriori informazioni, vedere Uso delle virgolette con le stringhe in IBM Cloud CLI.

ibmcloud version

Alias: v

Stampa la versione della CLI IBM Cloud.

ibmcloud version

Prerequisiti

Nessuno.

Opzioni comando

Nessuno.

Esempi

Stampa la versione della CLI IBM Cloud:

ibmcloud version

ibmcloud api

Imposta o visualizza l'endpoint API IBM Cloud.

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

Prerequisiti

Nessuno.

Opzioni comando

API_ENDPOINT: L'endpoint API di destinazione, ad esempio https://cloud.ibm.com. Se non vengono specificate le opzioni API_ENDPOINT e --unset, viene visualizzato l'endpoint API corrente. Facoltativo.
--skip-ssl-validation: Tralascia la convalida SSL delle richieste HTTP. Questa opzione non è consigliata.
--vpc: Utilizzare una connessione VPC per un endpoint API privato. Per ulteriori informazioni sulla configurazione per l'uso di una connessione VPC per un endpoint API privato, vedere Configurazione di un gateway endpoint privato(necessario per l'uso di VPC).
--unset: Rimuove l'impostazione di endpoint API.

Esempi

Impostare l'endpoint API su cloud.ibm.com:

ibmcloud api cloud.ibm.com

Imposta l'endpoint API su cloud.ibm.com e ignora la convalida SSL.

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

Visualizza l'endpoint API corrente:

ibmcloud api

Rimuove l'endpoint API.

ibmcloud api --unset

ibmcloud config

Scrive i valori predefiniti nel file di configurazione.

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

Prerequisiti

Nessuno.

Opzioni comando

--check-version: Abilita o disabilita il controllo della versione della CLI. I valori validi sono true o false.
--color: Abilita o disabilita l'output a colori. Questa opzione è disabilitata per impostazione predefinita. I valori validi sono true o false.
--http-timeout: Il valore di timeout per le richieste HTTP in secondi. Il valore predefinito è 60 secondi.
--locale: Imposta una locale predefinita. Se non viene specificato alcun valore, la locale precedente viene eliminata.
--sso-otp: Impostare lo stile di recupero del codice OTP (One Time Passcode) per il Single Sign-On (SSO). Il valore predefinito è manual e richiede l'interazione dell'utente. L'impostazione auto avvia automaticamente il browser predefinito e accetta il token.
--alpha-commands: Ordinare i comandi non classificati in ordine alfabetico
--trace: Traccia le richieste HTTP nel terminale o file specificato. I valori validi sono true o false.

Puoi specificare solo una delle opzioni alla volta.

Esempi

Impostare il timeout della richiesta HTTP a 30 secondi:

ibmcloud config --http-timeout 30

Abilita l'output di traccia per le richieste HTTP:

ibmcloud config --trace true

Traccia le richieste HTTP nel file /home/usera/my_trace:

ibmcloud config --trace /home/usera/my_trace

Disabilita l'output a colori:

ibmcloud config --color false

Imposta la locale su zh_Hans:

ibmcloud config --locale zh_Hans

Cancella le impostazioni della locale:

ibmcloud config --locale CLEAR

Abilitare l'accettazione automatica del codice di accesso unico SSO:

ibmcloud config --sso-otp auto

Abilitare l'ordinamento alfabetico dei comandi non classificati

ibmcloud config --alpha-commands true

ibmcloud login

Accedi alla CLI 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: Il punto finale dell'API. Ad esempio, cloud.ibm.com. Oppure, utilizzare private.cloud.ibm.com per accedere utilizzando un endpoint privato. L'uso di questo flag salva l'endpoint dell'API nel file di configurazione.
--sso: Specifica questa opzione per accedere con un ID federato. L'utilizzo di questa opzione ti richiede di eseguire l'autenticazione con il provider Single Sign-On e di immettere un passcode monouso per effettuare l'accesso.
-u NOME UTENTE: Il nome utente. Facoltativo.
-p password: La password dell'utente. Facoltativo.
--apikey API_KEY o @API_KEY_FILE_PATH: Il contenuto della chiave API o il percorso di un file della chiave API indicato dal simbolo @.
--cr-token TOKEN o @CR_TOKEN_FILE_PATH: Il contenuto del token di risorsa di calcolo o il percorso di un file di token di risorsa di calcolo indicato dal simbolo @. Se fornito, deve essere fornito o impostato anche il flag --profile o la variabile d'ambiente IBMCLOUD_CR_PROFILE.
--vpc-cri: Accedere come identità di risorsa di calcolo VPC VSI. Per ulteriori informazioni, vedere Accesso come Virtual Server Instance Compute Resource Identity.
--profile ID PROFILO, NOME PROFILO o PROFILO_CRN: Il nome, l'ID o il CRN del profilo IAM attendibile collegato viene utilizzato quando si ottiene il token di accesso IAM. Se fornito, deve essere fornito o impostato anche il flag --cr-token, la variabile d'ambiente IBMCLOUD_CR_TOKEN o il flag --vpc-cri. Se ci si sta autenticando come risorsa di calcolo VPC VSI, è supportata l'indicazione di un CRN o di un ID del profilo attendibile.
-c ID_ACCOUNT: L'ID dell'account di destinazione. Questa opzione è esclusiva dell'opzione --no-account.
--no-account: Accesso forzato senza l'account. Questa opzione non è consigliata ed è esclusiva con l'opzione -c.
--accept: Accetta un invito per unirsi all'account specificato. L'account fornito deve essere un ID account valido.
-g RESOURCE_GROUP: Il nome o l'ID del gruppo di risorse di destinazione. Facoltativo.
-r REGIONE: Il nome della regione di destinazione. Ad esempio, us-south o eu-gb.
--no-region: Accesso forzato senza selezionare una regione.
--skip-ssl-validation: Tralascia la convalida SSL delle richieste HTTP. Questa opzione non è consigliata.
--vpc: Utilizzare una connessione VPC per un endpoint API privato. Per ulteriori informazioni sull'accesso utilizzando una connessione VPC per un endpoint API privato, vedere Accesso alla CLI con un endpoint privato. Per informazioni sulla configurazione di una connessione VPC per l'uso di un endpoint API privato, vedere Configurazione di un gateway endpoint privato(necessario per l'uso di VPC).

Accedi in modo interattivo:

ibmcloud login

Accedere a un endpoint privato:

ibmcloud login -a private.cloud.ibm.com

Sono supportate due regioni: us-south e us-east.

Accedere a un endpoint privato con VPC:

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

Accedere con un nome utente e una password e impostare un account di destinazione:

ibmcloud login -u username -p password -c MyAccountID

Accedere con l'ID federato e impostare un account di destinazione:

ibmcloud login --sso -c MyAccountID

Utilizza una chiave API con un account associato.

ibmcloud login --apikey api-key-string

ibmcloud login --apikey @filename

Utilizza una chiave API senza un account associato.

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

ibmcloud login --apikey @fileName -c MyAccountID

Se la chiave API ha un account associato, il passaggio a un altro account non è supportato.

Accedi come utente specifico con un ID federato:

ibmcloud login --sso

Successivamente, la CLI fornisce un link URL e ti richiede il passcode:

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

Apri il link in un browser per ottenere un passcode. Immetti il passcode nella console per eseguire l'accesso.

Oltre a utilizzare il link URL fornito dalla CLI, è possibile avviare la console IBM Cloud ed effettuare il login. Nella console IBM Cloud, selezionare l'icona Avatar icona Accedi a CLI e API. Copiare il comando IBM Cloud CLI passcode e inserirlo. Usare questo metodo per accedere al sito IBMid con il proprio account Google o se si è collegato l'account cloud con un'istanza IBM Cloud App ID.

Accedere come risorsa di calcolo IBM Kubernetes Service collegata a un profilo affidabile:

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

Per ulteriori informazioni sull'accesso come risorsa di calcolo di IBM Kubernetes Service, vedere Accesso con un token di risorsa di calcolo.

Accedere come risorsa di calcolo VPC VSI utilizzando il profilo fiduciario predefinito collegato durante il provisioning dell'istanza:

ibmcloud login --vpc-cri

Accedere come risorsa di calcolo VPC VSI collegata al profilo di fiducia specificato:

ibmcloud login --vpc-cri --profile trusted_profile_id_or_crn

IBMCLOUD_CR_PROFILE=trusted_profile_id_or_crn ibmcloud login --vpc-cri

Per ulteriori informazioni sull'accesso come risorsa di calcolo VPC VSI, vedere Accesso come identità di risorsa di calcolo Virtual Server Instance.

Accettare l'invito a unirsi a un nuovo account:

ibmcloud login -c TargetedAccountID --accept

ibmcloud logout

Scollega dalla CLI:

ibmcloud logout

Prerequisiti

Nessuno.

ibmcloud regions

Visualizza le informazioni per tutte le regioni su IBM Cloud:

ibmcloud regions

Prerequisiti

Utilizza il comando ibmcloud api per impostare un endpoint API.

ibmcloud target

Impostare o visualizzare l'account o la regione di destinazione:

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

Prerequisiti

Utilizza il comando ibmcloud api per impostare un endpoint API.
Utilizza il comando ibmcloud login per accedere. Se si accede con un ID federato, utilizzare l'opzione --sso per autenticarsi con un codice di accesso unico, oppure utilizzare l'opzione --apikey per autenticarsi con una chiave API.

Opzioni comando

-c ID_ACCOUNT: L'ID dell'account di destinazione. Facoltativo.
-r REGIONE: Il nome della regione di destinazione, ad esempio, us-south o eu-gb. Facoltativo.
-g RESOURCE_GROUP: Il nome del gruppo di risorse di destinazione. Facoltativo.
--unset-region: Cancella la regione selezionata.
--unset-resource-group: Cancella il gruppo di risorse selezionato.

Se non viene specificata alcuna opzione, vengono visualizzati il conto corrente e la regione.

Esempi

Impostare il conto corrente:

ibmcloud target -c MyAccountID

Passa a una nuova regione:

ibmcloud target -r eu-gb

Visualizzare il conto corrente e la regione:

ibmcloud target

ibmcloud update

Aggiorna la CLI alla versione più recente:

ibmcloud update [-f]

Prerequisiti

Nessuno.

Opzioni comando

-f: Forza un aggiornamento senza conferma. Sono obbligatori i privilegi root.

Comandi del servizio dell'infrastruttura classica generali

Utilizza i comandi dell'infrastruttura classica nella CLI IBM Cloud per configurare e gestire i servizi dell'infrastruttura.

Esegui il comando ibmcloud sl per visualizzare l'elenco di comandi disponibili:

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

Per visualizzare le informazioni della guida su un comando, immetti il seguente comando:

ibmcloud sl [command] -h

Per informazioni dettagliate su ciascun comando, consulta gli argomenti di riferimento correlati in questa documentazione.

Il comando ibmcloud sl init non è più disponibile a partire dalla versione della CLI 0.14. Per installare la versione della CLI più recente, vedi Installazione della CLI IBM Cloud autonoma.

ibmcloud sl help

Visualizza le informazioni di guida per tutti i comandi per gestire l'ambiente dell'infrastruttura classica:

ibmcloud sl help