コンテンツにスキップ

リファレンス / グローバルオプション

usacloudコマンドラインオプションとして指定可能なグローバルオプション。

Info

プロファイルを用いることでグローバルオプションでは指定できない項目の設定が行えます。
詳細はリファレンス/プロファイルを参照してください。

Info

一部の項目は環境変数での設定に対応しています。
詳細はリファレンス/環境変数を参照してください。

グローバルオプション一覧

プロファイル(--profile)

利用するプロファイル(コンフィグ)を指定します。(エイリアス:--config)
指定可能な値はusacloud profile listコマンドで調べることが可能なほか、usacloud profile createコマンドなどで新規作成も可能です。

通常この値は~/.usacloud/currentの値が利用されます。
環境変数SAKURACLOUD_PROFILE/USACLOUD_PROFILEでの指定、またはコマンド実行時の--profileの指定でこの設定を上書き可能です。

Warning

Usacloud v0との互換性維持のためv1でも環境変数USACLOUD_PROFILEが利用可能ですが、将来のバージョンでは廃止される予定です。

APIトークン(--token)

さくらのクラウドのAPIトークンを指定します。

通常この値は~/.usacloud/[current-profile-nane]/config.jsonの値が利用されます。
環境変数SAKURACLOUD_ACCESS_TOKENでの指定、またはコマンド実行時の--tokenの指定でこれらの設定を上書き可能です。

APIシークレット(--secret)

さくらのクラウドのAPIシークレットを指定します。

通常この値は~/.usacloud/[current-profile-nane]/config.jsonの値が利用されます。
環境変数SAKURACLOUD_ACCESS_TOKEN_SECRETでの指定、またはコマンド実行時の--secretの指定でこれらの設定を上書き可能です。

操作対象ゾーン(--zones)

usacloudコマンドで操作可能なゾーンの一覧を指定します。
ここでの指定は各コマンドでの--zone指定や--zone=allを指定した際の挙動に影響します。

省略した場合は以下の値が設定されます。

libsacloud: types.ZoneNames

カラー出力の無効化(--no-color)

端末への出力時にANSIエスケープシーケンスを用いたカラー出力を無効にします。

Fakeドライバの有効化(--fake)

さくらのクラウドAPI呼び出しにFakeドライバーを利用します。
主にコマンドの書式確認などのテスト用途で利用します。

--fake-storeオプションを指定しない場合はダミーAPIのデータストアはインメモリとなります。

FakeドライバでのJSONデータストアファイルパス(--fake-store)

Fakeドライバーが利用するデータストアのファイルパスを指定します。 この値を指定するとFakeドライバーがJSONデータストアを利用するようになります。

コマンド実行タイムアウト(--process-timeout-sec)

usacloudコマンド実行全体に対するタイムアウト秒数を指定します。
未指定の場合は2時間(7200)が設定されます。

引数とリソース名の比較方法(--argument-match-mode)

操作対象を引数で指定するコマンドにおいてリソース名と引数を比較する方法を指定します。
指定可能な値は以下のとおりです。

  • partial(デフォルト): 部分一致
  • exact: 完全一致

トレース出力(--trace)

さくらのクラウドAPI呼び出しのトレースログを標準エラーへ書き込みます。

バージョン表示(--version / -v)

usacloudのバージョン情報を表示します。

ヘルプ表示(--help / -h)

ヘルプを表示します。