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

--output FORMAT

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

ibmcloud resource groups --output json

-q, --quiet

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

ibmcloud resource groups -q

前提条件

該当なし。

コマンド・オプション

COMMAND|NAMESPACE

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

例

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

ibmcloud help

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

ibmcloud help dev

前提条件

該当なし。

コマンド・オプション

該当なし。

例

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

ibmcloud version

前提条件

該当なし。

コマンド・オプション

API_ENDPOINT

ターゲットの API エンドポイント (例えば https://cloud.ibm.com)。 API_ENDPOINT オプションと --unset オプションのどちらも指定されない場合、現行 API エンドポイントが表示されます。 オプション。

--skip-ssl-validation

HTTP 要求の SSL 検証をバイパスします。 このオプションは推奨されません。

-- VPC

プライベート API エンドポイントに 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

前提条件

該当なし。

コマンド・オプション

--check-version

CLI バージョン・チェックを使用可能または使用不可にします。 有効な値は true または falseです。

--color

カラー出力を使用可能または使用不可にします。 このオプションはデフォルトで使用不可になっています。 有効な値は true または falseです。

--http-timeout

HTTP 要求のタイムアウト値 (秒)。 デフォルト値は 60 秒です。

--locale<

デフォルト・ロケールを設定します。 値を指定しない場合は、前のロケールが削除されます。

-- トレース

端末または指定されたファイルへの 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

前提条件

該当なし。

コマンド・オプション

-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 オプションと同時に指定することはできません。

-- 受け入れ

招待を承諾して、ターゲット・アカウントに参加します。 提供されるアカウントは、有効なアカウント ID であることが必要です。

-g RESOURCE_GROUP<

ターゲット・リソース・グループの名前または ID。 オプション。

-r REGION

ターゲット・リージョンの名前。 例えば、 us-south または eu-gb などです。

--no-region

リージョンをターゲットにせずにログインを強制します。

--skip-ssl-validation

HTTP 要求の SSL 検証をバイパスします。 このオプションは推奨されません。

-- VPC

プライベート API エンドポイントに VPC 接続を使用します。

例

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

ibmcloud login

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

ibmcloud login -a private.cloud.ibm.com

現在 2 つのリージョンがサポートされます: 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 -u UserID --ssobash

すると、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] >

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

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

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

IKS コンピュート・リソースとしてのログインについて詳しくは、コンピュート・リソース・トークンを使用したログインを参照してください。

インスタンスのプロビジョニング中にリンクされたデフォルトのトラステッド・プロファイルを使用して、VPC VSI コンピュート・リソースとしてログインします。

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 api コマンドを使用して、 API エンドポイントを設定します。

前提条件

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

コマンド・オプション

-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

前提条件

該当なし。

コマンド・オプション

-f

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