第12章 オーケストレーションサービスのコマンドラインクライアント

サブコマンド

action-check

スタックリソースが予想される状態であることを確認します。

action-resume

スタックを再開します。

action-suspend

スタックを一時停止します。

build-info

ビルド情報を取得します。

config-create

ソフトウェア設定を作成します。

config-delete

ソフトウェア設定を削除します。

config-show

ソフトウェア設定の詳細を表示します。

deployment-create

ソフトウェアデプロイメントを作成します。

deployment-delete

ソフトウェアデプロイメントを削除します。

deployment-list

ソフトウェアデプロイメントをリスト表示します。

deployment-metadata-show

指定されたサーバーのデプロイメント設定のメタデータを取得します。

deployment-output-show

特定のデプロイメント出力を表示します。

deployment-show

ソフトウェアデプロイメントの詳細を表示します。

event

非推奨になりました。代わりに event-show を使用してください。

event-list

スタックのイベントを一覧表示します。

event-show

イベントを記述します。

hook-clear

指定のスタックのフックを消去します。

hook-poll

スタックの保留中のフックを持つリソースをリスト表示します。

output-list

利用可能な出力を表示します。

output-show

特定のスタック出力を表示します。

resource-list

スタックに属するリソースのリストを表示します。

resource-metadata

リソースのメタデータを一覧表示します。

resource-show

リソースを記述します。

resource-signal

リソースにシグナルを送信します。

resource-template

非推奨になりました。代わりに resource-type-template を使用してください。

resource-type-list

利用可能なリソースタイプを一覧表示します。

resource-type-show

リソース種別を表示します。

resource-type-template

リソースタイプに基づいてテンプレートを生成します。

service-list

Heat エンジンをリスト表示します。

snapshot-delete

スタックのスナップショットを削除します。

snapshot-list

スタックのスナップショットを一覧表示します。

snapshot-show

スタックのスナップショットを表示します。

stack-abandon

スタックを破棄します。

stack-adopt

スタックを受け入れます。

stack-cancel-update

現在実行中のスタックの更新をキャンセルします。

stack-create

スタックを作成します。

stack-delete

スタックを削除します。

stack-list

ユーザーのスタックを一覧表示します。

stack-preview

スタックをプレビューします。

stack-restore

スタックのスナップショットを復元します。

stack-show

スタックを記述します。

stack-snapshot

スタックのスナップショットを作成します。

stack-update

スタックを更新します。

template-function-list

利用可能な関数をリスト表示します。

template-show

指定されたスタックのテンプレートを取得します。

template-validate

パラメーターでテンプレートを検証します。

template-version-list

利用可能なテンプレートバージョンをリスト表示します。

bash-completion

すべてのコマンドとオプションを stdout に出力します。

help

このプログラムまたはそのサブコマンドのヘルプを表示します。

--version

クライアントのバージョンを表示し、終了します。

-d、--debug

デフォルトは env[HEATCLIENT_DEBUG] です。

-v、--verbose

より詳細な出力を出力します。

--api-timeout API_TIMEOUT

API 応答を待つ秒数。デフォルトはシステムソケットのタイムアウトです

--os-no-client-auth

トークンの keystone と通信しないでください。デフォルトは env[OS_NO_CLIENT_AUTH] です。

--heat-url HEAT_URL

デフォルトは env[HEAT_URL] です。

--heat-api-version HEAT_API_VERSION

デフォルトは env[HEAT_API_VERSION] または 1 です。

--include-password

os-username および os-password を heat に送信します。

-k, --insecure

heatclient がセキュアでない SSL (https)要求を実行することを明示的に許可します。サーバーの証明書は認証局に対して検証されません。このオプションは注意して使用する必要があります。

--os-cert OS_CERT

SSL 接続で使用する証明書ファイルのパス。このファイルは、オプションで秘密鍵の先頭に追加できます。

--cert-file OS_CERT

非推奨になりました。--os-cert を使用します。

--os-key OS_KEY

SSL 接続で使用するクライアントキーのパス。キーが証明書ファイルに追加されている場合は、このオプションは必要ありません。

--key-file OS_KEY

非推奨になりました。--os-key を使用します。

--os-cacert <ca-certificate-file>

リモートサーバーの証明書を検証するために使用される CA TLS 証明書のパス。このオプションを指定しないと、デフォルトのシステム CA 証明書を探します。

--ca-file OS_CACERT

非推奨になりました。--os-cacert を使用します。

--os-username OS_USERNAME

デフォルトは env[OS_USERNAME] です。

--os-user-id OS_USER_ID

デフォルトは env[OS_USER_ID] です。

--os-user-domain-id OS_USER_DOMAIN_ID

デフォルトは env[OS_USER_DOMAIN_ID] です。

--os-user-domain-name OS_USER_DOMAIN_NAME

デフォルトは env[OS_USER_DOMAIN_NAME] です。

--os-project-id OS_PROJECT_ID

また、テナント ID を指定する別の方法--os-tenant-id と相互排他的になります。デフォルトは env[OS_PROJECT_ID] です。

--os-project-name OS_PROJECT_NAME

また、テナント名を指定する別の方法--os-tenant-name と相互排他的になります。デフォルトは env[OS_PROJECT_NAME] です。

--os-project-domain-id OS_PROJECT_DOMAIN_ID

デフォルトは env[OS_PROJECT_DOMAIN_ID] です。

--os-project-domain-name OS_PROJECT_DOMAIN_NAME

デフォルトは env[OS_PROJECT_DOMAIN_NAME] です。

--os-password OS_PASSWORD

デフォルトは env[OS_PASSWORD] です。

--os-tenant-id OS_TENANT_ID

デフォルトは env[OS_TENANT_ID] です。

--os-tenant-name OS_TENANT_NAME

デフォルトは env[OS_TENANT_NAME] です。

--os-auth-url OS_AUTH_URL

デフォルトは env[OS_AUTH_URL] です。

--os-region-name OS_REGION_NAME

デフォルトは env[OS_REGION_NAME] です。

--os-auth-token OS_AUTH_TOKEN

デフォルトは env[OS_AUTH_TOKEN] です。

--os-service-type OS_SERVICE_TYPE

デフォルトは env[OS_SERVICE_TYPE] です。

--os-endpoint-type OS_ENDPOINT_TYPE

デフォルトは env[OS_ENDPOINT_TYPE] です。

--profile HMAC_KEY

操作のパフォーマンスプロファイリングのためにコンテキストデータの暗号化に使用する HMAC キー。このキーは、heat の osprofiler ミドルウェアで設定された HMAC キーの値である必要があります。これは貼り付け設定(/etc/heat/api-paste.ini)で指定されます。キーがないと、サーバー側で osprofiler が有効になっている場合でも、プロファイリングがトリガーされません。

位置引数

<NAME or ID>

確認するスタックの名前または ID。

位置引数

<NAME or ID>

再開するスタックの名前または ID。

位置引数

<NAME or ID>

一時停止するスタックの名前または ID。

位置引数

<CONFIG_NAME>

作成する設定の名前。

オプションの引数

-f <FILE または URL>、--definition-file <FILE または URL>

<inputs>、<outputs>、および <options> を定義するマップが含まれる JSON/YAML へのパス。

-c <FILE または URL>、--config-file <FILE または URL>

設定スクリプト/データへのパス。

-g <GROUP_NAME>, --group <GROUP_NAME>

設定が必要とする設定ツールのグループ名。

位置引数

<ID>

削除する設定の ID。

位置引数

<ID>

設定の ID。

オプションの引数

-c、--config-only

<config> 属性の値のみを表示します。

位置引数

<DEPLOY_NAME>

このデプロイメントに関連する派生設定の名前。これは、サーバーに現在デプロイされている設定のリストにソート順序を適用するために使用されます。

オプションの引数

-i <KEY=VALUE>, --input-value <KEY=VALUE>

デプロイメントに設定する入力値。これは複数回指定できます。

-a <ACTION>, --action <ACTION>

このデプロイメントのアクションの名前。カスタムアクション、または CREATE、UPDATE、DELETE、SUSPEND、RESUME のいずれかを指定できます。

-c <CONFIG>, --config <CONFIG>

デプロイする設定の ID。

-s <SERVER>, --server <SERVER>

デプロイ先のサーバーの ID。

-t <TRANSPORT>, --signal-transport <TRANSPORT>

デプロイメント出力値を使用して、サーバーが heat にシグナルを送信する方法。TEMP_URL_SIGNAL は、HTTP PUT 経由でシグナル送信する Swift TempURL を作成します。NO_SIGNAL を指定すると、リソースはシグナルを待たずに COMPLETE の状態に移行します。

--container <CONTAINER_NAME>

TEMP_URL_SIGNAL オブジェクトを保存するコンテナーのオプション名です。指定しない場合は、DEPLOY_NAME から派生した名前でコンテナーが作成されます。

--timeout <TIMEOUT>

デプロイメントのタイムアウト (分単位)

位置引数

<ID>

削除するデプロイメントの ID。

オプションの引数

-s <SERVER>, --server <SERVER>

デプロイメントを取得するサーバーの ID。

位置引数

<ID>

デプロイメントを取得するサーバーの ID。

位置引数

<ID>

出力を表示する ID デプロイメント。

<OUTPUT NAME>

表示する出力の名前。

オプションの引数

-a、--all

すべてのデプロイメント出力を表示します。

-f <FORMAT>, --format <FORMAT>

出力値の形式。raw、json のいずれか

位置引数

<ID>

デプロイメントの ID。

位置引数

<NAME or ID>

イベントを表示するスタックの名前または ID。

オプションの引数

-r <RESOURCE>, --resource <RESOURCE>

イベントをフィルターするリソースの名前。

-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2..>

返されたイベントに適用するフィルターパラメーター。これは複数回指定するか、パラメーターをセミコロンで区切って指定することができます。

-l <LIMIT>, --limit <LIMIT>

返されるイベントの数を制限します。

-m <ID>, --marker <ID>

指定されたイベント ID の後に表示されるイベントのみを返します。

-n <DEPTH>, --nested-depth <DEPTH>

イベントを表示するネストされたスタックの深さ。これは --resource と共に指定できないことに注意してください。

-f <FORMAT>, --format <FORMAT>

出力値形式、log のいずれか、テーブル

位置引数

<NAME or ID>

イベントを表示するスタックの名前または ID。

<RESOURCE>

イベントが属するリソースの名前。

<EVENT>

詳細を表示するイベントの ID。

位置引数

<NAME or ID>

これらのリソースが属するスタックの名前または ID。

<RESOURCE>

クリアするフックを含むリソース名。ネストされたスタックのリソースは、スラッシュを区切り文字(nested_stack/another/my_resource)として使用して設定できます。ワイルドカードを使用して、複数のスタックまたはリソース(nested_stack/an*/*_resource)と一致することができます。

オプションの引数

--pre-create

作成前のフックをクリアします（オプション）。

--pre-update

更新前のフックをクリアします（オプション）。

位置引数

<NAME or ID>

保留中のフックを表示するスタックの名前または ID。

オプションの引数

-n <DEPTH>, --nested-depth <DEPTH>

フックを表示するネストされたスタックの深さ。

位置引数

<NAME or ID>

問い合わせるスタックの名前または ID。

位置引数

<NAME or ID>

問い合わせるスタックの名前または ID。

<OUTPUT NAME>

表示する出力の名前。

オプションの引数

-a、--all

すべてのスタックの出力を表示します。

-f <FORMAT>, --format <FORMAT>

出力値形式、json、raw のいずれか

位置引数

<NAME or ID>

リソースを表示するスタックの名前または ID。

オプションの引数

-n <DEPTH>, --nested-depth <DEPTH>

リソースを表示するネストされたスタックの深さ。

--with-detail

リソース一覧の各リソースに表示される詳細情報を有効にします。

位置引数

<NAME or ID>

リソースメタデータを表示するスタックの名前または ID。

<RESOURCE>

メタデータを表示するリソースの名前。

位置引数

<NAME or ID>

リソースを表示するスタックの名前または ID。

<RESOURCE>

詳細を表示するリソースの名前。

オプションの引数

-a <ATTRIBUTE>, --with-attr <ATTRIBUTE>

表示する属性。複数回指定できます。

位置引数

<NAME or ID>

リソースが属するスタックの名前または ID。

<RESOURCE>

通知するリソースの名前。

オプションの引数

-d <DATA>, --data <DATA>

シグナルハンドラーに送信する JSON データ。

-f <FILE>, --data-file <FILE>

シグナルハンドラーに送信する JSON データを含むファイル。

オプションの引数

-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2..>

返されたリソース種別に適用するフィルターパラメーターこれは複数回指定するか、パラメーターをセミコロンで区切って指定することができます。name、version、および support_status のいずれかになります。

位置引数

<RESOURCE_TYPE>

詳細を取得するリソースのタイプ。

位置引数

<RESOURCE_TYPE>

テンプレートを生成するリソースの種類。

オプションの引数

-t <TEMPLATE_TYPE>, --template-type <TEMPLATE_TYPE>

生成、ホット、または cfn のテンプレートタイプ。

-f <FORMAT>, --format <FORMAT>

テンプレート出力形式。yaml、json のいずれかです。

位置引数

<NAME or ID>

スナップショットが含まれるスタックの名前または ID。

<SNAPSHOT>

削除するスナップショットの ID。

位置引数

<NAME or ID>

スナップショットが含まれるスタックの名前または ID。

位置引数

<NAME or ID>

スナップショットが含まれるスタックの名前または ID。

<SNAPSHOT>

表示するスナップショットの ID。

位置引数

<NAME or ID>

破棄するスタックの名前または ID。

オプションの引数

-o <FILE>, --output-file <FILE>

破棄結果を出力するファイル。オプションを指定すると、<FILE> に出力されます。

位置引数

<STACK_NAME>

採用するスタックの名前。

オプションの引数

-e <FILE or URL>, --environment-file <FILE or URL>

環境へのパス。複数回指定できます。

-c <TIMEOUT>, --create-timeout <TIMEOUT>

スタックの作成タイムアウト（分単位）。非推奨 代わりに --timeout を使用します。

-t <TIMEOUT>, --timeout <TIMEOUT>

スタックの作成タイムアウト（分単位）。

-a <FILE または URL>、--adopt-file <FILE または URL>

スタックデータファイルへのパス。

-r、--enable-rollback

作成/更新失敗時のロールバックを有効にします。

-p <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...>

スタックの作成に使用するパラメーター値。これは複数回指定するか、パラメーターをセミコロンで区切って指定することができます。

位置引数

<NAME or ID>

更新をキャンセルするスタックの名前または ID。

位置引数

<STACK_NAME>

作成するスタックの名前。

オプションの引数

-f <FILE>, --template-file <FILE>

テンプレートへのパスです。

-e <FILE or URL>, --environment-file <FILE or URL>

環境へのパス。複数回指定できます。

--pre-create <RESOURCE>

作成前フックを設定するリソースの名前。ネストされたスタックのリソースは、スラッシュを区切り文字(nested_stack/another/my_resource)として使用して設定できます。ワイルドカードを使用して、複数のスタックまたはリソース(nested_stack/an*/*_resource)と一致することができます。これは複数回指定できます。

-u <URL>、--template-url <URL>

テンプレートの URL。

-o <URL>、--template-object <URL>

テンプレートオブジェクトを取得する URL （例：swift から）。

-c <TIMEOUT>, --create-timeout <TIMEOUT>

スタックの作成タイムアウト（分単位）。非推奨 代わりに --timeout を使用します。

-t <TIMEOUT>, --timeout <TIMEOUT>

スタックの作成タイムアウト（分単位）。

-r、--enable-rollback

作成/更新失敗時のロールバックを有効にします。

-p <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...>

スタックの作成に使用するパラメーター値。これは複数回指定するか、パラメーターをセミコロンで区切って指定することができます。

-PF <KEY=FILE>, --parameter-file <KEY=FILE>

スタックの作成に使用するファイルからのパラメーター値。これは複数回指定できます。パラメーター値は、ファイルのコンテンツです。

--poll [SECONDS]

スタックが完了するまでポーリングしてイベントを報告します。オプションのポーリング間隔（秒単位）を引数として指定できます。デフォルトは 5 です。

--tags <TAG1,TAG2>

スタックに関連付けるタグのリスト。

位置引数

<NAME or ID>

削除するスタックの名前または ID。

オプションの引数

-s、--show-deleted

スタックリストに、ソフト削除されたスタックを含めます。

-n、--show-nested

スタックリストにネストされたスタックを含めます。

-a、--show-hidden

スタックリストに非表示のスタックを含めます。

-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2..>

返されたスタックに適用するフィルターパラメーター。これは複数回指定するか、パラメーターをセミコロンで区切って指定することができます。

-t <TAG1,TAG2...>, --tags <TAG1,TAG2...>

これらのタグを含むスタックを表示し、ブール AND 式を使用して複数のタグを組み合わせます

--tags-any <TAG1,TAG2...>

これらのタグを含むスタックを表示し、ブール値 OR 式を使用して複数のタグを組み合わせます

--not-tags <TAG1,TAG2...>

これらのタグを含まないスタックを表示します。ブール値 AND 式を使用して複数のタグを組み合わせる

--not-tags-any <TAG1,TAG2...>

これらのタグを含まないスタックを表示します。ブール値 OR 式を使用して複数のタグを組み合わせる

-l <LIMIT>, --limit <LIMIT>

返されるスタックの数を制限します。

-m <ID>, --marker <ID>

指定されたスタック ID の後に表示されるスタックを返します。

-k <KEY1,KEY2...>, --sort-keys <KEY1,KEY2...>

返されたスタックのソートに使用するキーのリスト。これは複数回指定することも、1 回にキーをセミコロンで区切って指定することができます。有効なソートキーには、stack_name、stack_status、creation_time、および updated_time が含まれます。

-d [asc|desc]、--sort-dir [asc|desc]

ソートキーに対する並べ替え方向(asc または desc のいずれか)

-g、--global-tenant

すべてのテナントのスタックを表示します。この操作は、heat の policy.json のポリシーにマッチするユーザーにのみ許可されます。

-o、--show-owner

スタックの所有者情報を表示します。これは、--global-tenant を使用する場合に自動的に有効になります。

位置引数

<STACK_NAME>

プレビューするスタックの名前。

オプションの引数

-f <FILE>, --template-file <FILE>

テンプレートへのパスです。

-e <FILE or URL>, --environment-file <FILE or URL>

環境へのパス。複数回指定できます。

-u <URL>、--template-url <URL>

テンプレートの URL。

-o <URL>、--template-object <URL>

テンプレートオブジェクトを取得する URL （例：swift から）

-t <TIMEOUT>, --timeout <TIMEOUT>

スタックの作成タイムアウト（分単位）。これはプレビューでのみ使用されます。

-r、--enable-rollback

失敗時のロールバックを有効にします。このオプションはプレビュー中には使用されず、stack- create のシンボリックリンクにのみ存在します。

-p <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...>

スタックのプレビューに使用するパラメーター値。これは複数回指定するか、パラメーターをセミコロンで区切って指定することができます。

-PF <KEY=FILE>, --parameter-file <KEY=FILE>

スタックの作成に使用するファイルからのパラメーター値。これは複数回指定できます。パラメーター値は、ファイルのコンテンツです。

--tags <TAG1,TAG2>

スタックに関連付けるタグのリスト。

位置引数

<NAME or ID>

スナップショットが含まれるスタックの名前または ID。

<SNAPSHOT>

復元するスナップショットの ID。

位置引数

<NAME or ID>

記述するスタックの名前または ID。

位置引数

<NAME or ID>

スナップショットを作成するスタックの名前または ID。

オプションの引数

-n <NAME>, --name <NAME>

指定されている場合には、スナップショットに指定された名前。

位置引数

<NAME or ID>

更新するスタックの名前または ID。

オプションの引数

-f <FILE>, --template-file <FILE>

テンプレートへのパスです。

-e <FILE or URL>, --environment-file <FILE or URL>

環境へのパス。複数回指定できます。

--pre-update <RESOURCE>

更新前フックを設定するリソースの名前。ネストされたスタックのリソースは、スラッシュを区切り文字(nested_stack/another/my_resource)として使用して設定できます。ワイルドカードを使用して、複数のスタックまたはリソース(nested_stack/an*/*_resource)と一致することができます。これは複数回指定できます。

-u <URL>、--template-url <URL>

テンプレートの URL。

-o <URL>、--template-object <URL>

テンプレートオブジェクトを取得する URL （例：swift から）。

-t <TIMEOUT>, --timeout <TIMEOUT>

スタックの更新タイムアウト（分単位）。

-r、--enable-rollback

非推奨になりました。代わりに --rollback 引数を使用してください。スタックの更新失敗時のロールバックを有効にします。注記：現在、デフォルトの動作では、既存スタックの rollback 値が使用されます。

--rollback <VALUE>

更新の失敗時にロールバックを設定します。値('1'、't'、'true'、'on'、'y'、'yes')は、ロールバックを有効に設定します。値('0'、'f'、'false'、'off'、'n'、'no')は、ロールバックを disabled に設定します。デフォルトでは、更新する既存のスタックの値を使用します。

-y、--dry-run

実際にはスタックの更新を行わずに、何が変更されるかを表示します。

-p <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...>

スタックの作成に使用するパラメーター値。これは複数回指定するか、パラメーターをセミコロンで区切って指定することができます。

-PF <KEY=FILE>, --parameter-file <KEY=FILE>

スタックの作成に使用するファイルからのパラメーター値。これは複数回指定できます。パラメーター値は、ファイルのコンテンツです。

-x、--existing

現在のスタックのテンプレート、パラメーター、および環境を再利用します。テンプレートの引数を省略すると、既存のテンプレートが使用されます。--environment-file を指定しないと、既存の環境が使用されます。--parameters で指定したパラメーターは、現在のスタックの既存の値にパッチを適用します。パラメーター省略すると、既存の値は維持されます。

-c <PARAMETER>, --clear-parameter <PARAMETER>

スタックの更新用に、現在のスタックのパラメーターセットからパラメーターを削除します。テンプレートのデフォルト値が使用されます。これは複数回指定できます。

--tags <TAG1,TAG2>

スタックに関連付ける更新されたタグのリスト。

位置引数

<TEMPLATE_VERSION>

関数を取得するテンプレートのバージョン。

位置引数

<NAME or ID>

テンプレートを取得するためのスタックの名前または ID。

オプションの引数

-u <URL>、--template-url <URL>

テンプレートの URL。

-f <FILE>, --template-file <FILE>

テンプレートへのパスです。

-e <FILE or URL>, --environment-file <FILE or URL>

環境へのパス。複数回指定できます。

-o <URL>、--template-object <URL>

テンプレートオブジェクトを取得する URL （例：swift から）。

-n、--show-nested

ネストされたテンプレートからパラメーターも解決します。