コマンドリファレンス¶
コマンドの形式¶
ECL CLI をインストールすることで、 ecl コマンドが利用できるようになります。
これは、以下の形式で Smart Data Platform のリソースを操作するコマンドを提供しています。
$ ecl [オプション] <サービスコマンド> [サービスコマンドオプション] [パラメーター]
用語 |
説明 |
|---|---|
|
|
Smart Data Platform で提供している API に対応するコマンドです。 例えば bare server create というサービスコマンドによって ベアメタルサーバー作成API が実行され、ベアメタルサーバーを作成することができます。 |
|
サービスコマンドに対するオプションです。 サービスコマンド実行結果の出力形式を JSON や YAML といった形式に変更するなどの操作を提供します。 |
|
サービスコマンドに対応する API のリクエストパラメーターを指定します。例えば bare server create ではベアメタルサーバーの名前やフレーバーを指定する必要があります。 |
また、以下のように、対話形式でコマンドを実行することもできます。 コマンドラインに ecl [オプション] と入力しエンターを押すことで、以降 ecl [オプション] を省略してコマンドを実行可能となります。
$ ecl [オプション]
(ecl) <サービスコマンド> [サービスコマンドオプション] [パラメーター]
オプション¶
指定できるオプションは以下の通りです。 --os-tenant-id <テナント ID> のようにオプションと引数をスペース区切りで入力してください。
オプション |
引数 |
説明 |
|---|---|---|
--version |
なし |
ECL CLI のバージョン情報を表示しコマンドの実行を終了します。 |
-v | --verbose |
なし |
コマンドの実行に関する詳細な情報を表示します。このオプションは繰り返し用いることができます。 |
-q | --quiet |
なし |
警告とエラー以外の情報を表示しないようにします。 |
--log-file |
ファイルパス |
引数 に指定したファイルにコマンドの実行に関するログを記録します。 |
-h | --help | help |
なし |
|
--debug |
なし |
コマンドの実行に関するデバッグ情報を表示します。実行している curl コマンドの内容を確認することができます。 |
--os-tenant-id |
テナント ID |
引数に指定した <テナント ID> を使用してコマンドを実行します。 |
--os-username |
API 鍵 |
引数に指定した <API 鍵> を使用してコマンドを実行します。 |
--os-password |
API 秘密鍵 |
引数に指定した <API 秘密鍵> を使用してコマンドを実行します。 |
--os-auth-url |
認証用 URL |
引数に指定した認証用 URL を使用して認証用トークンを取得します。 |
--os-user-domain-id |
default |
引数には default を指定してください。 |
--os-project-domain-id |
default |
引数には default を指定してください。 |
--os-cloud |
clouds.yaml に設定した文字列 |
詳細は こちら を御覧ください。 |
サービスコマンド¶
サービスコマンドは、以下の各リンクよりご確認ください。
注釈
$ ecl command list
と入力しエンターを押すことで、利用可能なすべてのサービスコマンドを確認することができます。
サービスコマンドオプション¶
指定できるサービスコマンドオプションは以下の通りです。 -f json のようにオプションと引数をスペース区切りで入力してください。 使用できるサービスコマンドオプションはサービスコマンドによって異なります。
オプション |
引数 |
説明 |
|---|---|---|
-h | --help |
なし |
サービスコマンドのヘルプを表示しコマンドの実行を終了します。 |
-f | --format |
csv | json | shell | table | value | yaml |
サービスコマンド実行結果の出力形式を指定します。デフォルトは table です。 |
-c | --column |
カラム名 |
デフォルトで出力されるパラメーター名を指定して出力結果を絞り込むことができます。 |
--max-width |
数値 |
出力形式が table のとき、サービスコマンド実行結果の表示幅を指定します。1 より小さい数を指定するとなにも表示しません。 |
--noindent |
なし |
出力形式が json のとき、インデントを省略してサービスコマンドの実行結果を表示します。 |
--quote |
all | minimal | none | nonnumeric |
出力形式が csv のとき、CSV のフォーマットを指定します。 |
--prefix |
文字列 |
出力形式が shell のとき、出力結果の各プロパティの頭に指定した文字列を連結して表示します。 |
--print-empty |
文字列 |
出力形式が table のとき、表示対象リソースが1つも存在しない状況において、空の table を表示します。 |