IBM Cloud Docs
汎用 IBM Cloud CLI (ibmcloud) コマンド

汎用 IBM Cloud CLI (ibmcloud) コマンド

IBM Cloud® コマンド・ライン・インターフェースでは、ユーザーが IBM Cloud と対話できるように、名前空間別にグループ化したコマンドのセットが提供されています。

IBM Cloudは以下のコマンドをサポートしており、その名前、引数、オプション、前提条件、説明、例を含む。

グローバル前提条件

各コマンドの前提条件には、コマンドの実行の前に必要なアクションが記述されています。 前提条件には、以下のアクションのうちの 1 つ以上が含まれます。

エンドポイント
ibmcloud api コマンド を使用して、 API エンドポイントを設定します。
ログイン
ibmcloud login コマンド を使用して、ログインします。 連携IDでログインする場合は、「--sso オプションを使用してワンタイムパスコードで認証する。 または、--apikey オプションを使用して API キーで認証します。
ターゲット
ibmcloud target コマンド を使用して、ターゲットのアカウントまたはリージョンを設定または表示します。

グローバル・オプション

以下のオプションは、IBM Cloud CLI 内のほとんどのコマンドで使用可能です。 特定のコマンドで使用可能なオプションかどうかを確認するには、コマンドで -h, --help オプションを使用します。

--output FORMAT

出力形式を指定します。 JSON のみがサポートされます。

例

使用可能なリソース・グループを JSON フォーマットで出力します。

ibmcloud resource groups --output json

-q, --quiet

冗長メッセージを抑制します。 Getting information from... as ... を指定すると、-q, --quiet のようなプロンプト・メッセージが表示されなくなります。

例

使用可能なリソース・グループを抑止モードで出力します。

ibmcloud resource groups -q

ibmcloud help

IBM Cloud CLI の第 1 レベルの組み込みコマンドおよびサポートされる名前空間に関する一般ヘルプを表示するか、または、特定の組み込みコマンドまたは名前空間に関するヘルプを表示します。

ibmcloud help [COMMAND|NAMESPACE]

前提条件

ありません。

コマンド・オプション

COMMAND|NAMESPACE
ヘルプを表示する対象のコマンドまたは名前空間。 指定されない場合、IBM Cloud CLI の一般ヘルプが表示されます。 オプション。

例

IBM Cloud CLI の一般ヘルプを表示します。

ibmcloud help

dev コマンドのヘルプを次のように表示します。

ibmcloud help dev

イブムクラウドアシスト

watsonxを使用したAIアシスタントに質問する。 機能と制限の詳細については、AIアシスタントからヘルプを得る を参照してください。

ibmcloud assist "MY_QUERY"

AIアシスタントが生成するコンテンツには、間違いが含まれていたり、間違っていたりする可能性がある。

前提条件

  • ibmcloud login コマンドを使用して、ログインします。 連携IDでログインする場合、ワンタイムパスコードで認証するには「--sso オプションを、APIキーで認証するには「--apikey オプションを使用します。

コマンド・オプション

ありません。

例

ibmcloud assist "How do I update the CLI?"

クエリの一部として引用符や感嘆符を使用する場合は、'\ を使用して各文字をエスケープしてください。 詳細は「IBM CloudCLIで文字列を引用符で囲む 参照。

ibmcloud version

IBM Cloud CLI のバージョンを出力します。

ibmcloud version

前提条件

ありません。

コマンド・オプション

ありません。

例

IBM Cloud CLI のバージョンを出力します。

ibmcloud version

ibmcloud api

IBM Cloud API エンドポイントを設定または表示します。

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

前提条件

ありません。

コマンド・オプション

API_ENDPOINT
ターゲットの API エンドポイント (例えば https://cloud.ibm.com)。 API_ENDPOINT オプションと --unset オプションのどちらも指定されない場合、現行 API エンドポイントが表示されます。 オプション。
--skip-ssl-validation
HTTP 要求の SSL 検証をバイパスします。 このオプションは推奨されません。
--vpc
プライベート API エンドポイントに VPC 接続を使用します。 プライベート API エンドポイントに VPC 接続を使用するための構成について詳しくは、 プライベート・エンドポイント・ゲートウェイの構成(VPC の使用に必要) を参照してください。
--unset
API エンドポイント設定を削除します。

例

APIエンドポイントを'cloud.ibm.com に設定する：

ibmcloud api cloud.ibm.com

API エンドポイントを cloud.ibm.com に設定し、SSL 検証をバイパスします。

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

現行 API エンドポイントを表示します。

ibmcloud api

API エンドポイントを削除します。

ibmcloud api --unset

ibmcloud config

構成ファイルにデフォルト値を書き込みます。

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

前提条件

ありません。

コマンド・オプション

--check-version
CLI バージョン・チェックを使用可能または使用不可にします。 有効な値は true または falseです。
--color
カラー出力を使用可能または使用不可にします。 このオプションはデフォルトで使用不可になっています。 有効な値は true または falseです。
--http-timeout
HTTP 要求のタイムアウト値 (秒)。 デフォルト値は 60 秒です。
--locale
デフォルト・ロケールを設定します。 値を指定しない場合は、前のロケールが削除されます。
--sso-otp
シングルサインオン（SSO）のワンタイムパスコード（OTP）取得のスタイルを設定する。 デフォルト値は'manual で、ユーザーによる操作が必要である。 auto 設定すると、デフォルトのブラウザが自動的に起動し、トークンを受け入れる。
--trace
端末または指定されたファイルへの HTTP 要求をトレースします。 有効な値は true または falseです。

一度に 1 つのオプションしか指定できません。

例

HTTPリクエストのタイムアウトを30秒に設定する：

ibmcloud config --http-timeout 30

次のように、HTTP 要求のトレース出力を使用可能にします。

ibmcloud config --trace true

/home/usera/my_trace ファイルへの HTTP 要求をトレースします。

ibmcloud config --trace /home/usera/my_trace

次のように、カラー出力を使用不可にします。

ibmcloud config --color false

次のように、ロケールを zh_Hans に設定します。

ibmcloud config --locale zh_Hans

次のように、ロケール設定をクリアします。

ibmcloud config --locale CLEAR

SSOワンタイムパスコードの自動受付を有効にする：

ibmcloud config --sso-otp auto

ibmcloud login

IBM Cloud CLI にログインします。

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
API endpoint。 例えば、cloud.ibm.com です。 あるいは、'private.cloud.ibm.com プライベート・エンドポイントを使ってログインする。 このフラグを使用すると、API エンドポイントが構成ファイルに保存されます。
--sso
このオプションは、フェデレーテッド ID でログインする場合に指定します。 このオプションを使用すると、ログインするときに、シングル・サインオン・プロバイダーで認証し、ワンタイム・パスコードを入力するよう求めるプロンプトが表示されます。
-U username
ユーザー名。 オプション。
-P password
ユーザー・パスワード。 オプション。
--apikey API_KEY または @API_KEY_FILE_PATH
API キーの内容、または @ 記号で示された API キー・ファイルのパス。
--cr-token TOKEN または @CR_TOKEN_FILE_PATH
コンピュート・リソース・トークンの内容、または @ 記号で示されたコンピュート・リソース・トークン・ファイルのパス。 指定する場合は、--profile フラグまたは IBMCLOUD_CR_PROFILE 環境変数も指定または設定する必要があります。
--vpc-cri
VPC VSIコンピュートリソースのIDでログインします。 詳しくは、 仮想サーバー・インスタンス計算リソース ID としてのログイン を参照してください。
--profile PROFILE_ID、PROFILE_NAME、または PROFILE_CRN
IAM アクセストークンを取得するときに、リンクされた信頼済み IAM プロファイルの名前、ID、または CRN が使用されます。 指定する場合は、--cr-token フラグ、IBMCLOUD_CR_TOKEN 環境変数、または --vpc-cri フラグも指定または設定する必要があります。 VPC VSIコンピュートリソースとして認証する場合は、信頼済みプロファイルのCRNまたはIDのみを指定することができます。
-c ACCOUNT_ID
ターゲット・アカウントの ID。 このオプションは「--no-account オプションと排他的である。
--no-account
アカウントなしでログインを強制します。 このオプションは非推奨です。-c オプションと同時に指定することはできません。
--accept
招待を承諾して、ターゲット・アカウントに参加します。 提供されるアカウントは、有効なアカウントIDでなければならない。
-g RESOURCE_GROUP
ターゲット・リソース・グループの名前または ID。 オプション。
-r REGION
ターゲット・リージョンの名前。 例えば、 us-south または eu-gb などです。
--no-region
リージョンをターゲットにせずにログインを強制します。
--skip-ssl-validation
HTTP 要求の SSL 検証をバイパスします。 このオプションは推奨されません。
--vpc
プライベート API エンドポイントに VPC 接続を使用します。 プライベート API エンドポイントの VPC 接続を使用したログインについて詳しくは、 プライベート・エンドポイントを使用した CLI へのログイン を参照してください。 プライベート API エンドポイントを使用するための VPC 接続の構成については、 プライベート・エンドポイント・ゲートウェイの構成(VPC の使用に必要) を参照してください。

例

対話式にログインします。

ibmcloud login

プライベート・エンドポイントにログインします:

ibmcloud login -a private.cloud.ibm.com

つのリージョンがサポートされている： us-south と 'us-east である。

ユーザー名とパスワードでログインし、ターゲットアカウントを設定する：

ibmcloud login -u username -p password -c MyAccountID

フェデレーテッド ID を使用してログインし、ターゲット・アカウントを設定します。

ibmcloud login --sso -c MyAccountID

アカウントが関連付けられている API キーを使用します。

ibmcloud login --apikey api-key-string

ibmcloud login --apikey @filename

アカウントが関連付けられていない API キーを使用します。

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

ibmcloud login --apikey @fileName -c MyAccountID

API キーにアカウントが関連付けられている場合は、別のアカウントへの切り替えはできません。

フェデレーテッド ID を使用して特定のユーザーとしてログインします。

ibmcloud login --sso

すると、CLI が URL リンクを提供し、パスコードの入力を要求します。

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

ブラウザーでこのリンクを開いて、パスコードを取得します。 コンソールにパスコードを入力して、ログインします。

CLIが提供するURLリンクを使用するだけでなく、IBM Cloudコンソールを起動してログインすることもできます。 IBM Cloudコンソールの Avatar アイコンのAvatar>CLIとAPIにログイン。 IBM Cloud CLI パスコード・コマンドをコピーして入力します。 IBMid に Google アカウントでログインするか、IBM Cloud App ID インスタンスでクラウド アカウントに接続した場合は、このメソッドを使用します。

信頼できるプロファイルにリンクされたIBM Kubernetes ServiceCompute Resourceとしてログインします：

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

IBM Kubernetes Service コンピュートリソースとしてログインする方法の詳細については、コンピュートリソーストークンでログインする を参照してください。

インスタンスのプロビジョニング中にリンクされたデフォルトの信頼済みプロファイルを使用して、VPC VSI Compute Resourceとしてログインします：

ibmcloud login --vpc-cri

指定されたトラステッド・プロファイルにリンクされた VPC VSI コンピュート・リソースとしてログインします。

ibmcloud login --vpc-cri --profile trusted_profile_id_or_crn

IBMCLOUD_CR_PROFILE=trusted_profile_id_or_crn ibmcloud login --vpc-cri

VPC VSI コンピュート・リソースとしてのログインについて詳しくは、仮想サーバー・インスタンス・コンピュート・リソース ID としてログインを参照してください。

新しいアカウントへの招待を受ける：

ibmcloud login -c TargetedAccountID --accept

ibmcloud logout

CLI からログアウトします。

ibmcloud logout

前提条件

ありません。

ibmcloud regions

IBM Cloud のすべてのリージョンの情報を表示します。

ibmcloud regions

前提条件

ibmcloud api コマンドを使用して、 API エンドポイントを設定します。

ibmcloud target

対象のアカウントまたは地域を設定または表示します：

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

前提条件

  • ibmcloud api コマンドを使用して、 API エンドポイントを設定します。
  • ibmcloud login コマンドを使用して、ログインします。 連携IDでログインする場合、ワンタイムパスコードで認証するには「--sso オプションを、APIキーで認証するには「--apikey オプションを使用します。

コマンド・オプション

-c ACCOUNT_ID
ターゲット・アカウントの ID。 オプション。
-r REGION
ターゲット・リージョンの名前。例えば、us-south や eu-gb などです。 オプション。
-g RESOURCE_GROUP
ターゲット・リソース・グループの名前。 オプション。
--unset-region
ターゲット・リージョンをクリアします。
--unset-resource-group
ターゲット・リソース・グループをクリアします。

どのオプションも指定されていない場合は、現在の口座と地域が表示される。

例

現行アカウントを設定します。

ibmcloud target -c MyAccountID

新しいリージョンに切り替えます。

ibmcloud target -r eu-gb

現在のアカウントとリージョンを表示します。

ibmcloud target

ibmcloud update

CLI を最新バージョンに更新します。

ibmcloud update [-f]

前提条件

ありません。

コマンド・オプション

-f
確認を求めずに更新を強制します。 root 権限が必要です。

汎用クラシック・インフラストラクチャーのサービス・コマンド

IBM Cloud CLI でクラシック・インフラストラクチャー・コマンドを使用して、インフラストラクチャー・サービスを構成したり管理したりします。

使用可能なコマンドのリストを表示するには、ibmcloud sl コマンドを実行します。

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

コマンドのヘルプ情報を表示するには、以下のコマンドを実行します。

ibmcloud sl [command] -h

各コマンドに関する詳細情報については、この資料の関連するレファレンス・トピックを参照してください。

ibmcloud sl init コマンドは、CLI バージョン 0.14 から使用できなくなりました。 最新の CLI バージョンをインストールするには、スタンドアロン IBM Cloud CLI のインストールを参照してください。

ibmcloud sl help

クラシック・インフラストラクチャー環境で作動するすべてのコマンドのヘルプ情報を表示します。

ibmcloud sl help