コマンドラインインターフェースリファレンス

Red Hat OpenStack Platform 16.2

Red Hat OpenStack Platform のコマンドラインクライアント

概要

OpenStack に組み込まれているコマンドラインクライアントで利用できるコマンドに関するリファレンス

前書き

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、弊社 の CTO、Chris Wright のメッセージ を参照してください。

Red Hat ドキュメントへのフィードバック (英語のみ)

弊社ドキュメントに対するご意見をお聞かせください。ドキュメントの改善点があればお知らせください。

ドキュメントへのダイレクトフィードバック (DDF) 機能の使用 (英語版のみ)

特定の文章、段落、またはコードブロックに対して直接コメントを送付するには、DDF の Add Feedback 機能を使用してください。なお、この機能は英語版のドキュメントでのみご利用いただけます。

  1. Multi-page HTML 形式でドキュメントを表示します。
  2. ドキュメントの右上隅に Feedback ボタンが表示されていることを確認してください。
  3. コメントするテキスト部分をハイライト表示します。
  4. Add Feedback をクリックします。
  5. Add Feedback フィールドにコメントを入力します。
  6. (オプション) ドキュメントチームが連絡を取り問題についてお伺いできるように、ご自分のメールアドレスを追加します。
  7. 送信 をクリックします。

第1章 OpenStack クライアント

openstack クライアントは、一般的な OpenStack コマンドラインインターフェース(CLI)です。本章では、openstack バージョン 4.0.2 の主なオプションについて説明します。

OpenStack API へのコマンドラインインターフェース

使用方法

openstack [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
                 [--os-cloud <cloud-config-name>]
                 [--os-region-name <auth-region-name>]
                 [--os-cacert <ca-bundle-file>] [--os-cert <certificate-file>]
                 [--os-key <key-file>] [--verify | --insecure]
                 [--os-default-domain <auth-domain>]
                 [--os-interface <interface>]
                 [--os-service-provider <service_provider>]
                 [--os-remote-project-name <remote_project_name> | --os-remote-project-id <remote_project_id>]
                 [--os-remote-project-domain-name <remote_project_domain_name> | --os-remote-project-domain-id <remote_project_domain_id>]
                 [--timing] [--os-beta-command] [--os-profile hmac-key]
                 [--os-compute-api-version <compute-api-version>]
                 [--os-identity-api-version <identity-api-version>]
                 [--os-image-api-version <image-api-version>]
                 [--os-network-api-version <network-api-version>]
                 [--os-object-api-version <object-api-version>]
                 [--os-volume-api-version <volume-api-version>]
                 [--os-queues-api-version <queues-api-version>]
                 [--os-database-api-version <database-api-version>]
                 [--os-tripleoclient-api-version <tripleoclient-api-version>]
                 [--os-data-processing-api-version <data-processing-api-version>]
                 [--os-data-processing-url OS_DATA_PROCESSING_URL]
                 [--os-loadbalancer-api-version <loadbalancer-api-version>]
                 [--os-workflow-api-version <workflow-api-version>]
                 [--os-container-infra-api-version <container-infra-api-version>]
                 [--os-baremetal-api-version <baremetal-api-version>]
                 [--inspector-api-version INSPECTOR_API_VERSION]
                 [--inspector-url INSPECTOR_URL]
                 [--os-orchestration-api-version <orchestration-api-version>]
                 [--os-dns-api-version <dns-api-version>]
                 [--os-key-manager-api-version <key-manager-api-version>]
                 [--os-metrics-api-version <metrics-api-version>]
                 [--os-alarming-api-version <alarming-api-version>]
                 [--os-auth-type <auth-type>] [--os-endpoint <auth-endpoint>]
                 [--os-token <auth-token>] [--os-auth-url <auth-auth-url>]
                 [--os-system-scope <auth-system-scope>]
                 [--os-domain-id <auth-domain-id>]
                 [--os-domain-name <auth-domain-name>]
                 [--os-project-id <auth-project-id>]
                 [--os-project-name <auth-project-name>]
                 [--os-project-domain-id <auth-project-domain-id>]
                 [--os-project-domain-name <auth-project-domain-name>]
                 [--os-trust-id <auth-trust-id>]
                 [--os-identity-provider <auth-identity-provider>]
                 [--os-protocol <auth-protocol>]
                 [--os-client-id <auth-client-id>]
                 [--os-client-secret <auth-client-secret>]
                 [--os-openid-scope <auth-openid-scope>]
                 [--os-access-token-endpoint <auth-access-token-endpoint>]
                 [--os-discovery-endpoint <auth-discovery-endpoint>]
                 [--os-access-token-type <auth-access-token-type>]
                 [--os-redirect-uri <auth-redirect-uri>]
                 [--os-code <auth-code>] [--os-user-id <auth-user-id>]
                 [--os-username <auth-username>]
                 [--os-user-domain-id <auth-user-domain-id>]
                 [--os-user-domain-name <auth-user-domain-name>]
                 [--os-password <auth-password>]
                 [--os-passcode <auth-passcode>]
                 [--os-default-domain-id <auth-default-domain-id>]
                 [--os-default-domain-name <auth-default-domain-name>]
                 [--os-application-credential-secret <auth-application-credential-secret>]
                 [--os-application-credential-id <auth-application-credential-id>]
                 [--os-application-credential-name <auth-application-credential-name>]
                 [--os-consumer-key <auth-consumer-key>]
                 [--os-consumer-secret <auth-consumer-secret>]
                 [--os-access-key <auth-access-key>]
                 [--os-access-secret <auth-access-secret>]
                 [--os-user <auth-user>]
                 [--os-identity-provider-url <auth-identity-provider-url>]
                 [--os-roles <auth-roles>]
                 [--os-aodh-endpoint <auth-aodh-endpoint>]
                 [--os-auth-methods <auth-auth-methods>]
                 [--os-service-provider-endpoint <auth-service-provider-endpoint>]
                 [--os-service-provider-entity-id <auth-service-provider-entity-id>]
                 [--os-access-token <auth-access-token>]

表1.1 その他の引数 (オプション):

サマリー

--version

プログラムのバージョン番号を表示して終了します。

-v, --verbose

出力の詳細レベルが上がります。繰り返し指定できます。

-q, --quiet

警告およびエラー以外の出力を減らします。

--log-file LOG_FILE

出力をログに記録するファイルを指定します。デフォルトでは無効です。

-h, --help

ヘルプメッセージを表示して終了します。

--debug

エラーのトレースバックを表示します。

--os-cloud <cloud-config-name>

Clouds.yaml のクラウド名 (env: os_cloud)

--os-region-name <auth-region-name>

認証リージョン名 (env: os_region_name)

--os-cacert <ca-bundle-file>

CA 証明書バンドルファイル (env: os_cacert)

--os-cert <certificate-file>

クライアント証明書バンドルファイル(env: os_cert)

--os-key <key-file>

クライアント証明書キーファイル(env: os_key)

--verify

サーバー証明書を検証します(デフォルト)

--insecure

サーバー証明書の検証を無効にします。

--os-default-domain <auth-domain>

デフォルトのドメイン ID、デフォルト=default (env: OS_DEFAULT_DOMAIN)。

--os-interface <interface>

インターフェースタイプを選択します。有効なインターフェースタイプ:[admin, public, internal]。 デフォルト=public (Env: OS_INTERFACE)

--os-service-provider <service_provider>

Keystone-to-keystone フェデレーションを使用して、サービスプロバイダーで認証を行い、コマンドを実行します。リモートプロジェクトオプションも指定する必要があります。

--os-remote-project-name <remote_project_name>

Keystone-to-Keystone フェデレーションを使用する場合の、サービスプロバイダーに対して認証する際のプロジェクト名。

--os-remote-project-id <remote_project_id>

Keystone-to-Keystone フェデレーションを使用する場合の、サービスプロバイダーに対して認証する際のプロジェクト ID。

--os-remote-project-domain-name <remote_project_domain_name>

Keystone-to-Keystone フェデレーションを使用する場合の、サービスプロバイダーに対して認証する際のプロジェクトのドメイン名。

--os-remote-project-domain-id <remote_project_domain_id>

Keystone-to-Keystone フェデレーションを使用する場合の、サービスプロバイダーに対して認証する際のプロジェクトのドメイン ID。

--timing

API 呼び出しのタイミング情報を出力します。

--os-beta-command

変更の可能性のあるベータコマンドを有効にします。

--os-profile hmac-key

プロファイリングコンテキストデータを暗号化するための HMAC キー

--os-compute-api-version <compute-api-version>

Compute api バージョン、デフォルト=2.1(env: OS_COMPUTE_API_VERSION)

--os-identity-api-version <identity-api-version>

api バージョンを特定します。デフォルト=3(env: OS_IDMYBACKUPDIR_API_VERSION)

--os-image-api-version <image-api-version>

イメージ api バージョン、デフォルト=2(env: OS_IMAGE_API_VERSION)

--os-network-api-version <network-api-version>

ネットワーク api バージョン、デフォルト=2.0(env: OS_NETWORK_API_VERSION)

--os-object-api-version <object-api-version>

オブジェクト api バージョン、デフォルト=1(env: OS_MYBACKUPDIR_API_VERSION)

--os-volume-api-version <volume-api-version>

ボリューム api バージョン、デフォルト=3(env: OS_VOLUME_API_VERSION)

--os-queues-api-version <queues-api-version>

キュー API バージョン、デフォルト=2(env: OS_QUEUES_API_VERSION)

--os-database-api-version <database-api-version>

データベース api バージョン、デフォルト=1(env: OS_DATABASE_API_VERSION)

--os-tripleoclient-api-version <tripleoclient-api-version>

TripleO クライアント api バージョン、デフォルト=1(env: OS_TRIPLEOCLIENT_API_VERSION)

--os-data-processing-api-version <data-processing-api-version>

データ処理の api バージョン、デフォルト=1.1(env: OS_DATA_MYBACKUPDIRING_API_VERSION)

--os-data-processing-url OS_DATA_PROCESSING_URL

データ処理の api url (env: OS_DATA_MYBACKUPDIRING_API_URL)

--os-loadbalancer-api-version <loadbalancer-api-version>

Osc プラグイン api バージョン、デフォルト=2.0(env: OS_LOADBALANCER_API_VERSION)

--os-workflow-api-version <workflow-api-version>

ワークフロー api バージョン、デフォルト=2(env: OS_WORKFLOW_API_VERSION)

--os-container-infra-api-version <container-infra-api-version>

Container-infra api バージョン、デフォルト=1(env: OS_CONTAINER_INFRA_API_VERSION)

--os-baremetal-api-version <baremetal-api-version>

ベアメタル api バージョン、デフォルト="latest"(クライアントとサーバーの両方でサポートされる最新バージョン)(Env: OS_BAREMETAL_API_VERSION)

--inspector-api-version INSPECTOR_API_VERSION

インスペクター api バージョン。バージョン 1 だけがサポート対象です (env: INMYBACKUPDIRTOR_VERSION)。

--inspector-url INSPECTOR_URL

インスペクター url。デフォルトは localhost です (env: INMYBACKUPDIRTOR_URL)。

--os-orchestration-api-version <orchestration-api-version>

オーケストレーション api バージョン、デフォルト=1(env: OS_ORCHESTRATION_API_VERSION)

--os-dns-api-version <dns-api-version>

DNS api バージョン、デフォルト=2(env: os_dns_api_version)

--os-key-manager-api-version <key-manager-api-version>

Barbican api バージョン、デフォルト=1(env: OS_KEY_MANAGER_API_VERSION)

--os-metrics-api-version <metrics-api-version>

メトリクス api バージョン、デフォルト=1(env: OS_METRICS_API_VERSION)

--os-alarming-api-version <alarming-api-version>

キュー api バージョン、デフォルト=2(env: OS_ALARMING_API_VERSION)

--os-auth-type <auth-type>

認証タイプを選択します。利用可能な認証タイプ:admin_token、v3oidcauthcode、v3password、v3totp、v3oidcclientcredentials、password、noauth、token、v3applicationcredential、v1password、none、v3tokenlessauth、v3oauth1、gnocchi-basic、v3token、v3MYBACKUPDIRpassword、aodh-noauth、 v2password、v3oidcpassword、v3multifactor、v2token、gnocchi- noauth、v3adfspassword、v3oidcaccesstoken。デフォルト:--os-username/--os-token をもとに選択されます (Env: OS_AUTH_TYPE)。

--os-endpoint <auth-endpoint>

Admin_token: 常に使用されるエンドポイント。noauth: Cinder エンドポイント。none: 常に使用されるエンドポイント。gnocchi-basic: Gnocchi エンドポイント。gnocchi-noauth: Gnocchi エンドポイント(Env: OS_ENDPOINT)

--os-token <auth-token>

admin_token: 常に使用されるトークン。token: 認証に使用するトークン。v3token: 認証に使用するトークン。v2token: トークン (Env: OS_TOKEN)

--os-auth-url <auth-auth-url>

v3oidcauthcode: 認証 URL。v3password: 認証 URL。v3totp: 認証 URL。v3oidcclientcredentials: 認証 URL。password: 認証 URL.token: 認証 URL。v3applicationcredential: 認証 URL。v1password: 認証 URL。v3tokenlessauth: 認証 URL。v3oauth1: 認証 URL。v3token: 認証 URL。v3samlpassword: 認証 URL。v2password: 認証 URL。v3oidcpassword: 認証 URL。v3multifactor: 認証 URL。v2token: 認証 URL。v3adfspassword: 認証 URL。v3oidcaccesstoken: 認証 URL (Env: OS_AUTH_URL)

--os-system-scope <auth-system-scope>

With v3oidcauthcode: システム運用の範囲。v3password: システム運用の範囲。v3totp: システム運用の範囲。v3oidcclientcredentials: システム運用の範囲。password: システム運用の範囲。token: システム運用の範囲。v3applicationcredential: システム運用の範囲。v3token: システム運用の範囲。v3samlpassword: システム運用の範囲。v3oidcpassword: システム運用の範囲。v3multifactor: システム運用の範囲。v3adfspassword: システム運用の範囲。v3oidcaccesstoken: システム運用の範囲。 (Env: OS_SYSTEM_SCOPE)

--os-domain-id <auth-domain-id>

v3oidcauthcode: 範囲内のドメイン ID。v3password: 範囲内のドメイン ID。v3totp: 範囲内のドメイン ID。v3oidcclientcredentials: 範囲内のドメイン ID。password: 範囲内のドメイン ID。token: 範囲内のドメイン ID。 v3applicationcredential: 範囲内のドメイン ID。v3tokenlessauth: 範囲内のドメイン ID。 v3token: 範囲内のドメイン ID。 v3samlpassword: 範囲内のドメイン ID。 v3oidcpassword: 範囲内のドメイン ID。 v3multifactor: 範囲内のドメイン ID。 v3adfspassword: 範囲内のドメイン ID。 v3oidcaccesstoken: 範囲内のドメイン ID。 (Env: OS_DOMAIN_ID)

--os-domain-name <auth-domain-name>

v3oidcauthcode: 範囲内のドメイン名。v3password: 範囲内のドメイン名。v3totp: 範囲内のドメイン名。v3oidcclientcredentials: 範囲内のドメイン名。password: 範囲内のドメイン名。token: 範囲内のドメイン名。 v3applicationcredential: 範囲内のドメイン名。v3tokenlessauth: 範囲内のドメイン名。 v3token: 範囲内のドメイン名。 v3samlpassword: 範囲内のドメイン名。 v3oidcpassword: 範囲内のドメイン名。 v3multifactor: 範囲内のドメイン名。 v3adfspassword: 範囲内のドメイン名。 v3oidcaccesstoken: 範囲内のドメイン名。 (Env: OS_DOMAIN_ID)

--os-project-id <auth-project-id>

v3oidcauthcode: 範囲内のプロジェクト ID。 v3password: 範囲内のプロジェクト ID。 v3totp: 範囲内のプロジェクト ID。 v3oidcclientcredentials: 範囲内のプロジェクト ID。password: 範囲内のプロジェクト ID。 noauth: 範囲内のプロジェクト ID。token: 範囲内のプロジェクト ID。 v3applicationcredential: 範囲内のプロジェクト ID。v3tokenlessauth: 範囲内のプロジェクト ID。v3token: 範囲内のプロジェクト ID。v3samlpassword: 範囲内のプロジェクト ID。aodh- noauth: プロジェクト ID。 v3oidcpassword: 範囲内のプロジェクト ID。 v3multifactor: 範囲内のプロジェクト ID。 gnocchi-noauth: プロジェクト ID。 v3adfspassword: 範囲内のプロジェクト ID。v3oidcaccesstoken: 範囲内のプロジェクト ID。 (Env: OS_PROJECT_ID)

--os-project-name <auth-project-name>

v3oidcauthcode: 範囲内のプロジェクト名。v3password: 範囲内のプロジェクト名。 v3totp: 範囲内のプロジェクト名。 v3oidcclientcredentials: 範囲内のプロジェクト名。password: 範囲内のプロジェクト名。 token: 範囲内のプロジェクト名。 v3applicationcredential: 範囲内のプロジェクト名。 v1password: 使用する Swift アカウント。 v3tokenlessauth: 範囲内のプロジェクト名。 With v3token: 範囲内のプロジェクト名。 v3samlpassword: 範囲内のプロジェクト名。v3oidcpassword: 範囲内のプロジェクト名。v3multifactor: 範囲内のプロジェクト名。 v3adfspassword: 範囲内のプロジェクト名。v3oidcaccesstoken: 範囲内のプロジェクト名。 (Env: OS_PROJECT_NAME)

--os-project-domain-id <auth-project-domain-id>

v3oidcauthcode: プロジェクトを含むドメイン ID。v3password: プロジェクトを含むドメイン ID。v3totp: プロジェクトを含むドメイン ID。 v3oidcclientcredentials: プロジェクトを含むドメイン ID。password: プロジェクトを含むドメイン ID。 token: プロジェクトを含むドメイン ID。v3applicationcredential: プロジェクトを含むドメイン ID。v3tokenlessauth: プロジェクトを含むドメイン ID。v3token: プロジェクトを含むドメイン ID。v3samlpassword: プロジェクトを含むドメイン ID。v3oidcpassword: プロジェクトを含むドメイン ID。v3multifactor: プロジェクトを含むドメイン ID。v3adfspassword: プロジェクトを含むドメイン ID。v3oidcaccesstoken: プロジェクトを含むドメイン ID。 (Env: OS_PROJECT_DOMAIN_ID)

--os-project-domain-name <auth-project-domain-name>

v3oidcauthcode: プロジェクトを含むドメイン名。v3password: プロジェクトを含むドメイン名。v3totp: プロジェクトを含むドメイン名。 v3oidcclientcredentials: プロジェクトを含むドメイン名。password: プロジェクトを含むドメイン名。 token: プロジェクトを含むドメイン名。v3applicationcredential: プロジェクトを含むドメイン名。v3tokenlessauth: プロジェクトを含むドメイン名。v3token: プロジェクトを含むドメイン名。v3samlpassword: プロジェクトを含むドメイン名。v3oidcpassword: プロジェクトを含むドメイン名。v3multifactor: プロジェクトを含むドメイン名。v3adfspassword: プロジェクトを含むドメイン名。v3oidcaccesstoken: プロジェクトを含むドメイン名。 (Env: OS_PROJECT_DOMAIN_NAME)

--os-trust-id <auth-trust-id>

v3oidcauthcode: 信頼 ID。v3password: 信頼 ID。v3totp: 信頼 ID。v3oidcclientcredentials: 信頼 ID。password: 信頼 ID。token: 信頼 ID。v3applicationcredential: 信頼 ID。v3token: 信頼 ID。v3samlpassword: 信頼 ID。 v2password: 信頼 ID。v3oidcpassword: 信頼 ID。v3multifactor: 信頼 ID。v2token: 信頼 ID。v3adfspassword: 信頼 ID。 v3oidcaccesstoken: 信頼 ID (Env: OS_TRUST_ID)

--os-identity-provider <auth-identity-provider>

v3oidcauthcode: 認証プロバイダーの名前。v3oidcclientcredentials: 認証プロバイダーの名前。v3samlpassword: 認証プロバイダーの名前。v3oidcpassword: 認証プロバイダーの名前。v3adfspassword: 認証プロバイダーの名前。 v3oidcaccesstoken: 認証プロバイダーの名前。 (Env: OS_IDENTITY_PROVIDER)

--os-protocol <auth-protocol>

v3oidcauthcode: フェデレーションプラグイン。 v3oidcclientcredentials: フェデレーションプラグイン向けのプロトコル。v3samlpassword: フェデレーションプラグイン向けのプロトコル。v3oidcpassword: フェデレーションプラグイン向けのプロトコル。v3adfspassword: フェデレーションプラグイン向けのプロトコル。v3oidcaccesstoken: フェデレーションプラグイン向けのプロトコル。(Env: OS_PROTOCOL)

--os-client-id <auth-client-id>

v3oidcauthcode: oauth 2.0 クライアント ID。 v3oidcclientcredentials: OAuth 2.0 クライアント ID。v3oidcpassword: OAuth 2.0 クライアント ID。(Env: OS_CLIENT_ID)

--os-client-secret <auth-client-secret>

v3oidcauthcode: oauth 2.0 クライアントシークレット。 v3oidcclientcredentials: OAuth 2.0 クライアントシークレット。v3oidcpassword: OAuth 2.0 クライアントシークレット。(Env: OS_CLIENT_SECRET)

--os-openid-scope <auth-openid-scope>

v3oidcauthcode: 認可サーバーから要求された openid 接続範囲。OpenID Connect 仕様には、「openid」を常に指定する必要があります。v3oidcclientcredentials: OpenID Connect 範囲が認可サーバーから要求されます。OpenID Connect 仕様には、「openid」を常に指定する必要があります。v3oidcpassword: 認可サーバーから要求される OpenID Connect 範囲。OpenID Connect 仕様には、「openid」を常に指定する必要があります。(Env: OS_OPENID_SCOPE)

--os-access-token-endpoint <auth-access-token-endpoint>

V3oidcauthcode: openid connect プロバイダーの トークンエンドポイント。検出ドキュメントが渡された場合には、このオプションの指定内容が、検出ドキュメントでサーバーが提供するエンドポイントよりも優先される点に注意してください。V3oidcclientcredentials: OpenID Connect プロバイダートークンエンドポイント。検出ドキュメントが渡された場合には、このオプションの指定内容が、検出ドキュメントでサーバーが提供するエンドポイントよりも優先される点に注意してください。V3oidcpassword: OpenID Connect プロバイダートークンエンドポイント。検出ドキュメントが渡された場合には、このオプションの指定内容が、検出ドキュメントでサーバーが提供するエンドポイントよりも優先される点に注意してください。(Env: OS_ACCESS_TOKEN_ENDPOINT)

--os-discovery-endpoint <auth-discovery-endpoint>

V3oidcauthcode: openid connect 検出 ドキュメント URL。検出ドキュメントを使用して、アクセストークンエンドポイントおよび認証エンドポイントの値を取得します。この URL は、https://idp.example.org/.well-known/openid-configuration のようになります。v3oidcclientcredentials: OpenID Connect 検出ドキュメントの URL。検出ドキュメントを使用して、アクセストークンエンドポイントおよび認証エンドポイントの値を取得します。この URL はhttps://idp.example.org/.well- known/openid-configuration のようになるはずです。v3oidcpassword: OpenID Connect 検出ドキュメント URL。検出ドキュメントを使用して、アクセストークンエンドポイントおよび認証エンドポイントの値を取得します。この URL は https://idp.example.org/.well- known/openid-configuration のようになるはずです (Env: OS_DISCOVERY_ENDPOINT)。

--os-access-token-type <auth-access-token-type>

V3oidcauthcode: oauth 2.0 承認サーバー Introspection トークンタイプ。これはトークンイントロスペクションの処理時に使用するトークンの種類を決定するために使用されます。有効な値は、「access_token」または「id_token」です。v3oidcclientcredentials: OAuth 2.0 認証サーバーイントロスペクションのトークンタイプで、トークンイントロスペクションの処理時に使用するトークンのタイプを決定するために使用されます。有効な値は、「access_token」または「id_token」です。v3oidcpassword: OAuth 2.0 認証サーバーイントロスペクションのトークンタイプで、トークンイントロスペクションの処理時に使用するトークンのタイプを決定するために使用されます。有効な値は、「access_token」または「id_token」です (Env: OS_ACCESS_TOKEN_TYPE)。

--os-redirect-uri <auth-redirect-uri>

v3oidcauthcode: openid connect リダイレクト url (env: OS_REPOL_URI)

--os-code <auth-code>

v3oidcauthcode: oauth 2.0 承認コード(Env: OS_CODE)

--os-user-id <auth-user-id>

v3password: ユーザー id。v3totp: ユーザー id。password: ユーザー id。noauth: ユーザー id。 v3applicationcredential: ユーザー id。aodh-noauth: ユーザー id。v2password: ログインする ユーザー ID。gnocchi-noauth: ユーザー ID(Env: OS_USER_ID)

--os-username <auth-username>

v3password: ユーザー名。v3totp: ユーザー名。password: ユーザー名。 v3applicationcredential: ユーザー名。 v1password: ログインするユーザー名。v3MYBACKUPDIRpassword: ユーザー名。 v2password: ログインするユーザー名 v3oidcpassword: ユーザー名。 v3adfspassword: ユーザー名 (Env: OS_USERNAME)

--os-user-domain-id <auth-user-domain-id>

v3password: ユーザーのドメイン ID。v3totp: ユーザーのドメイン ID。password: ユーザーのドメイン ID。v3applicationcredential: ユーザーのドメイン ID。(Env: OS_USER_DOMAIN_ID)

--os-user-domain-name <auth-user-domain-name>

v3password: ユーザーのドメイン名。v3totp: ユーザーのドメイン名。password: ユーザーのドメイン名。v3applicationcredential: ユーザーのドメイン名。(Env: OS_USER_DOMAIN_NAME)

--os-password <auth-password>

v3password: ユーザーのパスワード。password: ユーザーのパスワード。v1password: ユーザーのパスワード。v3MYBACKUPDIRpassword: パスワード。v2password: 使用するパスワード。v3oidcpassword: パスワード。 v3adfspassword: パスワード。(Env: OS_PASSWORD)

--os-passcode <auth-passcode>

v3totp: ユーザーの totp パスコード (env: os_passcode)

--os-default-domain-id <auth-default-domain-id>

パスワード: v3 および v2 パラメーターで使用するオプションのドメイン ID。これは v3 のユーザーとプロジェクトドメインの両方に使用され、v2 認証では無視されます。トークン:v3 および v2 パラメーターで使用するオプションのドメイン ID。これは v3 のユーザーとプロジェクトドメインの両方に使用され、v2 認証では無視されます。(Env: OS_DEFAULT_DOMAIN_ID)

--os-default-domain-name <auth-default-domain-name>

パスワード: v3 api および v2 パラメーターと使用するオプションのドメイン名。これは v3 のユーザーとプロジェクトドメインの両方に使用され、v2 認証では無視されます。トークン:v3 API および v2 パラメーターで使用するオプションのドメイン名。これは v3 のユーザーとプロジェクトドメインの両方に使用され、v2 認証では無視されます。(Env: OS_DEFAULT_DOMAIN_NAME)

--os-application-credential-secret <auth-application-credential-secret>

V3applicationcredential: アプリケーション認証情報の認証シークレット(Env: OS_APPLICATION_CREDENTIAL_SECRET)

--os-application-credential-id <auth-application-credential-id>

V3applicationcredential: アプリケーション認証情報 ID(Env: OS_APPLICATION_CREDENTIAL_ID)

--os-application-credential-name <auth-application-credential-name>

V3applicationcredential: アプリケーション認証情報名(Env: OS_APPLICATION_CREDENTIAL_NAME)

--os-consumer-key <auth-consumer-key>

With v3oauth1: oauth コンシューマー id/キー(env: OS_CONSUMER_KEY)

--os-consumer-secret <auth-consumer-secret>

V3oauth1: oauth コンシューマーシークレット(env: OS_CONSUMER_SECRET)

--os-access-key <auth-access-key>

v3oauth1: oauth アクセスキー(env: os_access_key)

--os-access-secret <auth-access-secret>

V3oauth1: oauth アクセスシークレット(env: OS_ACCESS_SECRET)

--os-user <auth-user>

gnocchi-basic: ユーザー(env: os_user)

--os-identity-provider-url <auth-identity-provider-url>

v3samlpassword: SAML2 認証要求の送信先となる認証プロバイダーの URL。V3adfspassword: SAML 認証要求の送信先となる認証プロバイダーの URL。(Env: OS_IDMYBACKUPDIR_INTERFACE_URL)

--os-roles <auth-roles>

aodh-noauth: ロール。with gnocchi-noauth: ロール(Env: OS_ROLES)

--os-aodh-endpoint <auth-aodh-endpoint>

aodh-noauth: aodh エンドポイント(env: OS_AODH_ENDPOINT)

--os-auth-methods <auth-auth-methods>

V3multifactor: 認証する方法。(Env: OS_AUTH_METHODS)

--os-service-provider-endpoint <auth-service-provider-endpoint>

V3adfspassword: サービスプロバイダーのエンドポイント(env: OS_SERVICE_PROVIDER_ENDPOINT)の使用

--os-service-provider-entity-id <auth-service-provider-entity-id>

v3adfspassword: サービスプロバイダの SAML エンティティー id(Env: OS_SERVICE_MYBACKUPDIR_MYBACKUPDIR_ID)

--os-access-token <auth-access-token>

v3oidcaccesstoken: oauth 2.0 アクセストークン(env: OS_ACCESS_TOKEN)

第2章 アクセス

本章では、access コマンドに含まれるコマンドについて説明します。

2.1. access token create

アクセストークンを作成します。

使用方法

openstack access token create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     --consumer-key <consumer-key>
                                     --consumer-secret <consumer-secret>
                                     --request-key <request-key>
                                     --request-secret <request-secret>
                                     --verifier <verifier>

表2.1 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--consumer-key <consumer-key>

コンシューマーキー (必須)

--consumer-secret <consumer-secret>

コンシューマーシークレット (必須)

--request-key <request-key>

アクセストークンを交換するための要求トークン(必須)

--request-secret <request-secret>

<request-key> に関連付けられたシークレット(必須)

--verifier <verifier>

<request-key> に関連付けられた検証機能(必須)

表2.2 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表2.3 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表2.4 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表2.5 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第3章 acl

本章では、acl コマンドに含まれるコマンドについて説明します。

3.1. acl delete

Href で特定されたシークレットまたはコンテナーの ACL を削除します。

使用方法

openstack acl delete [-h] URI

表3.1 位置引数

サマリー

URI

シークレットまたはコンテナーの URI 参照。

表3.2 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

3.2. acl get

Href を指定して、シークレットまたはコンテナーの ACL を取得します。

使用方法

openstack acl get [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                         [--quote {all,minimal,none,nonnumeric}] [--noindent]
                         [--max-width <integer>] [--fit-width] [--print-empty]
                         [--sort-column SORT_COLUMN]
                         URI

表3.3 位置引数

サマリー

URI

シークレットまたはコンテナーの URI 参照。

表3.4 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表3.5 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表3.6 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表3.7 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表3.8 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

3.3. acl submit

Href で特定されたシークレットまたはコンテナーに ACL を送信します。

使用方法

openstack acl submit [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--user [USERS]]
                            [--project-access | --no-project-access]
                            [--operation-type {read}]
                            URI

表3.9 位置引数

サマリー

URI

シークレットまたはコンテナーの URI 参照。

表3.10 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--user [USERS], -u [USERS]

ACL の keystone ユーザー ID。

--project-access

プロジェクトアクセスの動作を有効にするフラグ。

--no-project-access

プロジェクトアクセスの動作を無効にするフラグ。

--operation-type {read}, -o {read}

設定される Barbican 操作の acl のタイプ。

表3.11 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表3.12 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表3.13 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表3.14 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

3.4. acl user add

Href で特定されたシークレットまたはコンテナーに ACL ユーザーを追加します。

使用方法

openstack acl user add [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN] [--user [USERS]]
                              [--project-access | --no-project-access]
                              [--operation-type {read}]
                              URI

表3.15 位置引数

サマリー

URI

シークレットまたはコンテナーの URI 参照。

表3.16 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--user [USERS], -u [USERS]

ACL の keystone ユーザー ID。

--project-access

プロジェクトアクセスの動作を有効にするフラグ。

--no-project-access

プロジェクトアクセスの動作を無効にするフラグ。

--operation-type {read}, -o {read}

設定される Barbican 操作の acl のタイプ。

表3.17 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表3.18 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表3.19 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表3.20 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

3.5. acl user remove

Href で特定されたシークレットまたはコンテナーから ACL ユーザーを削除します。

使用方法

openstack acl user remove [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN] [--user [USERS]]
                                 [--project-access | --no-project-access]
                                 [--operation-type {read}]
                                 URI

表3.21 位置引数

サマリー

URI

シークレットまたはコンテナーの URI 参照。

表3.22 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--user [USERS], -u [USERS]

ACL の keystone ユーザー ID。

--project-access

プロジェクトアクセスの動作を有効にするフラグ。

--no-project-access

プロジェクトアクセスの動作を無効にするフラグ。

--operation-type {read}, -o {read}

設定される Barbican 操作の acl のタイプ。

表3.23 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表3.24 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表3.25 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表3.26 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第4章 action

本章では、action コマンドに含まれるコマンドについて説明します。

4.1. action definition create

新しいアクションを作成します。

使用方法

openstack action definition create [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          [--marker [MARKER]]
                                          [--limit [LIMIT]]
                                          [--sort_keys [SORT_KEYS]]
                                          [--sort_dirs [SORT_DIRS]]
                                          [--filter FILTERS] [--public]
                                          definition

表4.1 位置引数

サマリー

定義

アクション定義ファイル

表4.2 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

--public

このフラグを使用した場合には、アクションには「パブリック」のマークが付けられます。

表4.3 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表4.4 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表4.5 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表4.6 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

4.2. action definition definition show

アクション定義を表示します。

使用方法

openstack action definition definition show [-h] name

表4.7 位置引数

サマリー

name

アクション名

表4.8 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

4.3. action definition delete

アクションを削除します。

使用方法

openstack action definition delete [-h] action [action ...]

表4.9 位置引数

サマリー

action

アクションの名前または ID。

表4.10 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

4.4. action definition list

すべてのアクションを一覧表示します。

使用方法

openstack action definition list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--marker [MARKER]] [--limit [LIMIT]]
                                        [--sort_keys [SORT_KEYS]]
                                        [--sort_dirs [SORT_DIRS]]
                                        [--filter FILTERS]

表4.11 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

表4.12 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表4.13 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表4.14 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表4.15 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

4.5. action definition show

特定のアクションを表示します。

使用方法

openstack action definition show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        action

表4.16 位置引数

サマリー

action

アクション(名前または ID)

表4.17 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表4.18 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表4.19 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表4.20 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表4.21 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

4.6. action definition update

アクションを更新します。

使用方法

openstack action definition update [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          [--marker [MARKER]]
                                          [--limit [LIMIT]]
                                          [--sort_keys [SORT_KEYS]]
                                          [--sort_dirs [SORT_DIRS]]
                                          [--filter FILTERS] [--id ID]
                                          [--public]
                                          definition

表4.22 位置引数

サマリー

定義

アクション定義ファイル

表4.23 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

--id ID

アクション ID。

--public

このフラグを使用した場合には、アクションには「パブリック」のマークが付けられます。

表4.24 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表4.25 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表4.26 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表4.27 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

4.7. action execution delete

アクション実行を削除します。

使用方法

openstack action execution delete [-h]
                                         action_execution
                                         [action_execution ...]

表4.28 位置引数

サマリー

action_execution

アクション実行識別子の ID。

表4.29 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

4.8. action execution input show

Action 実行入力データを表示します。

使用方法

openstack action execution input show [-h] id

表4.30 位置引数

サマリー

id

アクション実行 ID。

表4.31 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

4.9. action execution list

すべてのアクション実行を一覧表示します。

使用方法

openstack action execution list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--marker [MARKER]] [--limit [LIMIT]]
                                       [--sort_keys [SORT_KEYS]]
                                       [--sort_dirs [SORT_DIRS]]
                                       [--filter FILTERS] [--oldest]
                                       [task_execution_id]

表4.32 位置引数

サマリー

task_execution_id

タスクの実行 ID。

表4.33 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

--oldest

最新のエントリーからではなく、最も古いエントリーから開始する実行を表示します。

表4.34 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表4.35 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表4.36 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表4.37 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

4.10. action execution output show

アクション実行の出力データを表示します。

使用方法

openstack action execution output show [-h] id

表4.38 位置引数

サマリー

id

アクション実行 ID。

表4.39 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

4.11. action execution run

新しいアクションの実行を作成するか、または特定のアクションを実行します。

使用方法

openstack action execution run [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [-s] [--run-sync]
                                      [-t TARGET]
                                      name [input]

表4.40 位置引数

サマリー

name

実行するアクション名。

input

アクション入力。

表4.41 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

-s, --save-result

結果を db に保存します。

--run-sync

アクションを同期的に実行します。

-t TARGET, --target TARGET

アクションは <target> エグゼキューターで実行されます。

表4.42 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表4.43 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表4.44 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表4.45 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

4.12. action execution show

特定のアクション実行を表示します。

使用方法

openstack action execution show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       action_execution

表4.46 位置引数

サマリー

action_execution

アクション実行 ID。

表4.47 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表4.48 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表4.49 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表4.50 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表4.51 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

4.13. action execution update

特定のアクション実行を更新します。

使用方法

openstack action execution update [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         [--state {PAUSED,RUNNING,SUCCESS,ERROR,CANCELLED}]
                                         [--output OUTPUT]
                                         id

表4.52 位置引数

サマリー

id

アクション実行 ID。

表4.53 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--state {PAUSED,RUNNING,SUCCESS,ERROR,CANCELLED}

アクション実行の状態

--output OUTPUT

アクション実行の出力

表4.54 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表4.55 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表4.56 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表4.57 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第5章 address

本章では、address コマンドに含まれるコマンドについて説明します。

5.1. address scope create

新しいアドレススコープを作成します。

使用方法

openstack address scope create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--ip-version {4,6}]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--share | --no-share]
                                      <name>

表5.1 位置引数

サマリー

<name>

新しいアドレススコープ名

表5.2 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--ip-version {4,6}

IP バージョン(デフォルトは 4)

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--share

プロジェクト間でアドレススコープを共有します。

--no-share

プロジェクト間でアドレススコープを共有しません(デフォルト)

表5.3 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表5.4 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表5.5 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表5.6 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

5.2. address scope delete

アドレススコープを削除します。

使用方法

openstack address scope delete [-h]
                                      <address-scope> [<address-scope> ...]

表5.7 位置引数

サマリー

<address-scope>

削除するアドレススコープ(名前または ID)

表5.8 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

5.3. address scope list

アドレススコープを一覧表示します。

使用方法

openstack address scope list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--name <name>]
                                    [--ip-version <ip-version>]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--share | --no-share]

表5.9 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

出力に、指定された名前のアドレススコープのみを一覧表示します。

--ip-version <ip-version>

指定した IP バージョンネットワークのアドレススコープを一覧表示します(4 または 6)。

--project <project>

プロジェクト(名前または ID)に合わせてアドレススコープを一覧表示します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--share

プロジェクト間で共有されているアドレススコープを一覧表示します。

--no-share

プロジェクト間で共有されていないアドレススコープを一覧表示します。

表5.10 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表5.11 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表5.12 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表5.13 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

5.4. address scope set

アドレススコープのプロパティーを設定します。

使用方法

openstack address scope set [-h] [--name <name>] [--share | --no-share]
                                   <address-scope>

表5.14 位置引数

サマリー

<address-scope>

変更するアドレススコープ(名前または ID)

表5.15 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

アドレススコープ名を設定します。

--share

プロジェクト間でアドレススコープを共有します。

--no-share

プロジェクト間でアドレススコープを共有しません。

5.5. address scope show

アドレススコープの詳細を表示します。

使用方法

openstack address scope show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <address-scope>

表5.16 位置引数

サマリー

<address-scope>

表示するアドレススコープ(名前または ID)

表5.17 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表5.18 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表5.19 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表5.20 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表5.21 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第6章 aggregate

本章では、aggregate コマンドに含まれるコマンドについて説明します。

6.1. aggregate add host

ホストアグリゲートにホストを追加します。

使用方法

openstack aggregate add host [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <aggregate> <host>

表6.1 位置引数

サマリー

<aggregate>

アグリゲート(名前または ID)

<host>

<aggregate> に追加するホスト

表6.2 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表6.3 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表6.4 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表6.5 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表6.6 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

6.2. aggregate create

新規アグリゲートを作成します。

使用方法

openstack aggregate create [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--zone <availability-zone>]
                                  [--property <key=value>]
                                  <name>

表6.7 位置引数

サマリー

<name>

新しいアグリゲート名

表6.8 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--zone <availability-zone>

アベイラビリティーゾーン名

--property <key=value>

このアグリゲートに追加するプロパティー(複数のプロパティーを設定する場合は repeat オプション)

表6.9 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表6.10 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表6.11 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表6.12 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

6.3. aggregate delete

既存のアグリゲートを削除します。

使用方法

openstack aggregate delete [-h] <aggregate> [<aggregate> ...]

表6.13 位置引数

サマリー

<aggregate>

削除するアグリゲート(名前または ID)

表6.14 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

6.4. aggregate list

すべてのアグリゲートを一覧表示します。

使用方法

openstack aggregate list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--noindent] [--max-width <integer>]
                                [--fit-width] [--print-empty]
                                [--sort-column SORT_COLUMN] [--long]

表6.15 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

表6.16 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表6.17 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表6.18 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表6.19 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

6.5. aggregate remove host

アグリゲートからホストを削除します。

使用方法

openstack aggregate remove host [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <aggregate> <host>

表6.20 位置引数

サマリー

<aggregate>

アグリゲート(名前または ID)

<host>

<aggregate> から削除するホスト

表6.21 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表6.22 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表6.23 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表6.24 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表6.25 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

6.6. aggregate set

アグリゲートプロパティーを設定します。

使用方法

openstack aggregate set [-h] [--name <name>]
                               [--zone <availability-zone>]
                               [--property <key=value>] [--no-property]
                               <aggregate>

表6.26 位置引数

サマリー

<aggregate>

変更するアグリゲート(名前または ID)

表6.27 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

アグリゲート名を設定します。

--zone <availability-zone>

アベイラビリティーゾーン名を設定します。

--property <key=value>

<aggregate> に設定するプロパティー(複数のプロパティーを設定する場合はオプションを繰り返し使用します)

--no-property

<aggregate> からすべてのプロパティーを削除します(--property と --no-property の両方を指定して現在のプロパティーを上書きします)。

6.7. aggregate show

アグリゲートの詳細を表示します。

使用方法

openstack aggregate show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                <aggregate>

表6.28 位置引数

サマリー

<aggregate>

表示へのアグリゲート(名前または ID)

表6.29 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表6.30 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表6.31 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表6.32 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表6.33 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

6.8. aggregate unset

アグリゲートプロパティーの設定を解除します。

使用方法

openstack aggregate unset [-h] [--property <key>] <aggregate>

表6.34 位置引数

サマリー

<aggregate>

変更するアグリゲート(名前または ID)

表6.35 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--property <key>

アグリゲートから削除するプロパティー(複数のプロパティーを設定する場合はオプションを繰り返し使用します)

第7章 alarm

本章では、alarm コマンドに含まれるコマンドについて説明します。

7.1. alarm create

アラームの作成

使用方法

openstack alarm create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] --name <NAME> -t <TYPE>
                              [--project-id <PROJECT_ID>]
                              [--user-id <USER_ID>]
                              [--description <DESCRIPTION>] [--state <STATE>]
                              [--severity <SEVERITY>] [--enabled {True|False}]
                              [--alarm-action <Webhook URL>]
                              [--ok-action <Webhook URL>]
                              [--insufficient-data-action <Webhook URL>]
                              [--time-constraint <Time Constraint>]
                              [--repeat-actions {True|False}]
                              [--query <QUERY>]
                              [--comparison-operator <OPERATOR>]
                              [--evaluation-periods <EVAL_PERIODS>]
                              [--threshold <THRESHOLD>]
                              [--event-type <EVENT_TYPE>]
                              [--granularity <GRANULARITY>]
                              [--aggregation-method <AGGR_METHOD>]
                              [--metric <METRIC>]
                              [--resource-type <RESOURCE_TYPE>]
                              [--resource-id <RESOURCE_ID>]
                              [--composite-rule <COMPOSITE_RULE>]

表7.1 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--name <NAME>

アラームの名前

-t <TYPE>, --type <TYPE>

アラームのタイプ:event、composite、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold のいずれかです。

--project-id <PROJECT_ID>

アラームに関連付けるプロジェクト(管理ユーザーだけが設定可能)

--user-id <USER_ID>

アラームに関連付けるユーザー(管理ユーザーだけが設定可能)

--description <DESCRIPTION>

アラームのフリーテキストの説明

--state <STATE>

アラームの状態。以下のいずれか:[ok, alarm, insufficient data]

--severity <SEVERITY>

アラームの重大度。以下のいずれか [low, moderate,critical]

--enabled {True

False}

アラーム評価が有効な場合は true。

--alarm-action <Webhook URL>

状態がalarmに切り替わったときに呼び出す URL。複数回使用できます。

--ok-action <Webhook URL>

状態が ok に切り替わったときに呼び出す URL。複数回使用できます。

--insufficient-data-action <Webhook URL>

状態が insufficient data に切り替わったときに呼び出す URL。複数回の使用が可能です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]] です。

--repeat-actions {True

False}

アラームがターゲット状態にある時にアクションを繰り返し通知する場合は True

表7.2 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表7.3 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表7.4 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表7.5 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

表7.6 common alarm rules

サマリー

--query <QUERY>

アラームのイベントタイプ: key[op]data_type::value; list。data_type はオプションですが、指定する場合には、文字列、整数、浮動またはブール型にする必要があります。gnocchi_aggregation_by_resources_threshold タイプのアラーム: {"and": [{"=": {"ended_at": null}}, …​]} のように、複雑なクエリー json 文字列を指定する必要があります。

--comparison-operator <OPERATOR>

比較するオペレーター:[lt,le,eq,ne,ge,gt] のいずれか。

--evaluation-periods <EVAL_PERIODS>

評価する期間の数

--threshold <THRESHOLD>

評価するしきい値。

表7.7 event alarm

サマリー

--event-type <EVENT_TYPE>

評価対象のイベントタイプ

表7.8 common gnocchi alarm rules

サマリー

--granularity <GRANULARITY>

クエリーを行う時間範囲(秒単位)。

--aggregation-method <AGGR_METHOD>

しきい値と比較する aggregation_method

--metric <METRIC>, --metrics <METRIC>

アラームタイプに応じたメトリック ID または名前

表7.9 gnocchi resource threshold alarm

サマリー

--resource-type <RESOURCE_TYPE>

リソースのタイプ。

--resource-id <RESOURCE_ID>

リソースの ID。

表7.10 composite alarm

サマリー

--composite-rule <COMPOSITE_RULE>

Json 形式の複合しきい値ルール。形式として、"and"や"or" で gnocchi ルールを組み合わせた、ネスト化ディクショナリーを指定できます。形式例: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}。

7.2. alarm delete

アラームを削除します。

使用方法

openstack alarm delete [-h] [--name <NAME>] [<ALARM ID or NAME>]

表7.11 位置引数

サマリー

<ALARM ID または NAME>

アラームの ID または名前。

表7.12 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--name <NAME>

アラームの名前

7.4. alarm-history show

アラームの履歴を表示します。

使用方法

openstack alarm-history show [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--limit <LIMIT>] [--marker <MARKER>]
                                    [--sort <SORT_KEY:SORT_DIR>]
                                    <alarm-id>

表7.18 位置引数

サマリー

<alarm-id>

アラームの ID

表7.19 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--limit <LIMIT>

返すリソースの数(デフォルトはサーバーのデフォルトです)。

--marker <MARKER>

前の一覧の最後のアイテム。この値の後に来る結果を返します。サポート対象のマーカーは event_id です。

--sort <SORT_KEY:SORT_DIR>

リソース属性をソートします(例:timestamp:desc)。

表7.20 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表7.21 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表7.22 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表7.23 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

7.5. alarm list

アラームを一覧表示します。

使用方法

openstack alarm list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--query QUERY | --filter <KEY1=VALUE1;KEY2=VALUE2...>]
                            [--limit <LIMIT>] [--marker <MARKER>]
                            [--sort <SORT_KEY:SORT_DIR>]

表7.24 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--query QUERY

aodh がサポートする立地クエリー。例: project_id!=my-id user_id=foo or user_id=bar

--filter <KEY1=VALUE1;KEY2=VALUE2…​>

返されたアラームに適用するパラメーターをフィルターします。

--limit <LIMIT>

返すリソースの数(デフォルトはサーバーのデフォルトです)。

--marker <MARKER>

前の一覧の最後のアイテム。この値の後に来る結果を返します。サポート対象のマーカーは alarm_id です。

--sort <SORT_KEY:SORT_DIR>

リソース属性をソートします(例:name:asc)。

表7.25 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表7.26 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表7.27 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表7.28 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

7.6. alarm show

アラームを表示します。

使用方法

openstack alarm show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--name <NAME>]
                            [<ALARM ID or NAME>]

表7.29 位置引数

サマリー

<ALARM ID または NAME>

アラームの ID または名前。

表7.30 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--name <NAME>

アラームの名前

表7.31 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表7.32 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表7.33 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表7.34 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

7.7. alarm state get

アラームの状態を取得します。

使用方法

openstack alarm state get [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--name <NAME>]
                                 [<ALARM ID or NAME>]

表7.35 位置引数

サマリー

<ALARM ID または NAME>

アラームの ID または名前。

表7.36 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--name <NAME>

アラームの名前

表7.37 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表7.38 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表7.39 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表7.40 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

7.8. alarm state set

アラームの状態を設定します。

使用方法

openstack alarm state set [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--name <NAME>] --state
                                 <STATE>
                                 [<ALARM ID or NAME>]

表7.41 位置引数

サマリー

<ALARM ID または NAME>

アラームの ID または名前。

表7.42 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--name <NAME>

アラームの名前

--state <STATE>

アラームの状態。以下のいずれか:[ok, alarm, insufficient data]

表7.43 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表7.44 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表7.45 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表7.46 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

7.9. alarm update

アラームを更新します。

使用方法

openstack alarm update [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--name <NAME>] [-t <TYPE>]
                              [--project-id <PROJECT_ID>]
                              [--user-id <USER_ID>]
                              [--description <DESCRIPTION>] [--state <STATE>]
                              [--severity <SEVERITY>] [--enabled {True|False}]
                              [--alarm-action <Webhook URL>]
                              [--ok-action <Webhook URL>]
                              [--insufficient-data-action <Webhook URL>]
                              [--time-constraint <Time Constraint>]
                              [--repeat-actions {True|False}]
                              [--query <QUERY>]
                              [--comparison-operator <OPERATOR>]
                              [--evaluation-periods <EVAL_PERIODS>]
                              [--threshold <THRESHOLD>]
                              [--event-type <EVENT_TYPE>]
                              [--granularity <GRANULARITY>]
                              [--aggregation-method <AGGR_METHOD>]
                              [--metric <METRIC>]
                              [--resource-type <RESOURCE_TYPE>]
                              [--resource-id <RESOURCE_ID>]
                              [--composite-rule <COMPOSITE_RULE>]
                              [<ALARM ID or NAME>]

表7.47 位置引数

サマリー

<ALARM ID または NAME>

アラームの ID または名前。

表7.48 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--name <NAME>

アラームの名前

-t <TYPE>, --type <TYPE>

アラームのタイプ:event、composite、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold のいずれかです。

--project-id <PROJECT_ID>

アラームに関連付けるプロジェクト(管理ユーザーだけが設定可能)

--user-id <USER_ID>

アラームに関連付けるユーザー(管理ユーザーだけが設定可能)

--description <DESCRIPTION>

アラームのフリーテキストの説明

--state <STATE>

アラームの状態。以下のいずれか:[ok, alarm, insufficient data]

--severity <SEVERITY>

アラームの重大度。以下のいずれか [low, moderate,critical]

--enabled {True

False}

アラーム評価が有効な場合は true。

--alarm-action <Webhook URL>

状態がalarmに切り替わったときに呼び出す URL。複数回使用できます。

--ok-action <Webhook URL>

状態が ok に切り替わったときに呼び出す URL。複数回使用できます。

--insufficient-data-action <Webhook URL>

状態が insufficient data に切り替わったときに呼び出す URL。複数回の使用が可能です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]] です。

--repeat-actions {True

False}

アラームがターゲット状態にある時にアクションを繰り返し通知する場合は True

表7.49 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表7.50 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表7.51 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表7.52 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

表7.53 common alarm rules

サマリー

--query <QUERY>

アラームのイベントタイプ: key[op]data_type::value; list。data_type はオプションですが、指定する場合には、文字列、整数、浮動またはブール型にする必要があります。gnocchi_aggregation_by_resources_threshold タイプのアラーム: {"and": [{"=": {"ended_at": null}}, …​]} のように、複雑なクエリー json 文字列を指定する必要があります。

--comparison-operator <OPERATOR>

比較するオペレーター:[lt,le,eq,ne,ge,gt] のいずれか。

--evaluation-periods <EVAL_PERIODS>

評価する期間の数

--threshold <THRESHOLD>

評価するしきい値。

表7.54 event alarm

サマリー

--event-type <EVENT_TYPE>

評価対象のイベントタイプ

表7.55 common gnocchi alarm rules

サマリー

--granularity <GRANULARITY>

クエリーを行う時間範囲(秒単位)。

--aggregation-method <AGGR_METHOD>

しきい値と比較する aggregation_method

--metric <METRIC>, --metrics <METRIC>

アラームタイプに応じたメトリック ID または名前

表7.56 gnocchi resource threshold alarm

サマリー

--resource-type <RESOURCE_TYPE>

リソースのタイプ。

--resource-id <RESOURCE_ID>

リソースの ID。

表7.57 composite alarm

サマリー

--composite-rule <COMPOSITE_RULE>

Json 形式の複合しきい値ルール。形式として、"and"や"or" で gnocchi ルールを組み合わせた、ネスト化ディクショナリーを指定できます。形式例: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}。

第8章 アラーム

本章では、alarming コマンドに含まれるコマンドについて説明します。

8.1. alarming capabilities list

アラームサービスの機能を一覧表示します。

使用方法

openstack alarming capabilities list [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]

表8.1 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表8.2 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表8.3 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表8.4 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表8.5 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第9章 application

本章では、application コマンドに含まれるコマンドについて説明します。

9.1. application credential create

新規アプリケーション認証情報を作成します。

使用方法

openstack application credential create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--secret <secret>]
                                               [--role <role>]
                                               [--expiration <expiration>]
                                               [--description <description>]
                                               [--unrestricted] [--restricted]
                                               <name>

表9.1 位置引数

サマリー

<name>

アプリケーション認証情報の名前

表9.2 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--secret <secret>

認証に使用するシークレット(指定されていない場合は、生成されます)。

--role <role>

承認するロール (名前または ID) (複数の値を設定する場合はオプションを繰り返し使用します)

--expiration <expiration>

アプリケーション認証情報の有効期限を設定します。形式は YYYY-mm-ddTHH:MM:SS です(指定されていない場合、アプリケーション認証情報は失効しません)。

--description <description>

アプリケーション認証情報の説明

--unrestricted

アプリケーション認証情報を有効にして、他のアプリケーション認証情報および信頼を作成し、削除します(これはリスクを伴う可能性のある動作であるため、デフォルトで無効にされます)。

--restricted

アプリケーション認証情報が他のアプリケーション認証情報および信頼を作成したり、削除したりできないようにします(これはデフォルトの動作です)。

表9.3 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.4 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表9.5 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表9.6 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

9.2. application credential delete

アプリケーション認証情報を削除します。

使用方法

openstack application credential delete [-h]
                                               <application-credential>
                                               [<application-credential> ...]

表9.7 位置引数

サマリー

<application-credential>

削除するアプリケーション認証情報(名前または ID)

表9.8 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

9.3. application credential list

アプリケーション認証情報を一覧表示します。

使用方法

openstack application credential list [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--noindent]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--sort-column SORT_COLUMN]
                                             [--user <user>]
                                             [--user-domain <user-domain>]

表9.9 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--user <user>

一覧表示するアプリケーション認証情報(名前または ID)

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

表9.10 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表9.11 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表9.12 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表9.13 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

9.4. application credential show

アプリケーション認証情報の詳細を表示します。

使用方法

openstack application credential show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <application-credential>

表9.14 位置引数

サマリー

<application-credential>

表示するアプリケーション認証情報(名前または ID)

表9.15 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表9.16 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.17 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表9.18 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表9.19 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第10章 availability

本章では、availability コマンドに含まれるコマンドについて説明します。

10.1. availability zone list

アベイラビリティーゾーンとそのステータスを一覧表示します。

使用方法

openstack availability zone list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--compute] [--network] [--volume]
                                        [--long]

表10.1 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--compute

コンピュートアベイラビリティーゾーンを一覧表示します。

--network

ネットワークアベイラビリティーゾーンを一覧表示します。

--volume

ボリュームのアベイラビリティーゾーンを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

表10.2 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表10.3 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表10.4 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表10.5 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第11章 baremetal

本章では、baremetal コマンドに含まれるコマンドについて説明します。

11.1. baremetal allocation create

新規ベアメタルの割り当てを作成します。

使用方法

openstack baremetal allocation create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--resource-class RESOURCE_CLASS]
                                             [--trait TRAITS]
                                             [--candidate-node CANDIDATE_NODES]
                                             [--name NAME] [--uuid UUID]
                                             [--extra <key=value>]
                                             [--wait [<time-out>]]
                                             [--node NODE]

表11.1 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--resource-class RESOURCE_CLASS

要求するリソースクラス。

--trait TRAITS

要求する特性。複数回指定できます。

--candidate-node CANDIDATE_NODES

この割り当て候補ノード。複数回指定できます。1 つ以上の指定した場合には、指定した候補ノードのみが割り当ての対象として考慮されます。

--name NAME

割り当ての一意名。

--uuid UUID

割り当ての UUID

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--wait [<time-out>]

新しい割り当てがアクティブになるまで待機します。--wait を使用する場合に割り当て失敗するとエラーが返されます。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

--node NODE

すでにデプロイされている指定ノードからこの割り当てに対応します。通常の割り当てプロセスを回避します。

表11.2 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.3 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.4 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.5 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.2. baremetal allocation delete

ベアメタル割り当ての登録を解除します。

使用方法

openstack baremetal allocation delete [-h]
                                             <allocation> [<allocation> ...]

表11.6 位置引数

サマリー

<allocation>

削除する割り当て(名前または uuid)。

表11.7 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.3. baremetal allocation list

ベアメタルの割り当てを一覧表示します。

使用方法

openstack baremetal allocation list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           [--limit <limit>]
                                           [--marker <allocation>]
                                           [--sort <key>[:<direction>]]
                                           [--node <node>]
                                           [--resource-class <resource_class>]
                                           [--state <state>]
                                           [--long | --fields <field> [<field> ...]]

表11.8 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

要求ごとに返す割り当ての最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <allocation>

Allocation uuid(以前の要求リストにある最後の割り当てなど)。この UUID の後の割り当て一覧を返します。

--sort <key>[:<direction>]

指定した割り当てフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--node <node>

このノード(名前または UUID)の割り当てのみを一覧表示します。

--resource-class <resource_class>

このリソースクラスによる割り当てのみを一覧表示します。

--state <state>

この状態の割り当てのみを一覧表示します。

--long

割り当ての詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上の割り当てフィールド。これらのフィールドのみがサーバーから取得されます。-- long が指定されている場合は使用できません。

表11.9 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.10 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.11 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.12 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.4. baremetal allocation set

ベアメタル割り当てプロパティーを設定します。

使用方法

openstack baremetal allocation set [-h] [--name <name>]
                                          [--extra <key=value>]
                                          <allocation>

表11.13 位置引数

サマリー

<allocation>

割り当ての名前または UUID

表11.14 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

割り当ての名前を設定します。

--extra <key=value>

この割り当てに設定する追加プロパティー(複数の追加プロパティーを設定するにはオプションを繰り返し使用します。)

11.5. baremetal allocation show

ベアメタルの割り当ての詳細を表示します。

使用方法

openstack baremetal allocation show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--fields <field> [<field> ...]]
                                           <id>

表11.15 位置引数

サマリー

<id>

割り当ての UUID または名前

表11.16 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上の割り当てフィールド。これらのフィールドのみがサーバーから取得されます。

表11.17 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.18 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.19 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.20 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.6. baremetal allocation unset

ベアメタル割り当てプロパティーの設定を解除します。

使用方法

openstack baremetal allocation unset [-h] [--name] [--extra <key>]
                                            <allocation>

表11.21 位置引数

サマリー

<allocation>

割り当ての名前または UUID

表11.22 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--name

割り当て名の設定を解除します。

--extra <key>

このベアメタル割り当ての設定を解除する追加のプロパティー(複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します)

11.7. baremetal chassis create

新しいシャーシを作成します。

使用方法

openstack baremetal chassis create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--description <description>]
                                          [--extra <key=value>]
                                          [--uuid <uuid>]

表11.23 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

シャーシの説明

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--uuid <uuid>

シャーシの一意の UUID

表11.24 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.25 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.26 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.27 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.8. baremetal chassis delete

シャーシを削除します。

使用方法

openstack baremetal chassis delete [-h] <chassis> [<chassis> ...]

表11.28 位置引数

サマリー

<chassis>

削除するシャーシの UUID

表11.29 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.9. ベアメタルシャーシの一覧

シャーシを一覧表示します。

使用方法

openstack baremetal chassis list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--fields <field> [<field> ...]]
                                        [--limit <limit>] [--long]
                                        [--marker <chassis>]
                                        [--sort <key>[:<direction>]]

表11.30 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のシャーシフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

--limit <limit>

要求ごとに返すシャーシの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--long

シャーシに関する詳細情報を表示します。

--marker <chassis>

シャーシ uuid(以前の要求リストにある最後のシャーシなど)。この UUID の後にシャーシの一覧を返します。

--sort <key>[:<direction>]

指定したシャシーフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

表11.31 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.32 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.33 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.34 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.10. baremetal chassis set

シャーシのプロパティーを設定します。

使用方法

openstack baremetal chassis set [-h] [--description <description>]
                                       [--extra <key=value>]
                                       <chassis>

表11.35 位置引数

サマリー

<chassis>

シャーシの UUID

表11.36 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

シャーシの説明を設定します。

--extra <key=value>

このシャーシに設定する追加項目(複数の追加項目を設定する場合は、オプションを繰り返し使用します。)

11.11. baremetal chassis show

シャーシの詳細を表示します。

使用方法

openstack baremetal chassis show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--fields <field> [<field> ...]]
                                        <chassis>

表11.37 位置引数

サマリー

<chassis>

シャーシの UUID

表11.38 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のシャーシフィールド。これらのフィールドのみがサーバーから取得されます。

表11.39 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.40 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.41 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.42 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.12. baremetal chassis unset

シャーシのプロパティーの設定を解除します。

使用方法

openstack baremetal chassis unset [-h] [--description] [--extra <key>]
                                         <chassis>

表11.43 位置引数

サマリー

<chassis>

シャーシの UUID

表11.44 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--description

シャーシの説明を消去します。

--extra <key>

このシャーシの設定を解除する追加項目(複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。)

11.13. baremetal conductor list

ベアメタルコンダクターを一覧表示します。

使用方法

openstack baremetal conductor list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          [--limit <limit>]
                                          [--marker <conductor>]
                                          [--sort <key>[:<direction>]]
                                          [--long | --fields <field> [<field> ...]]

表11.45 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

要求ごとに返すコンダクターの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <conductor>

コンダクターのホスト名(例:以前の要求リストにある最後のコンダクター)。このコンダクターの後にコンダクターの一覧を返します。

--sort <key>[:<direction>]

指定したコンダクターフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--long

コンダクターに関する詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のコンダクターフィールド。これらのフィールドのみがサーバーから取得されます。-- long が指定されている場合は使用できません。

表11.46 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.47 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.48 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.49 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.14. baremetal conductor show

ベアメタルコンダクターの詳細を表示します。

使用方法

openstack baremetal conductor show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--fields <field> [<field> ...]]
                                          <conductor>

表11.50 位置引数

サマリー

<conductor>

コンダクターのホスト名

表11.51 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のコンダクターフィールド。これらのフィールドのみがサーバーから取得されます。

表11.52 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.53 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.54 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.55 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.15. baremetal create

ファイルからのリソースを作成します。

使用方法

openstack baremetal create [-h] <file> [<file> ...]

表11.56 位置引数

サマリー

<file>

作成するリソースの説明が記載されているファイル(.yaml または .json)。複数回指定できます。

表11.57 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.16. baremetal deploy template create

新規デプロイテンプレートを作成します。

使用方法

openstack baremetal deploy template create [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--uuid <uuid>]
                                                  [--extra <key=value>]
                                                  --steps <steps>
                                                  <name>

表11.58 位置引数

サマリー

<name>

このデプロイテンプレートの一意名。有効な特性名である必要があります。

表11.59 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--uuid <uuid>

デプロイテンプレートの UUID

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--steps <steps>

Json 形式のデプロイ手順。デプロイ手順が含まれるファイルへのパス、- (デプロイ手順が標準入力から読み取る)、または文字列になります。値は deploy-step ディクショナリーの一覧である必要があります。各ディクショナリーには、interfacestepargs および priority が必要です。

表11.60 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.61 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.62 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.63 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.17. baremetal deploy template delete

デプロイテンプレートを削除します。

使用方法

openstack baremetal deploy template delete [-h]
                                                  <template> [<template> ...]

表11.64 位置引数

サマリー

<template>

削除するデプロイテンプレートの名前または UUID。

表11.65 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.18. baremetal deploy template list

ベアメタルのデプロイテンプレートを一覧表示します。

使用方法

openstack baremetal deploy template list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--noindent]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                [--limit <limit>]
                                                [--marker <template>]
                                                [--sort <key>[:<direction>]]
                                                [--long | --fields <field> [<field> ...]]

表11.66 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

要求ごとに返すデプロイテンプレートの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <template>

DeployTemplate uuid(以前の要求リストにある最後のデプロイテンプレートなど)この UUID の後にデプロイテンプレートの一覧を返します。

--sort <key>[:<direction>]

指定したデプロイテンプレートフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--long

デプロイテンプレートに関する詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のデプロイテンプレートフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

表11.67 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.68 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.69 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.70 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.19. baremetal deploy template set

ベアメタルのデプロイテンプレートプロパティーを設定します。

使用方法

openstack baremetal deploy template set [-h] [--name <name>]
                                               [--steps <steps>]
                                               [--extra <key=value>]
                                               <template>

表11.71 位置引数

サマリー

<template>

デプロイテンプレートの名前または UUID

表11.72 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

デプロイテンプレートの一意名を設定します。有効な特性名である必要があります。

--steps <steps>

Json 形式のデプロイ手順。デプロイ手順が含まれるファイルへのパス、- (デプロイ手順が標準入力から読み取る)、または文字列になります。値は deploy-step ディクショナリーの一覧である必要があります。各ディクショナリーには、interfacestepargs および priority が必要です。

--extra <key=value>

このベアメタルデプロイテンプレートに設定する追加項目(複数の追加項目を設定する場合は、オプションを繰り返し使用します。)

11.20. baremetal deploy template show

ベアメタルのデプロイテンプレートの詳細を表示します。

使用方法

openstack baremetal deploy template show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--fields <field> [<field> ...]]
                                                <template>

表11.73 位置引数

サマリー

<template>

デプロイテンプレートの名前または UUID。

表11.74 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のデプロイテンプレートフィールド。これらのフィールドのみがサーバーから取得されます。

表11.75 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.76 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.77 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.78 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.21. baremetal deploy template unset

ベアメタルのデプロイテンプレートプロパティーの設定を解除します。

使用方法

openstack baremetal deploy template unset [-h] [--extra <key>]
                                                 <template>

表11.79 位置引数

サマリー

<template>

デプロイテンプレートの名前または UUID

表11.80 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--extra <key>

このベアメタルデプロイテンプレートの設定を解除する追加項目(複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。)

11.22. baremetal driver list

有効なドライバーを一覧表示します。

使用方法

openstack baremetal driver list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--type <type>] [--long]

表11.81 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--type <type>

ドライバーのタイプ(「classic」または「dynamic」)。デフォルトでは、すべてのドライバーが一覧表示されます。

--long

ドライバーに関する詳細情報を表示します。

表11.82 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.83 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.84 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.85 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.23. baremetal driver passthru call

ドライバーのベンダーパススルーメソッドを呼び出します。

使用方法

openstack baremetal driver passthru call [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--arg <key=value>]
                                                [--http-method <http-method>]
                                                <driver> <method>

表11.86 位置引数

サマリー

<driver>

ドライバーの名前。

<method>

呼び出すベンダーパススルーメソッド

表11.87 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--arg <key=value>

Passthru メソッドに渡す引数(複数の引数を指定する場合は、オプションを繰り返し使用します)。

--http-method <http-method>

パススルー要求で使用する http メソッド。DELETE、GET、PATCH、POST、PUT のいずれか。デフォルトは POST です。

表11.88 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.89 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.90 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.91 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.24. baremetal driver passthru list

ドライバーで利用可能なベンダーパススルー方法を一覧表示します。

使用方法

openstack baremetal driver passthru list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--noindent]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                <driver>

表11.92 位置引数

サマリー

<driver>

ドライバーの名前。

表11.93 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表11.94 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.95 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.96 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.97 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.25. baremetal driver property list

ドライバープロパティーを一覧表示します。

使用方法

openstack baremetal driver property list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--noindent]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                <driver>

表11.98 位置引数

サマリー

<driver>

ドライバーの名前。

表11.99 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表11.100 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.101 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.102 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.103 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.26. baremetal driver raid property list

ドライバーの RAID 論理ネットワークプロパティーを一覧表示します。

使用方法

openstack baremetal driver raid property list [-h]
                                                     [-f {csv,json,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--quote {all,minimal,none,nonnumeric}]
                                                     [--noindent]
                                                     [--max-width <integer>]
                                                     [--fit-width]
                                                     [--print-empty]
                                                     [--sort-column SORT_COLUMN]
                                                     <driver>

表11.104 位置引数

サマリー

<driver>

ドライバーの名前。

表11.105 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表11.106 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.107 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.108 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.109 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.27. baremetal driver show

ドライバーに関する情報を表示します。

使用方法

openstack baremetal driver show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <driver>

表11.110 位置引数

サマリー

<driver>

ドライバーの名前。

表11.111 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表11.112 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.113 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.114 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.115 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.28. baremetal introspection abort

ノードのイントロスペクションの実行を中止します。

使用方法

openstack baremetal introspection abort [-h] node

表11.116 位置引数

サマリー

node

ベアメタルノードの uuid または名前

表11.117 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.29. baremetal introspection data save

未加工のイントロスペクションデータを保存または表示します。

使用方法

openstack baremetal introspection data save [-h] [--file <filename>]
                                                   node

表11.118 位置引数

サマリー

node

ベアメタルノードの uuid または名前

表11.119 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--file <filename>

ダウンロードするイントロスペクションデータのファイル名(デフォルト:stdout)

11.30. baremetal introspection interface list

接続されたスイッチポート情報を含むインターフェースデータを一覧表示します。

使用方法

openstack baremetal introspection interface list [-h]
                                                        [-f {csv,json,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--quote {all,minimal,none,nonnumeric}]
                                                        [--noindent]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--sort-column SORT_COLUMN]
                                                        [--vlan VLAN]
                                                        [--long | --fields <field> [<field> ...]]
                                                        node_ident

表11.120 位置引数

サマリー

node_ident

ベアメタルノードの uuid または名前

表11.121 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--vlan VLAN

この vlan ID 用に設定されたインターフェースのみを一覧表示します。繰り返し使用できます。

--long

インターフェースに関する詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のフィールドを表示します。-- long が指定されている場合は使用できません。

表11.122 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.123 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.124 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.125 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.31. baremetal introspection interface show

接続されたスイッチポート情報が含まれるインターフェースデータを表示します。

使用方法

openstack baremetal introspection interface show [-h]
                                                        [-f {json,shell,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--noindent]
                                                        [--prefix PREFIX]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--fields <field> [<field> ...]]
                                                        node_ident interface

表11.126 位置引数

サマリー

node_ident

ベアメタルノードの uuid または名前

interface

インターフェース名

表11.127 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のフィールドを表示します。

表11.128 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.129 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.130 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.131 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.32. baremetal introspection list

イントロスペクションのステータスを一覧表示します。

使用方法

openstack baremetal introspection list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              [--marker MARKER]
                                              [--limit LIMIT]

表11.132 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--marker MARKER

前のページにある最後の項目の UUID

--limit LIMIT

返す項目数

表11.133 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.134 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.135 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.136 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.33. baremetal introspection reprocess

保存されたイントロスペクションデータを再処理します。

使用方法

openstack baremetal introspection reprocess [-h] node

表11.137 位置引数

サマリー

node

ベアメタルノードの uuid または名前

表11.138 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.34. baremetal introspection rule delete

イントロスペクションルールを削除します。

使用方法

openstack baremetal introspection rule delete [-h] uuid

表11.139 位置引数

サマリー

uuid

ルールの uuid

表11.140 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.35. baremetal introspection rule import

JSON/YAML ファイルから 1 つまたは複数のイントロスペクションルールをインポートします。

使用方法

openstack baremetal introspection rule import [-h]
                                                     [-f {csv,json,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--quote {all,minimal,none,nonnumeric}]
                                                     [--noindent]
                                                     [--max-width <integer>]
                                                     [--fit-width]
                                                     [--print-empty]
                                                     [--sort-column SORT_COLUMN]
                                                     file

表11.141 位置引数

サマリー

file

インポートする JSON または yaml ファイル。1 つまたは複数のルールを含めることができます。

表11.142 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表11.143 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.144 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.145 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.146 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.36. baremetal introspection rule list

全イントロスペクションルールを一覧表示します。

使用方法

openstack baremetal introspection rule list [-h]
                                                   [-f {csv,json,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--quote {all,minimal,none,nonnumeric}]
                                                   [--noindent]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--sort-column SORT_COLUMN]

表11.147 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表11.148 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.149 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.150 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.151 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.37. baremetal introspection rule purge

すべてのイントロスペクションルールを破棄します。

使用方法

openstack baremetal introspection rule purge [-h]

表11.152 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.38. baremetal introspection rule show

イントロスペクションルールを表示します。

使用方法

openstack baremetal introspection rule show [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   uuid

表11.153 位置引数

サマリー

uuid

ルールの uuid

表11.154 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表11.155 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.156 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.157 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.158 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.39. baremetal introspection start

イントロスペクションを開始します。

使用方法

openstack baremetal introspection start [-h]
                                               [-f {csv,json,table,value,yaml}]
                                               [-c COLUMN]
                                               [--quote {all,minimal,none,nonnumeric}]
                                               [--noindent]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--sort-column SORT_COLUMN]
                                               [--wait] [--check-errors]
                                               node [node ...]

表11.159 位置引数

サマリー

node

ベアメタルノードの uuid または名前

表11.160 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--wait

イントロスペクションが完了するまで待機します。結果は最後に表示されます。

--check-errors

イントロスペクション中にエラーが発生しているかどうかを確認します。エラーが発生した場合は、エラーのみが表示されます。--wait と併用しないと使用できません。

表11.161 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.162 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.163 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.164 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.40. baremetal introspection status

イントロスペクションのステータスを取得します。

使用方法

openstack baremetal introspection status [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                node

表11.165 位置引数

サマリー

node

ベアメタルノードの uuid または名前

表11.166 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表11.167 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.168 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.169 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.170 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.41. baremetal node abort

ベアメタルノードのプロビジョニング状態を abort に設定します。

使用方法

openstack baremetal node abort [-h] <node>

表11.171 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.172 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.42. baremetal node add trait

ノードに特性を追加します。

使用方法

openstack baremetal node add trait [-h] <node> <trait> [<trait> ...]

表11.173 位置引数

サマリー

<node>

ノードの名前または UUID

<trait>

追加する特性

表11.174 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.43. baremetal node adopt

ベアメタルノードのプロビジョニング状態を adopt に設定します。

使用方法

openstack baremetal node adopt [-h] [--wait [<time-out>]] <node>

表11.175 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.176 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.44. baremetal node bios setting list

ノードの BIOS 設定を一覧表示します。

使用方法

openstack baremetal node bios setting list [-h]
                                                  [-f {csv,json,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--quote {all,minimal,none,nonnumeric}]
                                                  [--noindent]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--sort-column SORT_COLUMN]
                                                  <node>

表11.177 位置引数

サマリー

<node>

ノードの名前または UUID

表11.178 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表11.179 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.180 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.181 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.182 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.45. baremetal node bios setting show

ノードの特定の BIOS 設定を表示します。

使用方法

openstack baremetal node bios setting show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  <node> <setting name>

表11.183 位置引数

サマリー

<node>

ノードの名前または UUID

<setting name>

表示する名前の設定

表11.184 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表11.185 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.186 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.187 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.188 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.46. baremetal node boot device set

ノードのブートデバイスを設定します。

使用方法

openstack baremetal node boot device set [-h] [--persistent]
                                                <node> <device>

表11.189 位置引数

サマリー

<node>

ノードの名前または UUID

<device>

Bios、cdrom、disk、pxe、safe、wanboot のいずれか

表11.190 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--persistent

今後の起動時にすべての変更を永続化します。

11.47. baremetal node boot device show

ノードのブートデバイス情報を表示します。

使用方法

openstack baremetal node boot device show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--supported]
                                                 <node>

表11.191 位置引数

サマリー

<node>

ノードの名前または UUID

表11.192 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--supported

サポート対象のブートデバイスを表示します。

表11.193 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.194 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.195 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.196 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.48. baremetal node clean

ベアメタルノードのプロビジョニング状態を clean に設定します。

使用方法

openstack baremetal node clean [-h] [--wait [<time-out>]] --clean-steps
                                      <clean-steps>
                                      <node>

表11.197 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.198 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

--clean-steps <clean-steps>

Json 形式の消去手順。消去手順が含まれるファイルへのパス、- (消去手順が標準入力から読み取る)、または文字列になります。値は clean-step ディクショナリーの一覧である必要があります。各ディクショナリーには、キーの interface および step、任意のキーの args が必要です。

11.49. baremetal node console disable

ノードのコンソールアクセスを無効化します。

使用方法

openstack baremetal node console disable [-h] <node>

表11.199 位置引数

サマリー

<node>

ノードの名前または UUID

表11.200 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.50. baremetal node console enable

ノードのコンソールアクセスを有効化します。

使用方法

openstack baremetal node console enable [-h] <node>

表11.201 位置引数

サマリー

<node>

ノードの名前または UUID

表11.202 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.51. baremetal node console show

ノードのコンソール情報を表示します。

使用方法

openstack baremetal node console show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <node>

表11.203 位置引数

サマリー

<node>

ノードの名前または UUID

表11.204 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表11.205 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.206 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.207 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.208 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.52. baremetal node create

新規ノードを baremetal サービスに登録します。

使用方法

openstack baremetal node create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--chassis-uuid <chassis>] --driver
                                       <driver> [--driver-info <key=value>]
                                       [--property <key=value>]
                                       [--extra <key=value>] [--uuid <uuid>]
                                       [--name <name>]
                                       [--bios-interface <bios_interface>]
                                       [--boot-interface <boot_interface>]
                                       [--console-interface <console_interface>]
                                       [--deploy-interface <deploy_interface>]
                                       [--inspect-interface <inspect_interface>]
                                       [--management-interface <management_interface>]
                                       [--network-interface <network_interface>]
                                       [--power-interface <power_interface>]
                                       [--raid-interface <raid_interface>]
                                       [--rescue-interface <rescue_interface>]
                                       [--storage-interface <storage_interface>]
                                       [--vendor-interface <vendor_interface>]
                                       [--resource-class <resource_class>]
                                       [--conductor-group <conductor_group>]
                                       [--automated-clean] [--owner <owner>]
                                       [--description <description>]

表11.209 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--chassis-uuid <chassis>

このノードが属するシャーシの UUID。

--driver <driver>

ノードの制御に使用されるドライバー [必須]。

--driver-info <key=value>

アウトバウンド管理認証情報など、ドライバーが使用するキー/値のペア。複数回指定できます。

--property <key=value>

ノードの物理的な特性を記述するキー/値のペア。これは Nova にエクスポートされ、スケジューラーが使用します。複数回指定できます。

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--uuid <uuid>

ノードの一意の UUID。

--name <name>

ノードの一意名。

--bios-interface <bios_interface>

ノードのドライバーで使用される BIOS インターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--boot-interface <boot_interface>

ノードのドライバーで使用される起動インターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--console-interface <console_interface>

ノードのドライバーで使用されるコンソールインターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--deploy-interface <deploy_interface>

ノードのドライバーで使用されるデプロイインターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--inspect-interface <inspect_interface>

ノードのドライバーで使用されるインスペクトインターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--management-interface <management_interface>

ノードのドライバーで使用される管理インターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--network-interface <network_interface>

クリーニング/プロビジョニングネットワークへのノードの切り替えに使用するネットワークインターフェース

--power-interface <power_interface>

ノードのドライバーで使用される電源インターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--raid-interface <raid_interface>

ノードのドライバーで使用される RAID インターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--rescue-interface <rescue_interface>

ノードのドライバーで使用されるレスキューインターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--storage-interface <storage_interface>

ノードのドライバーが使用するストレージインターフェース。

--vendor-interface <vendor_interface>

ノードのドライバーで使用されるベンダーインターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--resource-class <resource_class>

ノードを nova フレーバーにマッピングするためのリソースクラス

--conductor-group <conductor_group>

ノードが所属するコンダクターグループ

--automated-clean

ノードの自動クリーニングを有効化します。

--owner <owner>

ノードの所有者。

--description <description>

ノードの説明。

表11.210 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.211 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.212 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.213 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.53. baremetal node delete

ベアメタルノードの登録を解除します。

使用方法

openstack baremetal node delete [-h] <node> [<node> ...]

表11.214 位置引数

サマリー

<node>

削除するノード(名前または uuid)

表11.215 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.54. baremetal node deploy

ベアメタルノードのプロビジョニングの状態を deploy に設定します。

使用方法

openstack baremetal node deploy [-h] [--wait [<time-out>]]
                                       [--config-drive <config-drive>]
                                       <node>

表11.216 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.217 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

--config-drive <config-drive>

Gzipped, base64 でエンコードされたコンフィグドライブの文字列、またはコンフィグドライブファイルへのパス、コンフィグドライブファイルが含まれるパス、コンフィグドライブのビルド元の JSON オブジェクト。ディレクトリーの場合には、コンフィグドライブはそのディレクトリーで生成されます。JSON オブジェクトに、オプションのキー meta_data、user_data、および network_data が指定されている場合には、コンフィグドライブがサーバー側で生成されます(詳細は、ベアメタル API のリファレンス を参照)。

11.55. baremetal node inject nmi

NMI をベアメタルノードに注入します。

使用方法

openstack baremetal node inject nmi [-h] <node>

表11.218 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.219 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.56. baremetal node inspect

ベアメタルノードのプロビジョニング状態を inspect に設定します。

使用方法

openstack baremetal node inspect [-h] [--wait [<time-out>]] <node>

表11.220 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.221 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.57. baremetal node list

ベアメタルノードを一覧表示します。

使用方法

openstack baremetal node list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--limit <limit>] [--marker <node>]
                                     [--sort <key>[:<direction>]]
                                     [--maintenance | --no-maintenance]
                                     [--fault <fault>]
                                     [--associated | --unassociated]
                                     [--provision-state <provision state>]
                                     [--driver <driver>]
                                     [--resource-class <resource class>]
                                     [--conductor-group <conductor_group>]
                                     [--conductor <conductor>]
                                     [--chassis <chassis UUID>]
                                     [--owner <owner>]
                                     [--description-contains <description_contains>]
                                     [--long | --fields <field> [<field> ...]]

表11.222 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

要求ごとに返すノードの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <node>

ノードの uuid(例:以前の要求リストにある最後のノード)。UUID の後にノードの一覧を返します。

--sort <key>[:<direction>]

指定したノードフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--maintenance

メンテナンスモードのノードだけにリストを制限します。

--no-maintenance

メンテナンスモード以外のノードだけにリストを制限します。

--fault <fault>

指定した障害でが発生しているノードを一覧表示します。

--associated

インスタンスに関連付けられているノードのみを一覧表示します。

--unassociated

インスタンスに関連付けられていないノードのみを一覧表示します。

--provision-state <provision state>

指定したプロビジョニング状態のノードを一覧表示します。

--driver <driver>

ドライバーが <driver> のノードのみに一覧を制限します。

--resource-class <resource class>

リソースクラスが <resource class> のノードのみに一覧を制限します。

--conductor-group <conductor_group>

コンダクターグループが <conductor group> のノードのみに一覧を制限します。

--conductor <conductor>

コンダクターが <conductor> のノードのみに一覧を制限します。

--chassis <chassis UUID>

このシャーシのノードのみに一覧を制限します。

--owner <owner>

所有者が <owner> のノードのみに一覧を制限します。

--description-contains <description_contains>

説明に <description_contains> が含まれるノードのみに一覧を制限します。

--long

ノードの詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のノードフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

表11.223 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.224 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.225 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.226 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.58. baremetal node maintenance set

ベアメタルノードをメンテナンスモードに設定します。

使用方法

openstack baremetal node maintenance set [-h] [--reason <reason>]
                                                <node>

表11.227 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.228 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--reason <reason>

メンテナンスモードを設定する理由。

11.59. baremetal node maintenance unset

メンテナンスモードのベアメタルノードの設定を解除します。

使用方法

openstack baremetal node maintenance unset [-h] <node>

表11.229 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.230 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

11.60. baremetal node manage

ベアメタルノードのプロビジョニングの状態を manage に設定します。

使用方法

openstack baremetal node manage [-h] [--wait [<time-out>]] <node>

表11.231 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.232 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.61. baremetal node passthru call

ノードのベンダーパススルーメソッドを呼び出します。

使用方法

openstack baremetal node passthru call [-h] [--arg <key=value>]
                                              [--http-method <http-method>]
                                              <node> <method>

表11.233 位置引数

サマリー

<node>

ノードの名前または UUID

<method>

実行するベンダーパススルーメソッド

表11.234 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--arg <key=value>

Passthru メソッドに渡す引数(複数の引数を指定する場合は、オプションを繰り返し使用します)。

--http-method <http-method>

パススルー要求で使用する http メソッド。DELETE、GET、PATCH、POST、PUT のいずれか。デフォルトは POST です。

11.62. baremetal node passthru list

ノードのベンダーパススルー方法を一覧表示します。

使用方法

openstack baremetal node passthru list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              <node>

表11.235 位置引数

サマリー

<node>

ノードの名前または UUID

表11.236 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表11.237 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.238 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.239 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.240 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.63. baremetal node power off

ノードの電源をオフにします。

使用方法

openstack baremetal node power off [-h]
                                          [--power-timeout <power-timeout>]
                                          [--soft]
                                          <node>

表11.241 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.242 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--power-timeout <power-timeout>

エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間(秒単位、正の整数)。

--soft

正常な電源オフを要求します。

11.64. baremetal node power on

ノードの電源をオンにします。

使用方法

openstack baremetal node power on [-h]
                                         [--power-timeout <power-timeout>]
                                         <node>

表11.243 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.244 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--power-timeout <power-timeout>

エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間(秒単位、正の整数)。

11.65. baremetal node provide

ベアメタルノードのプロビジョニングの状態を provide に設定します。

使用方法

openstack baremetal node provide [-h] [--wait [<time-out>]] <node>

表11.245 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.246 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態(available)に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.66. baremetal node reboot

ベアメタルノードを再起動します。

使用方法

openstack baremetal node reboot [-h] [--soft]
                                       [--power-timeout <power-timeout>]
                                       <node>

表11.247 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.248 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--soft

正常な再起動を要求します。

--power-timeout <power-timeout>

エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間(秒単位、正の整数)。

11.67. baremetal node rebuild

ベアメタルノードのプロビジョニングの状態を rebuild に設定します。

使用方法

openstack baremetal node rebuild [-h] [--wait [<time-out>]]
                                        [--config-drive <config-drive>]
                                        <node>

表11.249 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.250 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

--config-drive <config-drive>

Gzipped, base64 でエンコードされたコンフィグドライブの文字列、またはコンフィグドライブファイルへのパス、コンフィグドライブファイルが含まれるパス、コンフィグドライブのビルド元の JSON オブジェクト。ディレクトリーの場合には、コンフィグドライブはそのディレクトリーで生成されます。JSON オブジェクトに、オプションのキー meta_data、user_data、および network_data が指定されている場合には、コンフィグドライブがサーバー側で生成されます(詳細は、ベアメタル API のリファレンス を参照)。

11.68. baremetal node remove trait

ノードから特性を削除します。

使用方法

openstack baremetal node remove trait [-h] [--all]
                                             <node> [<trait> [<trait> ...]]

表11.251 位置引数

サマリー

<node>

ノードの名前または UUID

<trait>

削除する特性

表11.252 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--all

すべての特性を削除します。

11.69. baremetal node rescue

ベアメタルノードのプロビジョニングの状態を rescue に設定します。

使用方法

openstack baremetal node rescue [-h] [--wait [<time-out>]]
                                       --rescue-password <rescue-password>
                                       <node>

表11.253 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.254 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (rescue) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

--rescue-password <rescue-password>

Rescue ramdisk へのログインに使用するパスワード。値は空でない文字列である必要があります。

11.70. baremetal node set

ベアメタルのプロパティを設定します。

使用方法

openstack baremetal node set [-h] [--instance-uuid <uuid>]
                                    [--name <name>]
                                    [--chassis-uuid <chassis UUID>]
                                    [--driver <driver>]
                                    [--bios-interface <bios_interface> | --reset-bios-interface]
                                    [--boot-interface <boot_interface> | --reset-boot-interface]
                                    [--console-interface <console_interface> | --reset-console-interface]
                                    [--deploy-interface <deploy_interface> | --reset-deploy-interface]
                                    [--inspect-interface <inspect_interface> | --reset-inspect-interface]
                                    [--management-interface <management_interface> | --reset-management-interface]
                                    [--network-interface <network_interface> | --reset-network-interface]
                                    [--power-interface <power_interface> | --reset-power-interface]
                                    [--raid-interface <raid_interface> | --reset-raid-interface]
                                    [--rescue-interface <rescue_interface> | --reset-rescue-interface]
                                    [--storage-interface <storage_interface> | --reset-storage-interface]
                                    [--vendor-interface <vendor_interface> | --reset-vendor-interface]
                                    [--reset-interfaces]
                                    [--resource-class <resource_class>]
                                    [--conductor-group <conductor_group>]
                                    [--automated-clean] [--protected]
                                    [--protected-reason <protected_reason>]
                                    [--target-raid-config <target_raid_config>]
                                    [--property <key=value>]
                                    [--extra <key=value>]
                                    [--driver-info <key=value>]
                                    [--instance-info <key=value>]
                                    [--owner <owner>]
                                    [--description <description>]
                                    <node>

表11.255 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.256 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--instance-uuid <uuid>

ノードのインスタンスの uuid を <uuid> に設定します。

--name <name>

ノードの名前。

--chassis-uuid <chassis UUID>

ノードのシャーシを設定します。

--driver <driver>

ノードのドライバーを設定します。

--bios-interface <bios_interface>

ノードの bios インターフェースを設定します。

--reset-bios-interface

BIOS インターフェースをハードウェアタイプのデフォルトにリセットします。

--boot-interface <boot_interface>

ノードの起動インターフェースを設定します。

--reset-boot-interface

起動インターフェースをハードウェアタイプのデフォルトにリセットします。

--console-interface <console_interface>

ノードのコンソールインターフェースを設定します。

--reset-console-interface

コンソールインターフェースをハードウェアタイプのデフォルトにリセットします。

--deploy-interface <deploy_interface>

ノードのデプロイインターフェースを設定します。

--reset-deploy-interface

デプロイインターフェースをハードウェアタイプのデフォルトにリセットします。

--inspect-interface <inspect_interface>

ノードの検査インターフェースを設定します。

--reset-inspect-interface

検査インターフェースをハードウェアタイプのデフォルトにリセットします。

--management-interface <management_interface>

ノードの管理インターフェースを設定します。

--reset-management-interface

管理インターフェースをハードウェアタイプのデフォルトにリセットします。

--network-interface <network_interface>

ノードのネットワークインターフェースを設定します。

--reset-network-interface

ネットワークインターフェースをハードウェアタイプのデフォルトにリセットします。

--power-interface <power_interface>

ノードの電源インターフェースを設定します。

--reset-power-interface

電源インターフェースをハードウェアタイプのデフォルトにリセットします。

--raid-interface <raid_interface>

ノードの RAID インターフェースを設定します。

--reset-raid-interface

RAID インターフェースをハードウェアタイプのデフォルトにリセットします。

--rescue-interface <rescue_interface>

ノードのレスキューインターフェースを設定します。

--reset-rescue-interface

レスキューインターフェースをハードウェアタイプのデフォルトにリセットします。

--storage-interface <storage_interface>

ノードのストレージインターフェースを設定します。

--reset-storage-interface

ストレージインターフェースのハードウェアタイプのデフォルトにリセットします。

--vendor-interface <vendor_interface>

ノードのベンダーインターフェースを設定します。

--reset-vendor-interface

ベンダーインターフェースをハードウェアタイプのデフォルトにリセットします。

--reset-interfaces

明示的に指定されていないすべてのインターフェースをデフォルトの実装にリセットします。--driver と併用する場合のみ有効です。

--resource-class <resource_class>

ノードのリソースクラスを設定します。

--conductor-group <conductor_group>

ノードのコンダクターグループを設定します。

--automated-clean

ノードの自動クリーニングを有効化します。

--protected

ノードを「保護する」とマークします。

--protected-reason <protected_reason>

ノードを「保護する」とマークする理由を設定します。

--target-raid-config <target_raid_config>

ノードのターゲット RAID 構成(json)を設定します。これには、以下のいずれかを使用できます。1. RAID 設定の JSON データを含むファイル、2. 標準入力からコンテンツを読み取る "-"、3、有効な JSON 文字列。

--property <key=value>

このベアメタルノードに設定するプロパティー(複数のプロパティーを設定する場合はオプションを繰り返し使用します)

--extra <key=value>

このベアメタルノードに設定する追加項目(複数のプロパティーを設定する場合はオプションを繰り返し使用します)

--driver-info <key=value>

このベアメタルノードに設定するドライバー情報(複数のドライバー情報を設定する場合はオプションを繰り返し使用します)

--instance-info <key=value>

このベアメタルノードに設定するインスタンス情報(複数のインスタンス情報を設定する場合はオプションを繰り返し使用します)

--owner <owner>

ノードの所有者を設定します。

--description <description>

ノードの説明を設定します。

11.71. baremetal node show

ベアメタルノードの詳細を表示します。

使用方法

openstack baremetal node show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--instance]
                                     [--fields <field> [<field> ...]]
                                     <node>

表11.257 位置引数

サマリー

<node>

ノードの名前または uuid(または --instance が指定されている場合のインスタンスの uuid)

表11.258 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--instance

<node> はインスタンスの uuid です。

--fields <field> [<field> …​]

1 つ以上のノードフィールド。これらのフィールドのみがサーバーから取得されます。

表11.259 出力形式の設定

サマリー

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.260 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.261 Shell フォーマッター

サマリー

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.262 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.72. baremetal node trait list

ノードの特性を一覧表示します。

使用方法

openstack baremetal node trait list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           <node>

表11.263 位置引数

サマリー

<node>

ノードの名前または UUID

表11.264 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表11.265 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.266 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.267 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.268 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.73. baremetal node undeploy

ベアメタルノードのプロビジョニングの状態を deleted に設定します。

使用方法

openstack baremetal node undeploy [-h] [--wait [<time-out>]] <node>

表11.269 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.270 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態(available)に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.74. baremetal node unrescue

ベアメタルノードのプロビジョニング状態を unrescue に設定します。

使用方法

openstack baremetal node unrescue [-h] [--wait [<time-out>]] <node>

表11.271 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.272 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.75. baremetal node unset

ベアメタルプロパティーの設定を解除します。

使用方法

openstack baremetal node unset [-h] [--instance-uuid] [--name]
                                      [--resource-class]
                                      [--target-raid-config]
                                      [--property <key>] [--extra <key>]
                                      [--driver-info <key>]
                                      [--instance-info <key>] [--chassis-uuid]
                                      [--bios-interface] [--boot-interface]
                                      [--console-interface]
                                      [--deploy-interface]
                                      [--inspect-interface]
                                      [--management-interface]
                                      [--network-interface]
                                      [--power-interface] [--raid-interface]
                                      [--rescue-interface]
                                      [--storage-interface]
                                      [--vendor-interface] [--conductor-group]
                                      [--automated-clean] [--protected]
                                      [--protected-reason] [--owner]
                                      [--description]
                                      <node>

表11.273 位置引数

サマリー

<node>

ノードの名前または UUID。

表11.274 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

--instance-uuid

このベアメタルノードでのインスタンスの uuid の設定を解除します。

--name

ノードの名前の設定を解除します。

--resource-class

ノードのリソースクラスの設定を解除します。

--target-raid-config

ノードのターゲット RAID 構成の設定を解除します。

--property <key>

このベアメタルノードで設定を解除するプロパティー(複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します)

--extra <key>

このベアメタルノードの設定を追加で解除する項目(複数のプロパティーを設定する場合はオプションを繰り返し使用します)

--driver-info <key>

このベアメタルノードでの設定を解除するドライバー情報(複数のドライバー情報の設定を解除する場合はオプションを繰り返し使用します)

--instance-info <key>

このベアメタルノードでの設定を解除するインスタンス情報(複数のインスタンス情報の設定を解除する場合はオプションを繰り返し使用します)

--chassis-uuid

このベアメタルノードでのシャーシ UUID の設定を解除します。

--bios-interface

このベアメタルノードでの bios インターフェースの設定を解除します。

--boot-interface

このベアメタルノードでのブートインターフェースの設定を解除します。

--console-interface

このベアメタルノードでのコンソールインターフェースの設定を解除します。

--deploy-interface

このベアメタルノードでのデプロイインターフェースの設定を解除します。

--inspect-interface

このベアメタルノードでの検査インターフェースの設定を解除します。

--management-interface

このベアメタルノードでの管理インターフェースの設定を解除します。

--network-interface

このベアメタルノードでのネットワークインターフェースの設定を解除します。

--power-interface

このベアメタルノードの電源インターフェースの設定を解除します。

--raid-interface

このベアメタルノードでの RAID インターフェースの設定を解除します。

--rescue-interface

このベアメタルノードでのレスキューインターフェースの設定を解除します。

--storage-interface

このベアメタルノードでのストレージインターフェースの設定を解除します。

--vendor-interface

このベアメタルノードでのベンダーインターフェースの設定を解除します。

--conductor-group

このベアメタルノードのコンダクターグループの設定を解除します(デフォルトのグループが使用されます)。

--automated-clean

このベアメタルノードでの自動クリーニングの設定を解除します(設定からの値が使用されます)。

--protected

ノード上の保護フラグの設定を解除します。

--protected-reason

保護理由の設定を解除します(保護が解除されると自動的にこの設定も解除されます。)

--owner

ノードの所有者フィールドの設定を解除します。

--description

ノードの説明フィールドの設定を解除します。

11.76. baremetal node validate

ノードのドライバーインターフェースを検証します。

使用方法

openstack baremetal node validate [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]
                                         <node>

表11.275 位置引数

サマリー

<node>

ノードの名前または UUID

表11.276 その他の引数 (オプション):

サマリー

-h, --help

ヘルプメッセージを表示して終了します。

表11.277 出力形式の設定

サマリー

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.278 CSV 書式設定

サマリー

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.279 JSON 書式設定

サマリー

--noindent

Json のインデントを無効にするかどうか。

表11.280 表の書式設定

サマリー

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

<