Allgemeine Befehle der IBM Cloud-CLI (ibmcloud)

Die Befehlszeilenschnittstelle (Command-Line Interface, CLI) von IBM Cloud® stellt eine nach Namensbereich geordnete Gruppe von Befehlen für Benutzerinteraktionen mit IBM Cloud bereit.

Die IBM Cloud CLI unterstützt die folgenden Befehle, einschließlich ihrer Namen, Argumente, Optionen, Voraussetzungen, Beschreibungen und Beispiele.

Globale Voraussetzungen

Die Voraussetzungen für die einzelnen Befehle umfassen eine Beschreibung der Aktionen, die vor der Ausführung des jeweiligen Befehls erforderlich sind. Zu den Voraussetzungen könnten eine oder mehrere der folgenden Aktionen gehören:

Endpunkt: Legen Sie mit dem Befehl ibmcloud api einen API-Endpunkt fest.
Anmelden: Melden Sie sich mit dem Befehl ibmcloud login an. Wenn Sie sich mit einer Verbund-ID anmelden, verwenden Sie die Option --sso, um sich mit einem einmaligen Passcode zu authentifizieren. oder verwenden Sie die Option --apikey, um sich mit einem API-Schlüssel zu authentifizieren.
Ziel: Verwenden Sie den Befehl ibmcloud target, um das Zielkonto oder die Zielregion festzulegen oder anzuzeigen.

Globale Optionen

Die folgenden Optionen sind für die meisten Befehle in der IBM Cloud-CLI verfügbar. Wenn Sie prüfen möchten, ob eine Option für einen bestimmten Befehl zur Verfügung steht, verwenden Sie die Option -h, --help in Verbindung mit dem entsprechenden Befehl.

`--output FORMAT`

Gibt ein Ausgabeformat an. Es wird nur JSON unterstützt.

Beispiele

Verfügbare Ressourcengruppen in JSON-Format ausgeben:

ibmcloud resource groups --output json

`-q, --quiet`

Unterdrückt Nachrichten mit ausführlichen Informationen. Wenn die Option Getting information from... as ... angegeben ist, werden Eingabeaufforderungen wie -q, --quiet nicht angezeigt.

Beispiele

Verfügbare Ressourcengruppen in Befehlszeilenmodus ausgeben:

ibmcloud resource groups -q

ibmcloud help

Zeigt die erweiterte Hilfe für integrierte Befehle und unterstützte Namensbereiche der obersten Ebene in der IBM Cloud-CLI oder die Hilfe für einen bestimmten integrierten Befehl oder Namensbereich an.

ibmcloud help [COMMAND|NAMESPACE]

Voraussetzungen

Keine.

Befehlsoptionen

COMMAND|NAMESPACE: Der Befehl oder Namensbereich, für den die Hilfe angezeigt wird. Wenn nichts angegeben ist, wird die erweiterte Hilfe für die IBM Cloud-CLI angezeigt. Optional.

Beispiele

Erweiterte Hilfe für die IBM Cloud-CLI anzeigen:

ibmcloud help

Hilfe für den Befehl dev anzeigen:

ibmcloud help dev

ibmcloud assist

Alias: ai

Stellen Sie eine Frage an den KI-Assistenten, der watsonx verwendet. Weitere Informationen zu den Möglichkeiten und Einschränkungen finden Sie unter Hilfe vom KI-Assistenten erhalten.

ibmcloud assist "MY_QUERY"

Inhalte, die vom KI-Assistenten erstellt werden, können Fehler enthalten oder falsch sein.

Voraussetzungen

Melden Sie sich mit dem Befehl ibmcloud login an. Wenn Sie sich mit einer Verbund-ID anmelden, verwenden Sie die Option --sso, um sich mit einem einmaligen Passcode zu authentifizieren, oder die Option --apikey, um sich mit einem API-Schlüssel zu authentifizieren.

Befehlsoptionen

Keine.

Beispiele

ibmcloud assist "How do I update the CLI?"

Wenn Sie Anführungszeichen oder Ausrufezeichen als Teil Ihrer Abfrage verwenden, stellen Sie sicher, dass Sie jedes Zeichen durch die Verwendung von \ ausschließen. Weitere Informationen finden Sie unter Verwendung von Anführungszeichen bei Zeichenketten in IBM Cloud CLI.

ibmcloud version

Alias: v

Die Version der IBM Cloud-CLI ausgeben.

ibmcloud version

Voraussetzungen

Keine.

Befehlsoptionen

Keine.

Beispiele

Version der IBM Cloud-CLI ausgeben:

ibmcloud version

ibmcloud api

IBM Cloud-API-Endpunkt festlegen oder anzeigen.

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

Voraussetzungen

Keine.

Befehlsoptionen

API_ENDPOINT: Der API-Endpunkt, der als Ziel verwendet wird, zum Beispiel https://cloud.ibm.com. Wenn weder die Option API_ENDPOINT noch die Option --unset angegeben ist, wird der aktuelle API-Endpunkt angezeigt. Optional.
--skip-ssl-validation: SSL-Überprüfung von HTTP-Anforderungen umgehen. Diese Option wird nicht empfohlen.
--vpc: Eine VPC-Verbindung für einen privaten API-Endpunkt verwenden. Weitere Informationen zur Konfiguration der Verwendung einer VPC-Verbindung für einen privaten API-Endpunkt finden Sie unter Konfigurieren eines privaten Endpunkt-Gateways(erforderlich für die Verwendung von VPC).
--unset: Entfernt die Einstellung für den API-Endpunkt.

Beispiele

Setzen Sie den API-Endpunkt auf cloud.ibm.com:

ibmcloud api cloud.ibm.com

Für API-Endpunkt den Wert 'cloud.ibm.com' festlegen und SSL-Validierung umgehen:

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

Aktuellen API-Endpunkt anzeigen:

ibmcloud api

API-Endpunkt entfernen:

ibmcloud api --unset

ibmcloud config

Schreibt Standardwerte in die Konfigurationsdatei.

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

Voraussetzungen

Keine.

Befehlsoptionen

--check-version: CLI-Versionsprüfung aktivieren oder inaktivieren. Die gültigen Werte sind true oder false.
--color: Farbausgabe aktivieren oder inaktivieren. Diese Option ist standardmäßig inaktiviert. Die gültigen Werte sind true oder false.
--http-timeout: Der Zeitlimitwert für HTTP-Anforderungen in Sekunden. Der Standardwert ist 60 Sekunden.
--locale: Eine Standardländereinstellung festlegen. Wenn kein Wert angegeben ist, wird die vorherige Ländereinstellung gelöscht.
--sso-otp: Legen Sie die Art der Abfrage des Einmalpasscodes (OTP) für die einmalige Anmeldung (SSO) fest. Der Standardwert ist manual und erfordert eine Benutzerinteraktion. Mit der Einstellung auto wird der Standardbrowser automatisch gestartet und das Token akzeptiert.
--alpha-commands: Nicht kategorisierte Befehle alphabetisch sortieren
--trace: Trace für HTTP-Anforderungen mit Ausgabe auf Terminal oder in angegebener Datei aktivieren. Die gültigen Werte sind true oder false.

Sie können jeweils nur eine der Optionen auf einmal angeben.

Beispiele

Setzen Sie die Zeitüberschreitung für die HTTP-Anfrage auf 30 Sekunden:

ibmcloud config --http-timeout 30

Traceausgabe für HTTP-Anforderungen aktivieren:

ibmcloud config --trace true

Trace für HTTP-Anforderungen mit Ausgabe in die Datei /home/usera/my_trace:

ibmcloud config --trace /home/usera/my_trace

Farbausgabe inaktivieren:

ibmcloud config --color false

Ländereinstellung auf zh_Hans setzen:

ibmcloud config --locale zh_Hans

Ländereinstellungen löschen:

ibmcloud config --locale CLEAR

Aktivieren Sie die automatische Annahme des SSO-Einmalpasscodes:

ibmcloud config --sso-otp auto

Sortierung nicht kategorisierter Befehle in alphabetischer Reihenfolge aktivieren

ibmcloud config --alpha-commands true

ibmcloud login

Bei der IBM Cloud-CLI anmelden:

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: Der API-Endpunkt. Beispiel: cloud.ibm.com. Oder verwenden Sie private.cloud.ibm.com, um sich über einen privaten Endpunkt anzumelden. Mit diesem Flag wird der API-Endpunkt in der Konfigurationsdatei gespeichert.
--sso: Geben Sie diese Option für die Anmeldung mit föderierter ID an. Bei Verwendung dieser Option werden Sie aufgefordert, sich bei einem Single-Sign-on-Provider zu authentifizieren und einen einmaligen Kenncode für die Anmeldung einzugeben.
-u BENUTZERNAME: Der Benutzername. Optional.
-p password: Das Benutzerkennwort. Optional.
--apikey API_KEY oder @API_KEY_FILE_PATH: Der Inhalt des API-Schlüssels oder der Pfad einer API-Schlüsseldatei, der durch das Symbol @ angegeben wird.
--cr-token TOKEN oder @RR-TOKENDATEIPFAD: Der Inhalt des Rechenressourcentokens oder der Pfad einer Tokendatei für Rechenressourcen, der durch das Symbol @ kenntlich gemacht wird. Bei Angabe dieses Parameters muss auch das Flag --profile oder die Umgebungsvariable IBMCLOUD_CR_PROFILE angegeben oder festgelegt sein.
--vpc-cri: Melden Sie sich als VPC VSI-Rechenressourcen-Identität an. Weitere Informationen finden Sie unter Anmelden als Virtual Server Instance Compute Resource Identity.
--profile PROFILE_ID, PROFILE_NAME oder PROFILE_CRN: Der Name, die ID oder die CRN des verknüpften vertrauenswürdigen IAM-Profils wird verwendet, wenn Sie das IAM-Zugriffstoken erhalten. Bei Angabe dieser Option muss auch das Flag --cr-token, die Umgebungsvariable IBMCLOUD_CR_TOKEN oder das Flag --vpc-cri angegeben oder festgelegt sein. Wenn Sie sich als VPC-VSI-Rechenressource authentifizieren, wird nur die Angabe einer vertrauenswürdigen Profil-CRN oder -ID unterstützt.
-c ACCOUNT_ID: Die ID des Zielkontos. Diese Option ist exklusiv für die Option --no-account.
--no-account: Erzwungene Anmeldung ohne das Konto. Diese Option wird nicht empfohlen und sie ist gegenseitig ausschließend mit der Option -c.
--accept: Einladung zum Zielkonto akzeptieren. Das angegebene Konto muss eine gültige Konto-ID sein.
-g RESOURCE_GROUP: Der Name oder die ID der Zielressourcengruppe. Optional.
-r REGION: Der Name der Zielregion. Beispiel: us-south oder eu-gb.
--no-region: Erzwungene Anmeldung, ohne eine Region als Ziel auszuwählen.
--skip-ssl-validation: SSL-Validierung der HTTP-Anforderungen umgehen. Diese Option wird nicht empfohlen.
--vpc: Eine VPC-Verbindung für einen privaten API-Endpunkt verwenden. Weitere Informationen zur Anmeldung über eine VPC-Verbindung für einen privaten API-Endpunkt finden Sie unter Anmeldung bei der CLI mit einem privaten Endpunkt. Informationen zum Konfigurieren einer VPC-Verbindung zur Verwendung eines privaten API-Endpunkts finden Sie unter Konfigurieren eines privaten Endpunkt-Gateways(für die Verwendung von VPC erforderlich).

Im Dialogbetrieb anmelden:

ibmcloud login

Anmeldung bei einem privaten Endpunkt:

ibmcloud login -a private.cloud.ibm.com

Es werden zwei Regionen unterstützt: us-south und us-east.

Melden Sie sich bei einem privaten Endpunkt mit VPC an:

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

Melden Sie sich mit einem Benutzernamen und einem Passwort an, und legen Sie ein Zielkonto fest:

ibmcloud login -u username -p password -c MyAccountID

Melden Sie sich mit der Verbund-ID an, und legen Sie ein Zielkonto fest:

ibmcloud login --sso -c MyAccountID

API-Schlüssel mit zugeordnetem Konto verwenden:

ibmcloud login --apikey api-key-string

ibmcloud login --apikey @filename

API-Schlüssel ohne zugeordnetes Konto verwenden:

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

ibmcloud login --apikey @fileName -c MyAccountID

Wenn dem API-Schlüssel ein Konto zugeordnet ist, wird der Wechsel zu einem anderen Konto nicht unterstützt.

Als bestimmter Benutzer mit föderierter ID anmelden:

ibmcloud login --sso

Anschließend stellt die CLI einen URL-Link bereit und fordert zur Eingabe des Kenncodes auf:

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

Öffnen Sie den Link in einem Browser, um einen Kenncode zu erhalten. Geben Sie den Kenncode in der Konsole ein, um sich anzumelden.

Sie können nicht nur den von der CLI bereitgestellten Link URL verwenden, sondern auch die Konsole IBM Cloud starten und sich anmelden. Wählen Sie in der Konsole IBM Cloud das Avatar symbol Log in to CLI and API. Kopieren Sie den Befehl IBM Cloud CLI passcode und geben Sie ihn ein. Verwenden Sie diese Methode, um sich bei IBMid mit Ihrem Google Konto anzumelden oder wenn Sie Ihr Cloud-Konto mit einer IBM Cloud App ID Instanz verbunden haben.

Melden Sie sich als IBM Kubernetes Service Compute Resource an, die mit einem vertrauenswürdigen Profil verknüpft ist:

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

Weitere Informationen zur Anmeldung als IBM Kubernetes Service Compute-Ressource finden Sie unter Anmeldung mit einem Compute-Ressourcen-Token.

Melden Sie sich als VPC VSI Compute Resource an, indem Sie das während der Instanzbereitstellung verknüpfte vertrauenswürdige Standardprofil verwenden:

ibmcloud login --vpc-cri

Melden Sie sich als VPC-VSI-Rechenressource an, die mit dem angegebenen vertrauenswürdigen Profil verknüpft ist:

ibmcloud login --vpc-cri --profile trusted_profile_id_or_crn

IBMCLOUD_CR_PROFILE=trusted_profile_id_or_crn ibmcloud login --vpc-cri

Weitere Informationen zur Anmeldung als VPC-VSI-Rechenressource finden Sie unter Als Rechenressourcenidentität der virtuellen Serverinstanz anmelden.

Nehmen Sie eine Einladung zum Beitritt zu einem neuen Konto an:

ibmcloud login -c TargetedAccountID --accept

ibmcloud logout

Bei der CLI abmelden:

ibmcloud logout

Voraussetzungen

Keine.

ibmcloud regions

Informationen für alle Regionen in IBM Cloud anzeigen:

ibmcloud regions

Voraussetzungen

Legen Sie mit dem Befehl ibmcloud api einen API-Endpunkt fest.

ibmcloud target

Festlegen oder Anzeigen des Zielkontos oder der Zielregion:

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

Voraussetzungen

Legen Sie mit dem Befehl ibmcloud api einen API-Endpunkt fest.
Melden Sie sich mit dem Befehl ibmcloud login an. Wenn Sie sich mit einer Verbund-ID anmelden, verwenden Sie die Option --sso, um sich mit einem einmaligen Passcode zu authentifizieren, oder die Option --apikey, um sich mit einem API-Schlüssel zu authentifizieren.

Befehlsoptionen

-c ACCOUNT_ID: Die ID des Zielkontos. Optional.
-r REGION: Der Name der Zielregion, z. B. us-south oder eu-gb. Optional.
-g RESOURCE_GROUP: Der Name der Zielressourcengruppe. Optional.
--unset-region: Die Zielregion abwählen.
--unset-resource-group: Die Zielressourcengruppe abwählen.

Wenn keine der Optionen angegeben ist, werden das aktuelle Konto und die Region angezeigt.

Beispiele

Stellen Sie das Girokonto ein:

ibmcloud target -c MyAccountID

Zu einer neuen Region wechseln:

ibmcloud target -r eu-gb

Sehen Sie sich das aktuelle Konto und die Region an:

ibmcloud target

ibmcloud update

CLI auf die neueste Version aktualisieren:

ibmcloud update [-f]

Voraussetzungen

Keine.

Befehlsoptionen

-f: Aktualisierung ohne Bestätigung erzwingen. Rootberechtigung ist erforderlich.

Allgemeine Servicebefehle der klassischen Infrastruktur

Verwenden Sie Befehle der klassischen Infrastruktur in der IBM Cloud-CLI zum Konfigurieren und Verwalten von Infrastrukturservices.

Den Befehl ibmcloud sl ausführen, um die Liste der verfügbaren Befehle anzuzeigen:

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

Führen Sie den folgenden Befehl aus, um Hilfeinformationen zu einem Befehl anzuzeigen:

ibmcloud sl [command] -h

Detaillierte Informationen zu den einzelnen Befehlen finden Sie in den Abschnitten mit den zugehörigen Referenzinformationen in der dieser Dokumentation.

Der Befehl ibmcloud sl init ist ab der CLI-Version 0.14 nicht mehr verfügbar. Informationen zum Installieren der neuesten CLI-Version finden Sie in Eigenständige IBM Cloud-Befehlszeilenschnittstelle installieren.

ibmcloud sl help

Hilfeinformationen für alle Befehle für den Betrieb der Umgebung der klassischen Infrastruktur anzeigen:

ibmcloud sl help