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


Red Hat OpenStack Platform 15

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

概要

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

前書き

統合 OpenStack コマンドラインクライアントに使用できるコマンドへの参照。

第1章 OpenStack クライアント

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

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-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-username <auth-username>]
                 [--os-password <auth-password>]
                 [--os-endpoint <auth-endpoint>] [--os-token <auth-token>]
                 [--os-default-domain-id <auth-default-domain-id>]
                 [--os-default-domain-name <auth-default-domain-name>]
                 [--os-user-id <auth-user-id>]
                 [--os-user-domain-id <auth-user-domain-id>]
                 [--os-user-domain-name <auth-user-domain-name>]
                 [--os-passcode <auth-passcode>] [--os-user <auth-user>]
                 [--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-roles <auth-roles>]
                 [--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-aodh-endpoint <auth-aodh-endpoint>]
                 [--os-redirect-uri <auth-redirect-uri>]
                 [--os-code <auth-code>]
                 [--os-identity-provider-url <auth-identity-provider-url>]
                 [--os-service-provider-endpoint <auth-service-provider-endpoint>]
                 [--os-service-provider-entity-id <auth-service-provider-entity-id>]
                 [--os-url <auth-url>] [--os-access-token <auth-access-token>]

Expand
表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>

volume api version, default=2(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>

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

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

パスワードを使用した v3oidcpassword: 認証 URL の場合: v3totp を使用した認証 URL: v3oidcclientcredentials を使用する認証 URL: v3oauth1 を使用した認証 URL: v3tokenlessauth を使用した認証 URL: v3token を使用した認証 URL: v3applicationcredential を使用した認証 URL: v2password を使用した認証 URL: v3password を使用した認証 URL: v2token を使用した認証 URL: v3oidcauthcode を使用する認証 URL: v3adfspassword を使用した認証 URL: v3samlpassword を使用する認証 URL: v1password を使用する認証 URL: トークンのある認証 URL: v3oidcaccesstoken を使用する認証 URL: 認証 URL(Env): OS_AUTH_URL)

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

パスワードを持つシステム操作の v3oidcpassword: 範囲は以下のようになります。 v3totp を使用したシステム操作の範囲: v3oidcclientcredentials を使用するシステム操作の範囲: v3token を使用するシステム操作の範囲: v3applicationcredential を使用するシステム操作の範囲: v3password を使用するシステム操作の範囲: v3oidcauthcode を使用するシステム操作の範囲: v3adfspassword を使用するシステム操作の範囲: v3samlpassword を使用するシステム操作の範囲: トークンを使用するシステム操作の範囲: v3oidcaccesstoken を使用するシステム操作のスコープ。 システム操作のスコープ(Env: SYSTEM_SYSTEM_SCOPE)

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

パスワードでスコープを v3oidcpassword: domain id に置き換えます。 v3totp にバインドするドメイン ID: v3oidcclientcredentials のスコープに設定するドメイン ID: v3tokenlessauth にバインドするドメイン ID: v3token のスコープに設定するドメイン ID: v3applicationcredential のスコープに設定するドメイン ID: v3password のスコープに設定するドメイン ID: v3oidcauthcode のスコープに設定するドメイン ID: v3adfspassword のスコープに設定するドメイン ID: v3samlpassword のスコープに設定するドメイン ID: トークンのあるスコープに設定するドメイン ID: v3oidcaccesstoken のスコープに設定するドメイン ID: スコープするドメイン ID(Env: os_DOMAIN_ID)

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

パスワードスコープに v3oidcpassword: ドメイン名を指定して設定します。 v3totp にバインドするドメイン名 v3oidcclientcredentials のスコープに設定するドメイン名 v3tokenlessauth にバインドするドメイン名 With v3token にバインドするドメイン名 v3applicationcredential に適用するドメイン名 v3password のスコープに設定するドメイン名 v3oidcauthcode のスコープに設定するドメイン名: v3adfspassword のスコープに設定するドメイン名 v3samlpassword のスコープに設定するドメイン名 スコープ指定に使用するドメイン名(with token): v3oidcaccesstoken のスコープに設定するドメイン名: スコープするドメイン名(Env: Env): os_domain_name)

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

パスワードスコープに v3oidcpassword: プロジェクト ID を指定します。 v3totp にバインドするプロジェクト ID: noauth にバインドするプロジェクト ID: v3oidcclientcredentials を使用するプロジェクト ID: v3tokenlessauth のスコープに設定するプロジェクト ID: With v3token にバインドするプロジェクト ID: gnocchi-noauth のスコープに設定するプロジェクト ID: v3applicationcredential を使用したプロジェクト ID: aodh-noauth のスコープに設定するプロジェクト ID: v3password を使用したプロジェクト ID: v3oidcauthcode のスコープに設定するプロジェクト ID: v3adfspassword のスコープに設定するプロジェクト ID: v3samlpassword のスコープに設定するプロジェクト ID: With token にバインドするプロジェクト ID: V3oidcaccesstoken のスコープに設定するプロジェクト ID: スコープするプロジェクト ID(Env: os_PROJECT_ID)

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

パスワードスコープに v3oidcpassword: プロジェクト名を指定します。 スコープを v3totp に指定するプロジェクト名 スコープを指定するプロジェクト名(With v3oidcclientcredentials): v3tokenlessauth スコープに設定するプロジェクト名: With v3token にバインドするプロジェクト名: v3applicationcredential のスコープに設定するプロジェクト名 スコープを設定するプロジェクト名(With v3password): v3oidcauthcode のスコープに設定するプロジェクト名: v3adfspassword のスコープに設定するプロジェクト名: v3samlpassword のスコープに設定するプロジェクト名: スコープを指定するプロジェクト名(v1password): トークンと共に使用する Swift アカウント: Project name to scope to With v3oidcaccesstoken: スコープするプロジェクト名(Env: os_PROJECT_NAME)

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

パスワードを持つプロジェクトが含まれる v3oidcpassword: ドメイン ID に置き換えます。 プロジェクトが含まれるドメイン ID(v3totp): プロジェクトが含まれるドメイン ID(v3oidcclientcredentials): プロジェクトが含まれるドメイン ID(v3tokenlessauth): プロジェクトが含まれるドメイン ID(v3token): プロジェクトが含まれるドメイン ID(v3applicationcredential): プロジェクトが含まれるドメイン ID(v3password): プロジェクトが含まれるドメイン ID(v3oidcauthcode): プロジェクトが含まれるドメイン ID(v3adfspassword): プロジェクトが含まれるドメイン ID(v3samlpassword): トークンが含まれるプロジェクトが含まれるドメイン ID: プロジェクトが含まれるドメイン ID(v3oidcaccesstoken): プロジェクトが含まれるドメイン ID(Env: os_PROJECT_DOMAIN_ID)

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

v3oidcpassword: プロジェクトが含まれるドメイン名(password)に置き換えます。 プロジェクトが含まれるドメイン名(v3totp): プロジェクトが含まれるドメイン名(v3oidcclientcredentials): v3tokenlessauth が含まれるプロジェクトが含まれるドメイン名: v3token を含むプロジェクトが含まれるドメイン名: プロジェクトが含まれるドメイン名(v3applicationcredential): プロジェクトが含まれるドメイン名(v3password): プロジェクトが含まれるドメイン名(v3oidcauthcode): プロジェクトが含まれるドメイン名(v3adfspassword): プロジェクトが含まれるドメイン名(v3samlpassword): トークンが含まれるプロジェクトが含まれるドメイン名。 プロジェクトが含まれるドメイン名(v3oidcaccesstoken): プロジェクトが含まれるドメイン名(Env: OS_PROJECT_DOMAIN_NAME)

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

password: trust id With v3totp で、v3oidcpassword: trust id に置き換えます。 v3oidcclientcredentials を使用した信頼 ID: v3token を使用した信頼 ID: v3applicationcredential を使用した信頼 ID: v2password を使用した信頼 ID: v3password を使用した信頼 ID v2token を使用した信頼 ID: v3oidcauthcode を使用する信頼 ID: v3adfspassword を使用した信頼 ID v3samlpassword を使用した信頼 ID: トークンのある信頼 ID: v3oidcaccesstoken を使用した信頼 ID: 信頼 ID(Env: os_TRUST_ID)

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

with v3oidcpassword: identity provider's name with v3oidcclientcredentials: Identity Provider's name With v3oidcauthcode: Identity Provider's name With v3adfspassword: Identity Provider's name With v3samlpassword: Identity Provider's name With v3oidcaccesstoken: Identity Provider's name(Env: OS_IDENTITY_PROVIDER)

--os-protocol <auth-protocol>

with v3oidcpassword: protocol for federated plugin With v3oidcclientcredentials: Protocol for federated plugin With v3oidcauthcode: Protocol for federated plugin With v3adfspassword: Protocol for federated plugin With v3samlpassword: Protocol for federated plugin With v3oidcaccesstoken: Protocol for federated plugin(Env: OS_PROTOCOL)

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

with v3oidcpassword: oauth 2.0 client id with v3oidcclientcredentials: OAuth 2.0 Client ID With v3oidcauthcode: OAuth 2.0 Client ID(Env: OS_CLIENT_ID)

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

with v3oidcpassword: oauth 2.0 client secret with v3oidcclientcredentials: OAuth 2.0 Client Secret With v3oidcauthcode: OAuth 2.0 Client Secret(Env: OS_CLIENT_SECRET)

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

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

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

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

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

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

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

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

--os-username <auth-username>

with v3oidcpassword: username with password: username With v3totp: Username With v3applicationcredential: Username With v2password: Username to login with With v3password: Username With v3adfspassword: Username With v3samlpassword: Username With v1password: Username to login with(Env: OS_USERNAME)

--os-password <auth-password>

with v3oidcpassword: password with password with password: user's password With v2password: Password to use With v3password: User's password With v3adfspassword: Password With v3samlpassword: Password With v1password: Password to use(Env: OS_PASSWORD)

--os-endpoint <auth-endpoint>

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

--os-token <auth-token>

admin_token: 常に v3token: Token で認証されるトークンで、With v2token: Token With token_endpoint: Token With token: Token to authenticate with token: Token to authenticate(Env: OS_TOKEN)で認証します。

--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-user-id <auth-user-id>

password: user id with v3totp: user id with noauth: User ID With gnocchi-noauth: User ID With v3applicationcredential: User ID With aodh-noauth: User ID With v2password: With v3password: User ID(Env: OS_USER_ID)

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

password: user's domain id with v3totp: user's domain id With v3applicationcredential: User's domain id With v3password: User's domain id(Env: OS_USER_DOMAIN_ID)

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

password: ユーザーのドメイン名(v3totp: v3applicationcredential: ユーザーのドメイン名 With v3password: User's domain name With v3password: ユーザーのドメイン名(Env: OS_USER_DOMAIN_NAME)

--os-passcode <auth-passcode>

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

--os-user <auth-user>

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

--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-roles <auth-roles>

gnocchi-noauth: ロールのある gnocchi-noauth: ロールのあるロール(Env: OS_ROLES)

--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-aodh-endpoint <auth-aodh-endpoint>

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

--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-identity-provider-url <auth-identity-provider-url>

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

--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-url <auth-url>

token_endpoint: 使用する特定のサービスエンドポイント(Env: OS_URL)

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

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

第2章 access

本章では、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>

Expand
表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> に関連付けられた検証機能(必須)

Expand
表2.2 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表2.3 JSON 書式設定
概要

--noindent

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

Expand
表2.4 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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

Expand
表3.1 位置引数
概要

URI

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

Expand
表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

Expand
表3.3 位置引数
概要

URI

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

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

-h, --help

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

Expand
表3.5 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表3.6 CSV 書式設定
概要

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

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

Expand
表3.7 JSON 書式設定
概要

--noindent

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

Expand
表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

Expand
表3.9 位置引数
概要

URI

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

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

-h, --help

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

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

ACL の keystone ユーザー ID。

--project-access

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

--no-project-access

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

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

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

Expand
表3.11 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表3.12 CSV 書式設定
概要

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

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

Expand
表3.13 JSON 書式設定
概要

--noindent

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

Expand
表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

Expand
表3.15 位置引数
概要

URI

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

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

-h, --help

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

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

ACL の keystone ユーザー ID。

--project-access

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

--no-project-access

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

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

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

Expand
表3.17 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表3.18 CSV 書式設定
概要

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

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

Expand
表3.19 JSON 書式設定
概要

--noindent

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

Expand
表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

Expand
表3.21 位置引数
概要

URI

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

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

-h, --help

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

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

ACL の keystone ユーザー ID。

--project-access

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

--no-project-access

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

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

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

Expand
表3.23 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表3.24 CSV 書式設定
概要

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

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

Expand
表3.25 JSON 書式設定
概要

--noindent

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

Expand
表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

Expand
表4.1 位置引数
概要

定義

アクション定義ファイル

Expand
表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

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

Expand
表4.3 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表4.4 CSV 書式設定
概要

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

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

Expand
表4.5 JSON 書式設定
概要

--noindent

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

Expand
表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

Expand
表4.7 位置引数
概要

name

アクション名

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

-h, --help

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

4.3. action definition delete

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

使用方法

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

Expand
表4.9 位置引数
概要

action

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

Expand
表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]

Expand
表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

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

Expand
表4.12 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表4.13 CSV 書式設定
概要

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

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

Expand
表4.14 JSON 書式設定
概要

--noindent

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

Expand
表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

Expand
表4.16 位置引数
概要

action

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

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

-h, --help

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

Expand
表4.18 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表4.19 JSON 書式設定
概要

--noindent

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

Expand
表4.20 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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

Expand
表4.22 位置引数
概要

定義

アクション定義ファイル

Expand
表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

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

Expand
表4.24 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表4.25 CSV 書式設定
概要

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

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

Expand
表4.26 JSON 書式設定
概要

--noindent

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

Expand
表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 ...]

Expand
表4.28 位置引数
概要

action_execution

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

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

-h, --help

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

4.8. action execution input show

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

使用方法

openstack action execution input show [-h] id

Expand
表4.30 位置引数
概要

id

アクション実行 ID。

Expand
表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]

Expand
表4.32 位置引数
概要

task_execution_id

タスクの実行 ID。

Expand
表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

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

Expand
表4.34 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表4.35 CSV 書式設定
概要

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

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

Expand
表4.36 JSON 書式設定
概要

--noindent

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

Expand
表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

Expand
表4.38 位置引数
概要

id

アクション実行 ID。

Expand
表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]

Expand
表4.40 位置引数
概要

name

実行するアクション名。

input

アクション入力。

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

-h, --help

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

-s, --save-result

結果を db に保存します。

--run-sync

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

-t TARGET, --target TARGET

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

Expand
表4.42 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表4.43 JSON 書式設定
概要

--noindent

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

Expand
表4.44 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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

Expand
表4.46 位置引数
概要

action_execution

アクション実行 ID。

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

-h, --help

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

Expand
表4.48 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表4.49 JSON 書式設定
概要

--noindent

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

Expand
表4.50 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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

Expand
表4.52 位置引数
概要

id

アクション実行 ID。

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

-h, --help

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

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

アクション実行の状態

--output OUTPUT

アクション実行の出力

Expand
表4.54 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表4.55 JSON 書式設定
概要

--noindent

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

Expand
表4.56 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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>

Expand
表5.1 位置引数
概要

<name>

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

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

-h, --help

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

--ip-version {4,6}

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

--project <project>

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

--project-domain <project-domain>

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

--share

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

--no-share

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

Expand
表5.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表5.4 JSON 書式設定
概要

--noindent

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

Expand
表5.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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> ...]

Expand
表5.7 位置引数
概要

<address-scope>

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

Expand
表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]

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

-h, --help

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

--name <name>

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

--ip-version <ip-version>

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

--project <project>

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

--project-domain <project-domain>

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

--share

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

--no-share

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

Expand
表5.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表5.11 CSV 書式設定
概要

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

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

Expand
表5.12 JSON 書式設定
概要

--noindent

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

Expand
表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>

Expand
表5.14 位置引数
概要

<address-scope>

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

Expand
表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>

Expand
表5.16 位置引数
概要

<address-scope>

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

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

-h, --help

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

Expand
表5.18 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表5.19 JSON 書式設定
概要

--noindent

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

Expand
表5.20 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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>

Expand
表6.1 位置引数
概要

<aggregate>

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

<host>

<aggregate> に追加するホスト

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

-h, --help

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

Expand
表6.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表6.4 JSON 書式設定
概要

--noindent

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

Expand
表6.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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>

Expand
表6.7 位置引数
概要

<name>

新しいアグリゲート名

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

-h, --help

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

--zone <availability-zone>

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

--property <key=value>

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

Expand
表6.9 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表6.10 JSON 書式設定
概要

--noindent

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

Expand
表6.11 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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> ...]

Expand
表6.13 位置引数
概要

<aggregate>

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

Expand
表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]

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

-h, --help

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

--long

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

Expand
表6.16 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表6.17 CSV 書式設定
概要

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

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

Expand
表6.18 JSON 書式設定
概要

--noindent

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

Expand
表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>

Expand
表6.20 位置引数
概要

<aggregate>

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

<host>

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

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

-h, --help

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

Expand
表6.22 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表6.23 JSON 書式設定
概要

--noindent

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

Expand
表6.24 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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>

Expand
表6.26 位置引数
概要

<aggregate>

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

Expand
表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>

Expand
表6.28 位置引数
概要

<aggregate>

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

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

-h, --help

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

Expand
表6.30 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表6.31 JSON 書式設定
概要

--noindent

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

Expand
表6.32 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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>

Expand
表6.34 位置引数
概要

<aggregate>

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

Expand
表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>]

Expand
表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

Expand
表7.2 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表7.3 JSON 書式設定
概要

--noindent

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

Expand
表7.4 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表7.5 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

Expand
表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>

評価するしきい値。

Expand
表7.7 event alarm
概要

--event-type <EVENT_TYPE>

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

Expand
表7.8 common gnocchi alarm rules
概要

--granularity <GRANULARITY>

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

--aggregation-method <AGGR_METHOD>

しきい値と比較する aggregation_method

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

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

Expand
表7.9 gnocchi resource threshold alarm
概要

--resource-type <RESOURCE_TYPE>

リソースのタイプ。

--resource-id <RESOURCE_ID>

リソースの ID。

Expand
表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>]

Expand
表7.11 位置引数
概要

<ALARM ID または NAME>

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

Expand
表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>

Expand
表7.18 位置引数
概要

<alarm-id>

アラームの ID

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

-h, --help

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

--limit <LIMIT>

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

--marker <MARKER>

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

--sort <SORT_KEY:SORT_DIR>

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

Expand
表7.20 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表7.21 CSV 書式設定
概要

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

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

Expand
表7.22 JSON 書式設定
概要

--noindent

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

Expand
表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>]

Expand
表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)。

Expand
表7.25 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表7.26 CSV 書式設定
概要

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

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

Expand
表7.27 JSON 書式設定
概要

--noindent

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

Expand
表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>]

Expand
表7.29 位置引数
概要

<ALARM ID または NAME>

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

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

-h, --help

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

--name <NAME>

アラームの名前

Expand
表7.31 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表7.32 JSON 書式設定
概要

--noindent

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

Expand
表7.33 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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>]

Expand
表7.35 位置引数
概要

<ALARM ID または NAME>

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

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

-h, --help

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

--name <NAME>

アラームの名前

Expand
表7.37 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表7.38 JSON 書式設定
概要

--noindent

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

Expand
表7.39 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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>]

Expand
表7.41 位置引数
概要

<ALARM ID または NAME>

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

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

-h, --help

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

--name <NAME>

アラームの名前

--state <STATE>

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

Expand
表7.43 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表7.44 JSON 書式設定
概要

--noindent

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

Expand
表7.45 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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>]

Expand
表7.47 位置引数
概要

<ALARM ID または NAME>

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

Expand
表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

Expand
表7.49 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表7.50 JSON 書式設定
概要

--noindent

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

Expand
表7.51 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表7.52 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

Expand
表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>

評価するしきい値。

Expand
表7.54 event alarm
概要

--event-type <EVENT_TYPE>

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

Expand
表7.55 common gnocchi alarm rules
概要

--granularity <GRANULARITY>

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

--aggregation-method <AGGR_METHOD>

しきい値と比較する aggregation_method

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

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

Expand
表7.56 gnocchi resource threshold alarm
概要

--resource-type <RESOURCE_TYPE>

リソースのタイプ。

--resource-id <RESOURCE_ID>

リソースの ID。

Expand
表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]

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

-h, --help

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

Expand
表8.2 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表8.3 JSON 書式設定
概要

--noindent

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

Expand
表8.4 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表8.5 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

第9章 アプリケーション

本章では、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>

Expand
表9.1 位置引数
概要

<name>

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

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

-h, --help

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

--secret <secret>

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

--role <role>

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

--expiration <expiration>

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

--description <description>

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

--unrestricted

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

--restricted

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

Expand
表9.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表9.4 JSON 書式設定
概要

--noindent

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

Expand
表9.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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> ...]

Expand
表9.7 位置引数
概要

<application-credential>

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

Expand
表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>]

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

-h, --help

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

--user <user>

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

--user-domain <user-domain>

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

Expand
表9.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表9.11 CSV 書式設定
概要

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

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

Expand
表9.12 JSON 書式設定
概要

--noindent

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

Expand
表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>

Expand
表9.14 位置引数
概要

<application-credential>

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

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

-h, --help

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

Expand
表9.16 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表9.17 JSON 書式設定
概要

--noindent

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

Expand
表9.18 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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]

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

-h, --help

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

--compute

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

--network

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

--volume

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

--long

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

Expand
表10.2 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表10.3 CSV 書式設定
概要

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

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

Expand
表10.4 JSON 書式設定
概要

--noindent

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

Expand
表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>]]

Expand
表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 で、無期限に待機します。

Expand
表11.2 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.3 JSON 書式設定
概要

--noindent

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

Expand
表11.4 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表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> ...]

Expand
表11.6 位置引数
概要

<allocation>

削除する割り当て(名前または uuid)。

Expand
表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> ...]]

Expand
表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 が指定されている場合は使用できません。

Expand
表11.9 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.10 CSV 書式設定
概要

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

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

Expand
表11.11 JSON 書式設定
概要

--noindent

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

Expand
表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 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>

Expand
表11.13 位置引数
概要

<id>

割り当ての UUID または名前

Expand
表11.14 その他の引数 (オプション):
概要

-h, --help

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

--fields <field> [<field> …​]

1 つ以上の割り当てフィールド。これらのフィールドのみがサーバーから取得されます。

Expand
表11.15 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.16 JSON 書式設定
概要

--noindent

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

Expand
表11.17 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.18 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.5. 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>]

Expand
表11.19 その他の引数 (オプション):
概要

-h, --help

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

--description <description>

シャーシの説明

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--uuid <uuid>

シャーシの一意の UUID

Expand
表11.20 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.21 JSON 書式設定
概要

--noindent

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

Expand
表11.22 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.23 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.6. baremetal chassis delete

シャーシを削除します。

使用方法

openstack baremetal chassis delete [-h] <chassis> [<chassis> ...]

Expand
表11.24 位置引数
概要

<chassis>

削除するシャーシの UUID

Expand
表11.25 その他の引数 (オプション):
概要

-h, --help

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

11.7. ベアメタルシャーシの一覧

シャーシを一覧表示します。

使用方法

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>]]

Expand
表11.26 その他の引数 (オプション):
概要

-h, --help

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

--fields <field> [<field> …​]

1 つ以上のシャーシフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

--limit <limit>

要求ごとに返すシャーシの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--long

シャーシに関する詳細情報を表示します。

--marker <chassis>

シャーシ uuid(以前の要求リストにある最後のシャーシなど)。この UUID の後にシャーシの一覧を返します。

--sort <key>[:<direction>]

指定したシャシーフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

Expand
表11.27 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.28 CSV 書式設定
概要

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

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

Expand
表11.29 JSON 書式設定
概要

--noindent

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

Expand
表11.30 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.8. baremetal chassis set

シャーシのプロパティーを設定します。

使用方法

openstack baremetal chassis set [-h] [--description <description>]
                                       [--extra <key=value>]
                                       <chassis>

Expand
表11.31 位置引数
概要

<chassis>

シャーシの UUID

Expand
表11.32 その他の引数 (オプション):
概要

-h, --help

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

--description <description>

シャーシの説明を設定します。

--extra <key=value>

このシャーシに設定する追加項目(複数の追加項目を設定する場合は、オプションを繰り返し使用します。)

11.9. 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>

Expand
表11.33 位置引数
概要

<chassis>

シャーシの UUID

Expand
表11.34 その他の引数 (オプション):
概要

-h, --help

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

--fields <field> [<field> …​]

1 つ以上のシャーシフィールド。これらのフィールドのみがサーバーから取得されます。

Expand
表11.35 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.36 JSON 書式設定
概要

--noindent

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

Expand
表11.37 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.38 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.10. baremetal chassis unset

シャーシのプロパティーの設定を解除します。

使用方法

openstack baremetal chassis unset [-h] [--description] [--extra <key>]
                                         <chassis>

Expand
表11.39 位置引数
概要

<chassis>

シャーシの UUID

Expand
表11.40 その他の引数 (オプション):
概要

-h, --help

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

--description

シャーシの説明を消去します。

--extra <key>

このシャーシの設定を解除する追加項目(複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。)

11.11. 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> ...]]

Expand
表11.41 その他の引数 (オプション):
概要

-h, --help

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

--limit <limit>

要求ごとに返すコンダクターの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <conductor>

コンダクターのホスト名(例:以前の要求リストにある最後のコンダクター)。このコンダクターの後にコンダクターの一覧を返します。

--sort <key>[:<direction>]

指定したコンダクターフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--long

コンダクターに関する詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のコンダクターフィールド。これらのフィールドのみがサーバーから取得されます。-- long が指定されている場合は使用できません。

Expand
表11.42 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.43 CSV 書式設定
概要

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

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

Expand
表11.44 JSON 書式設定
概要

--noindent

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

Expand
表11.45 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.12. 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>

Expand
表11.46 位置引数
概要

<conductor>

コンダクターのホスト名

Expand
表11.47 その他の引数 (オプション):
概要

-h, --help

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

--fields <field> [<field> …​]

1 つ以上のコンダクターフィールド。これらのフィールドのみがサーバーから取得されます。

Expand
表11.48 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.49 JSON 書式設定
概要

--noindent

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

Expand
表11.50 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.51 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.13. baremetal create

ファイルからのリソースを作成します。

使用方法

openstack baremetal create [-h] <file> [<file> ...]

Expand
表11.52 位置引数
概要

<file>

作成するリソースの説明が記載されているファイル(.yaml または .json)。複数回指定できます。

Expand
表11.53 その他の引数 (オプション):
概要

-h, --help

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

11.14. 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>

Expand
表11.54 位置引数
概要

<name>

このデプロイテンプレートの一意名。有効な特性名である必要があります。

Expand
表11.55 その他の引数 (オプション):
概要

-h, --help

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

--uuid <uuid>

デプロイテンプレートの UUID

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--steps <steps>

Json 形式のデプロイ手順。デプロイ手順が含まれるファイルへのパス、- (デプロイ手順が標準入力から読み取る)、または文字列になります。値は deploy-step ディクショナリーの一覧である必要があります。各ディクショナリーには、interfacestepargs および priority が必要です。

Expand
表11.56 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.57 JSON 書式設定
概要

--noindent

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

Expand
表11.58 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.59 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.15. baremetal deploy template delete

デプロイテンプレートを削除します。

使用方法

openstack baremetal deploy template delete [-h]
                                                  <template> [<template> ...]

Expand
表11.60 位置引数
概要

<template>

削除するデプロイテンプレートの名前または UUID。

Expand
表11.61 その他の引数 (オプション):
概要

-h, --help

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

11.16. 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> ...]]

Expand
表11.62 その他の引数 (オプション):
概要

-h, --help

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

--limit <limit>

要求ごとに返すデプロイテンプレートの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <template>

DeployTemplate uuid(以前の要求リストにある最後のデプロイテンプレートなど)この UUID の後にデプロイテンプレートの一覧を返します。

--sort <key>[:<direction>]

指定したデプロイテンプレートフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--long

デプロイテンプレートに関する詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のデプロイテンプレートフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

Expand
表11.63 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.64 CSV 書式設定
概要

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

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

Expand
表11.65 JSON 書式設定
概要

--noindent

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

Expand
表11.66 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.17. baremetal deploy template set

ベアメタルのデプロイテンプレートプロパティーを設定します。

使用方法

openstack baremetal deploy template set [-h] [--name <name>]
                                               [--steps <steps>]
                                               [--extra <key=value>]
                                               <template>

Expand
表11.67 位置引数
概要

<template>

デプロイテンプレートの名前または UUID

Expand
表11.68 その他の引数 (オプション):
概要

-h, --help

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

--name <name>

デプロイテンプレートの一意名を設定します。有効な特性名である必要があります。

--steps <steps>

Json 形式のデプロイ手順。デプロイ手順が含まれるファイルへのパス、- (デプロイ手順が標準入力から読み取る)、または文字列になります。値は deploy-step ディクショナリーの一覧である必要があります。各ディクショナリーには、interfacestepargs および priority が必要です。

--extra <key=value>

このベアメタルデプロイテンプレートに設定する追加項目(複数の追加項目を設定する場合は、オプションを繰り返し使用します。)

11.18. 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>

Expand
表11.69 位置引数
概要

<template>

デプロイテンプレートの名前または UUID。

Expand
表11.70 その他の引数 (オプション):
概要

-h, --help

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

--fields <field> [<field> …​]

1 つ以上のデプロイテンプレートフィールド。これらのフィールドのみがサーバーから取得されます。

Expand
表11.71 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.72 JSON 書式設定
概要

--noindent

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

Expand
表11.73 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.74 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.19. baremetal deploy template unset

ベアメタルのデプロイテンプレートプロパティーの設定を解除します。

使用方法

openstack baremetal deploy template unset [-h] [--extra <key>]
                                                 <template>

Expand
表11.75 位置引数
概要

<template>

デプロイテンプレートの名前または UUID

Expand
表11.76 その他の引数 (オプション):
概要

-h, --help

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

--extra <key>

このベアメタルデプロイテンプレートの設定を解除する追加項目(複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。)

11.20. 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]

Expand
表11.77 その他の引数 (オプション):
概要

-h, --help

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

--type <type>

ドライバーのタイプ(「classic」または「dynamic」)。デフォルトでは、すべてのドライバーが一覧表示されます。

--long

ドライバーに関する詳細情報を表示します。

Expand
表11.78 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.79 CSV 書式設定
概要

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

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

Expand
表11.80 JSON 書式設定
概要

--noindent

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

Expand
表11.81 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.21. 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>

Expand
表11.82 位置引数
概要

<driver>

ドライバーの名前。

<method>

呼び出すベンダーパススルーメソッド

Expand
表11.83 その他の引数 (オプション):
概要

-h, --help

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

--arg <key=value>

Passthru メソッドに渡す引数(複数の引数を指定する場合は、オプションを繰り返し使用します)。

--http-method <http-method>

パススルー要求で使用する http メソッド。DELETE、GET、PATCH、POST、PUT のいずれか。デフォルトは POST です。

Expand
表11.84 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.85 JSON 書式設定
概要

--noindent

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

Expand
表11.86 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.87 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.22. 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>

Expand
表11.88 位置引数
概要

<driver>

ドライバーの名前。

Expand
表11.89 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.90 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.91 CSV 書式設定
概要

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

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

Expand
表11.92 JSON 書式設定
概要

--noindent

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

Expand
表11.93 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.23. 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>

Expand
表11.94 位置引数
概要

<driver>

ドライバーの名前。

Expand
表11.95 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.96 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.97 CSV 書式設定
概要

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

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

Expand
表11.98 JSON 書式設定
概要

--noindent

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

Expand
表11.99 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.24. 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>

Expand
表11.100 位置引数
概要

<driver>

ドライバーの名前。

Expand
表11.101 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.102 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.103 CSV 書式設定
概要

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

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

Expand
表11.104 JSON 書式設定
概要

--noindent

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

Expand
表11.105 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.25. 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>

Expand
表11.106 位置引数
概要

<driver>

ドライバーの名前。

Expand
表11.107 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.108 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.109 JSON 書式設定
概要

--noindent

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

Expand
表11.110 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.111 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.26. baremetal introspection abort

ノードのイントロスペクションの実行を中止します。

使用方法

openstack baremetal introspection abort [-h] node

Expand
表11.112 位置引数
概要

node

ベアメタルノードの uuid または名前

Expand
表11.113 その他の引数 (オプション):
概要

-h, --help

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

11.27. baremetal introspection data save

未加工のイントロスペクションデータを保存または表示します。

使用方法

openstack baremetal introspection data save [-h] [--file <filename>]
                                                   node

Expand
表11.114 位置引数
概要

node

ベアメタルノードの uuid または名前

Expand
表11.115 その他の引数 (オプション):
概要

-h, --help

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

--file <filename>

ダウンロードするイントロスペクションデータのファイル名(デフォルト:stdout)

11.28. 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

Expand
表11.116 位置引数
概要

node_ident

ベアメタルノードの uuid または名前

Expand
表11.117 その他の引数 (オプション):
概要

-h, --help

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

--vlan VLAN

この vlan ID 用に設定されたインターフェースのみを一覧表示します。繰り返し使用できます。

--long

インターフェースに関する詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のフィールドを表示します。-- long が指定されている場合は使用できません。

Expand
表11.118 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.119 CSV 書式設定
概要

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

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

Expand
表11.120 JSON 書式設定
概要

--noindent

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

Expand
表11.121 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.29. 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

Expand
表11.122 位置引数
概要

node_ident

ベアメタルノードの uuid または名前

interface

インターフェース名

Expand
表11.123 その他の引数 (オプション):
概要

-h, --help

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

--fields <field> [<field> …​]

1 つ以上のフィールドを表示します。

Expand
表11.124 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.125 JSON 書式設定
概要

--noindent

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

Expand
表11.126 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.127 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.30. 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]

Expand
表11.128 その他の引数 (オプション):
概要

-h, --help

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

--marker MARKER

前のページにある最後の項目の UUID

--limit LIMIT

返す項目数

Expand
表11.129 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.130 CSV 書式設定
概要

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

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

Expand
表11.131 JSON 書式設定
概要

--noindent

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

Expand
表11.132 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.31. baremetal introspection reprocess

保存されたイントロスペクションデータを再処理します。

使用方法

openstack baremetal introspection reprocess [-h] node

Expand
表11.133 位置引数
概要

node

ベアメタルノードの uuid または名前

Expand
表11.134 その他の引数 (オプション):
概要

-h, --help

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

11.32. baremetal introspection rule delete

イントロスペクションルールを削除します。

使用方法

openstack baremetal introspection rule delete [-h] uuid

Expand
表11.135 位置引数
概要

uuid

ルールの uuid

Expand
表11.136 その他の引数 (オプション):
概要

-h, --help

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

11.33. 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

Expand
表11.137 位置引数
概要

file

インポートする JSON または yaml ファイル。1 つまたは複数のルールを含めることができます。

Expand
表11.138 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.139 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.140 CSV 書式設定
概要

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

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

Expand
表11.141 JSON 書式設定
概要

--noindent

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

Expand
表11.142 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.34. 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]

Expand
表11.143 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.144 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.145 CSV 書式設定
概要

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

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

Expand
表11.146 JSON 書式設定
概要

--noindent

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

Expand
表11.147 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.35. baremetal introspection rule purge

すべてのイントロスペクションルールを破棄します。

使用方法

openstack baremetal introspection rule purge [-h]

Expand
表11.148 その他の引数 (オプション):
概要

-h, --help

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

11.36. 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

Expand
表11.149 位置引数
概要

uuid

ルールの uuid

Expand
表11.150 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.151 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.152 JSON 書式設定
概要

--noindent

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

Expand
表11.153 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.154 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.37. 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 ...]

Expand
表11.155 位置引数
概要

node

ベアメタルノードの uuid または名前

Expand
表11.156 その他の引数 (オプション):
概要

-h, --help

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

--wait

イントロスペクションが完了するまで待機します。結果は最後に表示されます。

--check-errors

イントロスペクション中にエラーが発生しているかどうかを確認します。エラーが発生した場合は、エラーのみが表示されます。--wait と併用しないと使用できません。

Expand
表11.157 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.158 CSV 書式設定
概要

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

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

Expand
表11.159 JSON 書式設定
概要

--noindent

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

Expand
表11.160 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.38. 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

Expand
表11.161 位置引数
概要

node

ベアメタルノードの uuid または名前

Expand
表11.162 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.163 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.164 JSON 書式設定
概要

--noindent

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

Expand
表11.165 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.166 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.39. baremetal node abort

ベアメタルノードのプロビジョニング状態を abort に設定します。

使用方法

openstack baremetal node abort [-h] <node>

Expand
表11.167 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.168 その他の引数 (オプション):
概要

-h, --help

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

11.40. baremetal node add trait

ノードに特性を追加します。

使用方法

openstack baremetal node add trait [-h] <node> <trait> [<trait> ...]

Expand
表11.169 位置引数
概要

<node>

ノードの名前または UUID

<trait>

追加する特性

Expand
表11.170 その他の引数 (オプション):
概要

-h, --help

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

11.41. baremetal node adopt

ベアメタルノードのプロビジョニング状態を adopt に設定します。

使用方法

openstack baremetal node adopt [-h] [--wait [<time-out>]] <node>

Expand
表11.171 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.172 その他の引数 (オプション):
概要

-h, --help

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

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.42. 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>

Expand
表11.173 位置引数
概要

<node>

ノードの名前または UUID

Expand
表11.174 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.175 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.176 CSV 書式設定
概要

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

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

Expand
表11.177 JSON 書式設定
概要

--noindent

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

Expand
表11.178 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.43. 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>

Expand
表11.179 位置引数
概要

<node>

ノードの名前または UUID

<setting name>

表示する名前の設定

Expand
表11.180 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.181 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.182 JSON 書式設定
概要

--noindent

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

Expand
表11.183 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.184 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.44. baremetal node boot device set

ノードのブートデバイスを設定します。

使用方法

openstack baremetal node boot device set [-h] [--persistent]
                                                <node> <device>

Expand
表11.185 位置引数
概要

<node>

ノードの名前または UUID

<device>

Bios、cdrom、disk、pxe、safe、wanboot のいずれか

Expand
表11.186 その他の引数 (オプション):
概要

-h, --help

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

--persistent

今後の起動時にすべての変更を永続化します。

11.45. 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>

Expand
表11.187 位置引数
概要

<node>

ノードの名前または UUID

Expand
表11.188 その他の引数 (オプション):
概要

-h, --help

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

--supported

サポート対象のブートデバイスを表示します。

Expand
表11.189 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.190 JSON 書式設定
概要

--noindent

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

Expand
表11.191 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.192 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.46. baremetal node clean

ベアメタルノードのプロビジョニング状態を clean に設定します。

使用方法

openstack baremetal node clean [-h] [--wait [<time-out>]] --clean-steps
                                      <clean-steps>
                                      <node>

Expand
表11.193 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.194 その他の引数 (オプション):
概要

-h, --help

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

--wait [<time-out>]

ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

--clean-steps <clean-steps>

Json 形式の消去手順。消去手順が含まれるファイルへのパス、- (消去手順が標準入力から読み取る)、または文字列になります。値は clean-step ディクショナリーの一覧である必要があります。各ディクショナリーには、キーの interface および step、任意のキーの args が必要です。

11.47. baremetal node console disable

ノードのコンソールアクセスを無効化します。

使用方法

openstack baremetal node console disable [-h] <node>

Expand
表11.195 位置引数
概要

<node>

ノードの名前または UUID

Expand
表11.196 その他の引数 (オプション):
概要

-h, --help

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

11.48. baremetal node console enable

ノードのコンソールアクセスを有効化します。

使用方法

openstack baremetal node console enable [-h] <node>

Expand
表11.197 位置引数
概要

<node>

ノードの名前または UUID

Expand
表11.198 その他の引数 (オプション):
概要

-h, --help

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

11.49. 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>

Expand
表11.199 位置引数
概要

<node>

ノードの名前または UUID

Expand
表11.200 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.201 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.202 JSON 書式設定
概要

--noindent

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

Expand
表11.203 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.204 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.50. 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>]

Expand
表11.205 その他の引数 (オプション):
概要

-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>

ノードの説明。

Expand
表11.206 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.207 JSON 書式設定
概要

--noindent

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

Expand
表11.208 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.209 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.51. baremetal node delete

ベアメタルノードの登録を解除します。

使用方法

openstack baremetal node delete [-h] <node> [<node> ...]

Expand
表11.210 位置引数
概要

<node>

削除するノード(名前または uuid)

Expand
表11.211 その他の引数 (オプション):
概要

-h, --help

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

11.52. baremetal node deploy

ベアメタルノードのプロビジョニングの状態を deploy に設定します。

使用方法

openstack baremetal node deploy [-h] [--wait [<time-out>]]
                                       [--config-drive <config-drive>]
                                       <node>

Expand
表11.212 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.213 その他の引数 (オプション):
概要

-h, --help

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

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

--config-drive <config-drive>

Gzipped, base64 でエンコードされたコンフィグドライブの文字列、またはコンフィグドライブファイルへのパス、コンフィグドライブファイルが含まれるパス、コンフィグドライブのビルド元の JSON オブジェクト。ディレクトリーの場合には、コンフィグドライブはそのディレクトリーで生成されます。JSON オブジェクトに、オプションのキー meta_data、user_data、および network_data が指定されている場合には、コンフィグドライブがサーバー側で生成されます(詳細は、ベアメタル API のリファレンス を参照)。

11.53. baremetal node inject nmi

NMI をベアメタルノードに注入します。

使用方法

openstack baremetal node inject nmi [-h] <node>

Expand
表11.214 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.215 その他の引数 (オプション):
概要

-h, --help

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

11.54. baremetal node inspect

ベアメタルノードのプロビジョニング状態を inspect に設定します。

使用方法

openstack baremetal node inspect [-h] [--wait [<time-out>]] <node>

Expand
表11.216 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.217 その他の引数 (オプション):
概要

-h, --help

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

--wait [<time-out>]

ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.55. 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> ...]]

Expand
表11.218 その他の引数 (オプション):
概要

-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 が指定されている場合は使用できません。

Expand
表11.219 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.220 CSV 書式設定
概要

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

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

Expand
表11.221 JSON 書式設定
概要

--noindent

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

Expand
表11.222 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.56. baremetal node maintenance set

ベアメタルノードをメンテナンスモードに設定します。

使用方法

openstack baremetal node maintenance set [-h] [--reason <reason>]
                                                <node>

Expand
表11.223 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.224 その他の引数 (オプション):
概要

-h, --help

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

--reason <reason>

メンテナンスモードを設定する理由。

11.57. baremetal node maintenance unset

メンテナンスモードのベアメタルノードの設定を解除します。

使用方法

openstack baremetal node maintenance unset [-h] <node>

Expand
表11.225 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.226 その他の引数 (オプション):
概要

-h, --help

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

11.58. baremetal node manage

ベアメタルノードのプロビジョニングの状態を manage に設定します。

使用方法

openstack baremetal node manage [-h] [--wait [<time-out>]] <node>

Expand
表11.227 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.228 その他の引数 (オプション):
概要

-h, --help

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

--wait [<time-out>]

ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.59. baremetal node passthru call

ノードのベンダーパススルーメソッドを呼び出します。

使用方法

openstack baremetal node passthru call [-h] [--arg <key=value>]
                                              [--http-method <http-method>]
                                              <node> <method>

Expand
表11.229 位置引数
概要

<node>

ノードの名前または UUID

<method>

実行するベンダーパススルーメソッド

Expand
表11.230 その他の引数 (オプション):
概要

-h, --help

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

--arg <key=value>

Passthru メソッドに渡す引数(複数の引数を指定する場合は、オプションを繰り返し使用します)。

--http-method <http-method>

パススルー要求で使用する http メソッド。DELETE、GET、PATCH、POST、PUT のいずれか。デフォルトは POST です。

11.60. 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>

Expand
表11.231 位置引数
概要

<node>

ノードの名前または UUID

Expand
表11.232 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.233 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.234 CSV 書式設定
概要

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

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

Expand
表11.235 JSON 書式設定
概要

--noindent

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

Expand
表11.236 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.61. baremetal node power off

ノードの電源をオフにします。

使用方法

openstack baremetal node power off [-h]
                                          [--power-timeout <power-timeout>]
                                          [--soft]
                                          <node>

Expand
表11.237 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.238 その他の引数 (オプション):
概要

-h, --help

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

--power-timeout <power-timeout>

エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間(秒単位、正の整数)。

--soft

正常な電源オフを要求します。

11.62. baremetal node power on

ノードの電源をオンにします。

使用方法

openstack baremetal node power on [-h]
                                         [--power-timeout <power-timeout>]
                                         <node>

Expand
表11.239 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.240 その他の引数 (オプション):
概要

-h, --help

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

--power-timeout <power-timeout>

エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間(秒単位、正の整数)。

11.63. baremetal node provide

ベアメタルノードのプロビジョニングの状態を provide に設定します。

使用方法

openstack baremetal node provide [-h] [--wait [<time-out>]] <node>

Expand
表11.241 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.242 その他の引数 (オプション):
概要

-h, --help

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

--wait [<time-out>]

ノードが必要な状態(available)に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.64. baremetal node reboot

ベアメタルノードを再起動します。

使用方法

openstack baremetal node reboot [-h] [--soft]
                                       [--power-timeout <power-timeout>]
                                       <node>

Expand
表11.243 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.244 その他の引数 (オプション):
概要

-h, --help

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

--soft

正常な再起動を要求します。

--power-timeout <power-timeout>

エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間(秒単位、正の整数)。

11.65. baremetal node rebuild

ベアメタルノードのプロビジョニングの状態を rebuild に設定します。

使用方法

openstack baremetal node rebuild [-h] [--wait [<time-out>]]
                                        [--config-drive <config-drive>]
                                        <node>

Expand
表11.245 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.246 その他の引数 (オプション):
概要

-h, --help

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

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

--config-drive <config-drive>

Gzipped, base64 でエンコードされたコンフィグドライブの文字列、またはコンフィグドライブファイルへのパス、コンフィグドライブファイルが含まれるパス、コンフィグドライブのビルド元の JSON オブジェクト。ディレクトリーの場合には、コンフィグドライブはそのディレクトリーで生成されます。JSON オブジェクトに、オプションのキー meta_data、user_data、および network_data が指定されている場合には、コンフィグドライブがサーバー側で生成されます(詳細は、ベアメタル API のリファレンス を参照)。

11.66. baremetal node remove trait

ノードから特性を削除します。

使用方法

openstack baremetal node remove trait [-h] [--all]
                                             <node> [<trait> [<trait> ...]]

Expand
表11.247 位置引数
概要

<node>

ノードの名前または UUID

<trait>

削除する特性

Expand
表11.248 その他の引数 (オプション):
概要

-h, --help

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

--all

すべての特性を削除します。

11.67. baremetal node rescue

ベアメタルノードのプロビジョニングの状態を rescue に設定します。

使用方法

openstack baremetal node rescue [-h] [--wait [<time-out>]]
                                       --rescue-password <rescue-password>
                                       <node>

Expand
表11.249 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.250 その他の引数 (オプション):
概要

-h, --help

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

--wait [<time-out>]

ノードが必要な状態 (rescue) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

--rescue-password <rescue-password>

Rescue ramdisk へのログインに使用するパスワード。値は空でない文字列である必要があります。

11.68. 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>

Expand
表11.251 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.252 その他の引数 (オプション):
概要

-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.69. 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>

Expand
表11.253 位置引数
概要

<node>

ノードの名前または uuid(または --instance が指定されている場合のインスタンスの uuid)

Expand
表11.254 その他の引数 (オプション):
概要

-h, --help

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

--instance

<node> はインスタンスの uuid です。

--fields <field> [<field> …​]

1 つ以上のノードフィールド。これらのフィールドのみがサーバーから取得されます。

Expand
表11.255 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.256 JSON 書式設定
概要

--noindent

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

Expand
表11.257 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.258 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.70. 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>

Expand
表11.259 位置引数
概要

<node>

ノードの名前または UUID

Expand
表11.260 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.261 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.262 CSV 書式設定
概要

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

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

Expand
表11.263 JSON 書式設定
概要

--noindent

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

Expand
表11.264 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.71. baremetal node undeploy

ベアメタルノードのプロビジョニングの状態を deleted に設定します。

使用方法

openstack baremetal node undeploy [-h] [--wait [<time-out>]] <node>

Expand
表11.265 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.266 その他の引数 (オプション):
概要

-h, --help

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

--wait [<time-out>]

ノードが必要な状態(available)に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.72. baremetal node unrescue

ベアメタルノードのプロビジョニング状態を unrescue に設定します。

使用方法

openstack baremetal node unrescue [-h] [--wait [<time-out>]] <node>

Expand
表11.267 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.268 その他の引数 (オプション):
概要

-h, --help

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

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.73. 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>

Expand
表11.269 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表11.270 その他の引数 (オプション):
概要

-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.74. 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>

Expand
表11.271 位置引数
概要

<node>

ノードの名前または UUID

Expand
表11.272 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.273 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.274 CSV 書式設定
概要

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

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

Expand
表11.275 JSON 書式設定
概要

--noindent

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

Expand
表11.276 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.75. baremetal node vif attach

VIF を指定ノードに接続します。

使用方法

openstack baremetal node vif attach [-h] [--vif-info <key=value>]
                                           <node> <vif-id>

Expand
表11.277 位置引数
概要

<node>

ノードの名前または UUID

<vif-id>

ノードに割り当てる vif の名前または UUID。

Expand
表11.278 その他の引数 (オプション):
概要

-h, --help

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

--vif-info <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。必須の id パラメーターはキーとして指定できません。

11.76. baremetal node vif detach

指定のノードから VIF を切断します。

使用方法

openstack baremetal node vif detach [-h] <node> <vif-id>

Expand
表11.279 位置引数
概要

<node>

ノードの名前または UUID

<vif-id>

ノードから切り離す vif の名前または UUID。

Expand
表11.280 その他の引数 (オプション):
概要

-h, --help

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

11.77. baremetal node vif list

ノードに接続された VIF を表示します。

使用方法

openstack baremetal node vif 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>

Expand
表11.281 位置引数
概要

<node>

ノードの名前または UUID

Expand
表11.282 その他の引数 (オプション):
概要

-h, --help

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

Expand
表11.283 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.284 CSV 書式設定
概要

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

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

Expand
表11.285 JSON 書式設定
概要

--noindent

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

Expand
表11.286 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.78. baremetal port create

新規ポートの作成

使用方法

openstack baremetal port create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] --node <uuid>
                                       [--uuid <uuid>] [--extra <key=value>]
                                       [--local-link-connection <key=value>]
                                       [-l <key=value>]
                                       [--pxe-enabled <boolean>]
                                       [--port-group <uuid>]
                                       [--physical-network <physical network>]
                                       [--is-smartnic]
                                       <address>

Expand
表11.287 位置引数
概要

<address>

このポートの MAC アドレス。

Expand
表11.288 その他の引数 (オプション):
概要

-h, --help

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

--node <uuid>

このポートが属するノードの UUID。

--uuid <uuid>

ポートの UUID

--extra <key=value>

任意のキー/値のメタデータを記録します。引数は複数回指定できます。

--local-link-connection <key=value>

ローカルリンク接続情報を記述するキー/値のメタデータ。有効なキーは switch_infoswitch_idport_id、および hostname です。switch_idport_id キーは必須です。スマート NIC ポートの場合に、必要なキーは port_idhostname です。引数は、複数回指定できます。

-l <key=value>

非推奨です。代わりに --local-link-connection を使用してください。ローカルリンク接続情報を記述するキー/値のメタデータ。有効なキーは switch_infoswitch_id、および port_id です。switch_idport_id キーは必須です。複数回指定できます。

--pxe-enabled <boolean>

このノードの PXE の起動時にこのポートを使用するかどうかを指定します。

--port-group <uuid>

このポートが属するポートグループの UUID。

--physical-network <physical network>

このポートを接続する物理ネットワークの名前。

--is-smartnic

このポートがスマート NIC ポートであるかどうかを指定します。

Expand
表11.289 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.290 JSON 書式設定
概要

--noindent

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

Expand
表11.291 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.292 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.79. baremetal port delete

ポートを削除します。

使用方法

openstack baremetal port delete [-h] <port> [<port> ...]

Expand
表11.293 位置引数
概要

<port>

削除するポートの UUID

Expand
表11.294 その他の引数 (オプション):
概要

-h, --help

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

11.80. baremetal port group create

新規ベアメタルポートグループを作成します。

使用方法

openstack baremetal port group create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             --node <uuid>
                                             [--address <mac-address>]
                                             [--name NAME] [--uuid UUID]
                                             [--extra <key=value>]
                                             [--mode MODE]
                                             [--property <key=value>]
                                             [--support-standalone-ports | --unsupport-standalone-ports]

Expand
表11.295 その他の引数 (オプション):
概要

-h, --help

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

--node <uuid>

このポートグループが属するノードの UUID。

--address <mac-address>

このポートグループの MAC アドレス。

--name NAME

ポートグループの名前。

--uuid UUID

ポートグループの UUID

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--mode MODE

ポートグループのモード。使用できる値は https://www.kernel.org/doc/Documentation/networking/bo nding.txt を参照してください。

--property <key=value>

このポートグループの設定に関連するキー/値プロパティー。複数回指定できます。

--support-standalone-ports

このポートグループのメンバーであるポートはスタンドアロンのポートとして使用できます(デフォルト)。

--unsupport-standalone-ports

このポートグループのメンバーであるポートは、スタンドアロンのポートとしては使用できません。

Expand
表11.296 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.297 JSON 書式設定
概要

--noindent

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

Expand
表11.298 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.299 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.81. baremetal port group delete

ベアメタルポートグループの登録を解除します。

使用方法

openstack baremetal port group delete [-h]
                                             <port group> [<port group> ...]

Expand
表11.300 位置引数
概要

<port group>

削除するポートグループ(名前または UUID)。

Expand
表11.301 その他の引数 (オプション):
概要

-h, --help

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

11.82. baremetal port group list

ベアメタルポートグループを一覧表示します。

使用方法

openstack baremetal port group 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 <port group>]
                                           [--sort <key>[:<direction>]]
                                           [--address <mac-address>]
                                           [--node <node>]
                                           [--long | --fields <field> [<field> ...]]

Expand
表11.302 その他の引数 (オプション):
概要

-h, --help

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

--limit <limit>

要求ごとに返すポートグループの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <port group>

ポートグループの uuid (以前の要求リストにある最後のポートグループなど)。この UUID の後にポートグループの一覧を返します。

--sort <key>[:<direction>]

指定したポートグループのフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--address <mac-address>

この mac アドレスのポートグループに関する情報のみを表示します。

--node <node>

このノードのポートグループ(名前または UUID)のみを一覧表示します。

--long

ポートグループの詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のポートグループフィールド。これらのフィールドのみがサーバーから取得されます。-- long が指定されている場合は使用できません。

Expand
表11.303 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.304 CSV 書式設定
概要

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

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

Expand
表11.305 JSON 書式設定
概要

--noindent

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

Expand
表11.306 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.83. baremetal port group set

ベアメタルポートグループプロパティーを設定します。

使用方法

openstack baremetal port group set [-h] [--node <uuid>]
                                          [--address <mac-address>]
                                          [--name <name>]
                                          [--extra <key=value>] [--mode MODE]
                                          [--property <key=value>]
                                          [--support-standalone-ports | --unsupport-standalone-ports]
                                          <port group>

Expand
表11.307 位置引数
概要

<port group>

ポートグループの名前または UUID。

Expand
表11.308 その他の引数 (オプション):
概要

-h, --help

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

--node <uuid>

このポートグループが属するノードの uuid を更新します。

--address <mac-address>

このポートグループの MAC アドレス。

--name <name>

ポートグループの名前。

--extra <key=value>

このベアメタルポートグループに設定する追加項目(複数の項目を設定する場合はオプションを繰り返し使用します)

--mode MODE

ポートグループのモード。使用できる値は https://www.kernel.org/doc/Documentation/networking/bo nding.txt を参照してください。

--property <key=value>

このポートグループの設定に関連するキー/値プロパティー(複数のプロパティーを設定する場合は、オプションを繰り返し使用します)。

--support-standalone-ports

このポートグループのメンバーであるポートは、スタンドアロンのポートとして使用できます。

--unsupport-standalone-ports

このポートグループのメンバーであるポートは、スタンドアロンのポートとしては使用できません。

11.84. baremetal port group show

ベアメタルポートグループの詳細を表示します。

使用方法

openstack baremetal port group show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--address]
                                           [--fields <field> [<field> ...]]
                                           <id>

Expand
表11.309 位置引数
概要

<id>

ポートグループの UUID または名前(または --address が指定されている場合は mac アドレス)。

Expand
表11.310 その他の引数 (オプション):
概要

-h, --help

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

--address

<id> は、ポートグループの mac アドレス(uuid または name ではなく)です。

--fields <field> [<field> …​]

1 つ以上のポートグループフィールド。これらのフィールドのみがサーバーから取得されます。

Expand
表11.311 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.312 JSON 書式設定
概要

--noindent

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

Expand
表11.313 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.314 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.85. baremetal port group unset

ベアメタルポートグループプロパティーの設定を解除します。

使用方法

openstack baremetal port group unset [-h] [--name] [--address]
                                            [--extra <key>] [--property <key>]
                                            <port group>

Expand
表11.315 位置引数
概要

<port group>

ポートグループの名前または UUID。

Expand
表11.316 その他の引数 (オプション):
概要

-h, --help

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

--name

ポートグループの名前の設定を解除します。

--address

ポートグループのアドレスを解除します。

--extra <key>

このベアメタルポートグループで追加で設定を解除する項目(複数の項目の設定を解除する場合はオプションを繰り返し使用します)

--property <key>

このベアメタルポートグループで設定を解除するプロパティー(複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します)

11.86. baremetal port list

ベアメタルポートを一覧表示します。

使用方法

openstack baremetal port 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]
                                     [--address <mac-address>] [--node <node>]
                                     [--port-group <port group>]
                                     [--limit <limit>] [--marker <port>]
                                     [--sort <key>[:<direction>]]
                                     [--long | --fields <field> [<field> ...]]

Expand
表11.317 その他の引数 (オプション):
概要

-h, --help

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

--address <mac-address>

この mac アドレスのポートに関する情報のみを表示します。

--node <node>

このノードのポート(名前または UUID)のみを一覧表示します。

--port-group <port group>

このポートグループのポートのみを一覧表示します(名前または UUID)。

--limit <limit>

要求ごとに返すポートの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <port>

ポート uuid(以前の要求リストにある最後のポートなど)。この UUID の後にポートの一覧を返します。

--sort <key>[:<direction>]

指定したポートフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--long

ポートの詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のポートフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

Expand
表11.318 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.319 CSV 書式設定
概要

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

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

Expand
表11.320 JSON 書式設定
概要

--noindent

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

Expand
表11.321 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.87. baremetal port set

ベアメタルポートのプロパティーを設定します。

使用方法

openstack baremetal port set [-h] [--node <uuid>] [--address <address>]
                                    [--extra <key=value>]
                                    [--port-group <uuid>]
                                    [--local-link-connection <key=value>]
                                    [--pxe-enabled | --pxe-disabled]
                                    [--physical-network <physical network>]
                                    [--is-smartnic]
                                    <port>

Expand
表11.322 位置引数
概要

<port>

ポートの UUID

Expand
表11.323 その他の引数 (オプション):
概要

-h, --help

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

--node <uuid>

このポートが属するノードの uuid を設定します。

--address <address>

このポートの mac アドレスを設定します。

--extra <key=value>

このベアメタルポートグループに設定する追加項目(複数の項目を設定する場合はオプションを繰り返し使用します)

--port-group <uuid>

このポートが属するポートグループの uuid を設定します。

--local-link-connection <key=value>

ローカルリンク接続情報を記述するキー/値のメタデータ。有効なキーは switch_infoswitch_idport_id、および hostname です。switch_idport_id キーは必須です。スマート NIC ポートの場合に、必要なキーは port_idhostname です。引数は、複数回指定できます。

--pxe-enabled

このノードの PXE の起動時にこのポートを使用するかどうかを指定します。

--pxe-disabled

このノードの PXE の起動時にこのポートを使用しないように指定します。

--physical-network <physical network>

このポートを接続する物理ネットワークの名前を設定します。

--is-smartnic

ポートをスマート NIC ポートに設定します。

11.88. baremetal port show

ベアメタルポートの詳細を表示します。

使用方法

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

Expand
表11.324 位置引数
概要

<id>

ポートの UUID(--address が指定されている場合は mac アドレス)。

Expand
表11.325 その他の引数 (オプション):
概要

-h, --help

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

--address

<id> はポートの(uuid ではなく)mac アドレスです。

--fields <field> [<field> …​]

1 つ以上のポートフィールド。これらのフィールドのみがサーバーから取得されます。

Expand
表11.326 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.327 JSON 書式設定
概要

--noindent

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

Expand
表11.328 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.329 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.89. baremetal port unset

ベアメタルポートのプロパティーの設定を解除します。

使用方法

openstack baremetal port unset [-h] [--extra <key>] [--port-group]
                                      [--physical-network] [--is-smartnic]
                                      <port>

Expand
表11.330 位置引数
概要

<port>

ポートの UUID

Expand
表11.331 その他の引数 (オプション):
概要

-h, --help

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

--extra <key>

このベアメタルポートの設定を追加で解除する項目(複数のプロパティーを設定する場合はオプションを繰り返し使用します)

--port-group

ポートグループからポートを削除します。

--physical-network

このベアメタルポートで物理ネットワークの設定を解除します。

--is-smartnic

ポートをスマート NIC ポートとして設定します。

11.90. baremetal volume connector create

新しいベアメタルのボリュームコネクターを作成します。

使用方法

openstack baremetal volume connector create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty] --node
                                                   <uuid> --type <type>
                                                   --connector-id <connector
                                                   id> [--uuid <uuid>]
                                                   [--extra <key=value>]

Expand
表11.332 その他の引数 (オプション):
概要

-h, --help

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

--node <uuid>

このボリュームコネクターが属するノードの UUID。

--type <type>

ボリュームコネクターの種類。iqnipmacwwnnwwpnportportgroup

--connector-id <connector id>

指定のタイプのボリュームコネクター ID。たとえば、タイプが iqn の場合は、ノードの iSCSI イニシエーター IQN。

--uuid <uuid>

ボリュームコネクターの UUID。

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

Expand
表11.333 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.334 JSON 書式設定
概要

--noindent

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

Expand
表11.335 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.336 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.91. baremetal volume connector delete

ベアメタルボリュームコネクターの登録を解除します。

使用方法

openstack baremetal volume connector delete [-h]
                                                   <volume connector>
                                                   [<volume connector> ...]

Expand
表11.337 位置引数
概要

<volume connector>

削除するボリュームコネクターの UUID

Expand
表11.338 その他の引数 (オプション):
概要

-h, --help

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

11.92. baremetal volume connector list

ベアメタルボリュームコネクターを一覧表示します。

使用方法

openstack baremetal volume connector 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 <node>]
                                                 [--limit <limit>]
                                                 [--marker <volume connector>]
                                                 [--sort <key>[:<direction>]]
                                                 [--long | --fields <field> [<field> ...]]

Expand
表11.339 その他の引数 (オプション):
概要

-h, --help

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

--node <node>

このノードのボリュームコネクター(名前または UUID)のみを一覧表示します。

--limit <limit>

要求ごとに返すボリュームの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <volume connector>

ボリュームコネクター UUID(以前の要求リストにある最後のボリュームコネクターなど)。この UUID の後にボリュームコネクターの一覧を返します。

--sort <key>[:<direction>]

指定したボリュームコネクターのフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--long

ボリュームコネクターの詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のボリュームコネクターフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

Expand
表11.340 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表11.341 CSV 書式設定
概要

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

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

Expand
表11.342 JSON 書式設定
概要

--noindent

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

Expand
表11.343 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.93. baremetal volume connector set

ベアメタルボリュームコネクタープロパティーを設定します。

使用方法

openstack baremetal volume connector set [-h] [--node <uuid>]
                                                [--type <type>]
                                                [--connector-id <connector id>]
                                                [--extra <key=value>]
                                                <volume connector>

Expand
表11.344 位置引数
概要

<volume connector>

ボリュームコネクターの UUID。

Expand
表11.345 その他の引数 (オプション):
概要

-h, --help

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

--node <uuid>

このボリュームコネクターが属するノードの UUID。

--type <type>

ボリュームコネクターの種類。iqnipmacwwnnwwpnportportgroup

--connector-id <connector id>

指定したタイプのボリュームコネクターの ID。

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

11.94. baremetal volume connector show

ベアメタルボリュームコネクターの詳細を表示します。

使用方法

openstack baremetal volume connector show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--fields <field> [<field> ...]]
                                                 <id>

Expand
表11.346 位置引数
概要

<id>

ボリュームコネクターの UUID。

Expand
表11.347 その他の引数 (オプション):
概要

-h, --help

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

--fields <field> [<field> …​]

1 つ以上のボリュームコネクターフィールド。これらのフィールドのみがサーバーから取得されます。

Expand
表11.348 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.349 JSON 書式設定
概要

--noindent

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

Expand
表11.350 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.351 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.95. baremetal volume connector unset

ベアメタルボリュームコネクタープロパティーの設定を解除します。

使用方法

openstack baremetal volume connector unset [-h] [--extra <key>]
                                                  <volume connector>

Expand
表11.352 位置引数
概要

<volume connector>

ボリュームコネクターの UUID。

Expand
表11.353 その他の引数 (オプション):
概要

-h, --help

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

--extra <key>

設定を解除する追加項目(複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。)

11.96. baremetal volume target create

新しいベアメタルのボリュームターゲットを作成します。

使用方法

openstack baremetal volume target create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                --node <uuid> --type <volume
                                                type> [--property <key=value>]
                                                --boot-index <boot index>
                                                --volume-id <volume id>
                                                [--uuid <uuid>]
                                                [--extra <key=value>]

Expand
表11.354 その他の引数 (オプション):
概要

-h, --help

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

--node <uuid>

このボリュームターゲットが属するノードの UUID。

--type <volume type>

ボリュームターゲットのタイプ(例:iscsifibre_channel )。

--property <key=value>

このボリュームターゲットのタイプに関連するキー/値プロパティー。複数回指定できます。

--boot-index <boot index>

ボリュームターゲットのブートインデックス。

--volume-id <volume id>

このターゲットに関連付けられたボリュームの ID。

--uuid <uuid>

ボリュームターゲットの UUID

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

Expand
表11.355 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

Expand
表11.356 JSON 書式設定
概要

--noindent

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

Expand
表11.357 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

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

Expand
表11.358 表の書式設定
概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.97. baremetal volume target delete

ベアメタルボリュームのターゲットの登録を解除します。

使用方法

openstack baremetal volume target delete [-h]
                                                <volume target>
                                                [<volume target> ...]

Expand
表11.359 位置引数
概要

<volume target>

削除するボリュームターゲットの UUID。

Expand
表11.360 その他の引数 (オプション):
概要

-h, --help

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

11.98. baremetal volume target list

ベアメタルボリュームターゲットを一覧表示します。

使用方法

openstack baremetal volume target 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 <node>]
                                              [--limit <limit>]
                                              [--marker <volume target>]
                                              [--sort <key>[:<direction>]]
                                              [--long | --fields <field> [<field> ...]]

Expand
表11.361 その他の引数 (オプション):
概要

-h, --help

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

--node <node>

このノードのボリュームターゲット(名前または UUID)のみを一覧表示します。

--limit <limit>

要求ごとに返すボリュームターゲットの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <volume target>

ボリュームターゲットの uuid(以前の要求リストにある最後のボリュームターゲットなど)。UUID の後にボリュームターゲットの一覧を返します。

--sort <key>[:<direction>]

指定したボリュームターゲットのフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--long

ボリュームターゲットの詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のボリュームターゲットフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

Expand
表11.362 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表11.363 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表11.364 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表11.365 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.99. baremetal volume target set

ベアメタルボリュームのターゲットプロパティーを設定します。

使用方法

openstack baremetal volume target set [-h] [--node <uuid>]
                                             [--type <volume type>]
                                             [--property <key=value>]
                                             [--boot-index <boot index>]
                                             [--volume-id <volume id>]
                                             [--extra <key=value>]
                                             <volume target>

Expand
表11.366 位置引数
概要

<volume target>

ボリュームターゲットの UUID

Expand
表11.367 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--node <uuid>

このボリュームターゲットが属するノードの UUID。

--type <volume type>

ボリュームターゲットのタイプ(例:iscsifibre_channel )。

--property <key=value>

このボリュームターゲットのタイプに関連するキー/値プロパティー。複数回指定できます。

--boot-index <boot index>

ボリュームターゲットのブートインデックス。

--volume-id <volume id>

このターゲットに関連付けられたボリュームの ID。

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

11.100. baremetal volume target show

ベアメタルボリュームのターゲットの詳細を表示します。

使用方法

openstack baremetal volume target show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--fields <field> [<field> ...]]
                                              <id>

Expand
表11.368 位置引数
概要

<id>

ボリュームターゲットの UUID

Expand
表11.369 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のボリュームターゲットフィールド。これらのフィールドのみがサーバーから取得されます。

Expand
表11.370 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表11.371 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表11.372 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表11.373 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.101. baremetal volume target unset

ベアメタルボリュームのターゲットプロパティーの設定を解除します。

使用方法

openstack baremetal volume target unset [-h] [--extra <key>]
                                               [--property <key>]
                                               <volume target>

Expand
表11.374 位置引数
概要

<volume target>

ボリュームターゲットの UUID

Expand
表11.375 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--extra <key>

設定を解除する追加項目(複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。)

--property <key>

このベアメタルボリュームターゲットで設定を解除するプロパティー(複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します)

第12章 bgp

本章では、bgp コマンドに含まれるコマンドについて説明します。

12.1. bgp dragent add speaker

BGP スピーカーを動的ルーティングエージェントに追加します。

使用方法

openstack bgp dragent add speaker [-h] <agent-id> <bgp-speaker>

Expand
表12.1 位置引数
概要

<agent-id>

動的ルーティングエージェントの ID

<bgp-speaker>

bgp スピーカーの ID または名前

Expand
表12.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

12.2. bgp dragent remove speaker

動的ルーティングエージェントから BGP スピーカーを削除します。

使用方法

openstack bgp dragent remove speaker [-h] <agent-id> <bgp-speaker>

Expand
表12.3 位置引数
概要

<agent-id>

動的ルーティングエージェントの ID

<bgp-speaker>

bgp スピーカーの ID または名前

Expand
表12.4 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

12.3. bgp peer create

BGP ピアを作成します。

使用方法

openstack bgp peer create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] --peer-ip <peer-ip-address>
                                 --remote-as <peer-remote-as>
                                 [--auth-type <peer-auth-type>]
                                 [--password <auth-password>]
                                 [--project <project>]
                                 [--project-domain <project-domain>]
                                 <name>

Expand
表12.5 位置引数
概要

<name>

作成する bgp ピアの名前

Expand
表12.6 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--peer-ip <peer-ip-address>

ピアの IP アドレス

--remote-as <peer-remote-as>

数字で表現したピア([1, 65535] の整数を使用可能)

--auth-type <peer-auth-type>

認証アルゴリズム。サポートされるアルゴリズム:none(デフォルト)、md5

--password <auth-password>

認証パスワード

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表12.7 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表12.8 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表12.9 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表12.10 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

12.4. bgp peer delete

BGP ピアを削除します。

使用方法

openstack bgp peer delete [-h] <bgp-peer>

Expand
表12.11 位置引数
概要

<bgp-peer>

削除する BGP ピア(名前または ID)

Expand
表12.12 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

12.5. bgp peer list

BGP ピアを一覧表示します。

使用方法

openstack bgp peer 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]

Expand
表12.13 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表12.14 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表12.15 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表12.16 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表12.17 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

12.6. bgp peer set

BGP ピアを更新します。

使用方法

openstack bgp peer set [-h] [--name NAME] [--password <auth-password>]
                              <bgp-peer>

Expand
表12.18 位置引数
概要

<bgp-peer>

更新する BGP ピア(名前または ID)

Expand
表12.19 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

更新する Bgp ピア名

--password <auth-password>

更新する認証パスワード

12.7. bgp peer show

BGP ピアの情報を表示します。

使用方法

openstack bgp peer show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               <bgp-peer>

Expand
表12.20 位置引数
概要

<bgp-peer>

表示する BGP ピア(名前または ID)

Expand
表12.21 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表12.22 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表12.23 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表12.24 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表12.25 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

12.8. bgp speaker add network

BGP スピーカーにネットワークを追加します。

使用方法

openstack bgp speaker add network [-h] <bgp-speaker> <network>

Expand
表12.26 位置引数
概要

<bgp-speaker>

BGP スピーカー(名前または ID)

<network>

追加するネットワーク(名前または ID)

Expand
表12.27 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

12.9. bgp speaker add peer

BGP スピーカーにピアを追加します。

使用方法

openstack bgp speaker add peer [-h] <bgp-speaker> <bgp-peer>

Expand
表12.28 位置引数
概要

<bgp-speaker>

BGP スピーカー(名前または ID)

<bgp-peer>

追加する BGP ピア(名前または ID)

Expand
表12.29 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

12.10. bgp speaker create

BGP スピーカーを作成します。

使用方法

openstack bgp speaker create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] --local-as <local-as>
                                    [--ip-version {4,6}]
                                    [--advertise-floating-ip-host-routes]
                                    [--no-advertise-floating-ip-host-routes]
                                    [--advertise-tenant-networks]
                                    [--no-advertise-tenant-networks]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    <name>

Expand
表12.30 位置引数
概要

<name>

作成する bgp スピーカーの名前

Expand
表12.31 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--local-as <local-as>

数字で表現したローカル([1, 65535] の整数を使用可能)

--ip-version {4,6}

Bgp スピーカーの IP バージョン(デフォルトは 4)

--advertise-floating-ip-host-routes

BGP スピーカーにより Floating IP ホストルートの広告を有効にします(デフォルト)。

--no-advertise-floating-ip-host-routes

BGP スピーカーにより Floating IP ホストルートの広告を無効にします。

--advertise-tenant-networks

BGP スピーカーによりテナントネットワークルートの広告を有効にします(デフォルト)。

--no-advertise-tenant-networks

BGP スピーカーによりテナントネットワークルートの広告を無効にします。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表12.32 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表12.33 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表12.34 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表12.35 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

12.11. bgp speaker delete

BGP スピーカーを削除します。

使用方法

openstack bgp speaker delete [-h] <bgp-speaker>

Expand
表12.36 位置引数
概要

<bgp-speaker>

削除する BGP スピーカー(名前または ID)

Expand
表12.37 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

12.12. bgp speaker list advertised routes

広告されるルートを一覧表示します。

使用方法

openstack bgp speaker list advertised routes [-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]
                                                    <bgp-speaker>

Expand
表12.38 位置引数
概要

<bgp-speaker>

BGP スピーカー(名前または ID)

Expand
表12.39 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表12.40 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表12.41 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表12.42 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表12.43 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

12.13. bgp speaker list

BGP スピーカーを一覧表示します。

使用方法

openstack bgp speaker 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]
                                  [--agent <agent-id>]

Expand
表12.44 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--agent <agent-id>

エージェントがホストする bgp スピーカーの一覧を表示します(ID のみ)

Expand
表12.45 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表12.46 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表12.47 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表12.48 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

12.14. bgp speaker remove network

BGP スピーカーからのネットワークを削除します。

使用方法

openstack bgp speaker remove network [-h] <bgp-speaker> <network>

Expand
表12.49 位置引数
概要

<bgp-speaker>

BGP スピーカー(名前または ID)

<network>

削除するネットワーク(名前または ID)

Expand
表12.50 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

12.15. bgp speaker remove peer

BGP スピーカーからのピアを削除します。

使用方法

openstack bgp speaker remove peer [-h] <bgp-speaker> <bgp-peer>

Expand
表12.51 位置引数
概要

<bgp-speaker>

BGP スピーカー(名前または ID)

<bgp-peer>

削除する BGP ピア(名前または ID)

Expand
表12.52 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

12.16. bgp speaker set

BGP スピーカープロパティーを設定します。

使用方法

openstack bgp speaker set [-h] [--name NAME]
                                 [--advertise-floating-ip-host-routes]
                                 [--no-advertise-floating-ip-host-routes]
                                 [--advertise-tenant-networks]
                                 [--no-advertise-tenant-networks]
                                 <bgp-speaker>

Expand
表12.53 位置引数
概要

<bgp-speaker>

更新する BGP スピーカー(名前または ID)

Expand
表12.54 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

更新する bgp スピーカー名

--advertise-floating-ip-host-routes

BGP スピーカーにより Floating IP ホストルートの広告を有効にします(デフォルト)。

--no-advertise-floating-ip-host-routes

BGP スピーカーにより Floating IP ホストルートの広告を無効にします。

--advertise-tenant-networks

BGP スピーカーによりテナントネットワークルートの広告を有効にします(デフォルト)。

--no-advertise-tenant-networks

BGP スピーカーによりテナントネットワークルートの広告を無効にします。

12.17. bgp speaker show dragents

BGP スピーカーをホストする動的ルーティングエージェントを一覧で表示します。

使用方法

openstack bgp speaker show dragents [-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]
                                           <bgp-speaker>

Expand
表12.55 位置引数
概要

<bgp-speaker>

bgp スピーカーの ID または名前

Expand
表12.56 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表12.57 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表12.58 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表12.59 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表12.60 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

12.18. bgp speaker show

BGP スピーカーを表示します。

使用方法

openstack bgp speaker show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <bgp-speaker>

Expand
表12.61 位置引数
概要

<bgp-speaker>

表示する BGP スピーカー(名前または ID)

Expand
表12.62 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表12.63 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表12.64 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表12.65 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表12.66 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第13章 bgpvpn

本章では、bgpvpn コマンドに含まれるコマンドについて説明します。

13.1. bgpvpn create

BGP VPN リソースを作成します。

使用方法

openstack bgpvpn create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--project <project>]
                               [--project-domain <project-domain>]
                               [--name <name>] [--route-target <route-target>]
                               [--import-target <import-target>]
                               [--export-target <export-target>]
                               [--route-distinguisher <route-distinguisher>]
                               [--vni VNI] [--local-pref LOCAL_PREF]
                               [--type {l2,l3}]

Expand
表13.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--name <name>

Bgp vpn の名前

--route-target <route-target>

インポート/エクスポートリストにルートターゲットを追加します(複数のルートターゲットを指定する場合はオプションを繰り返します)

--import-target <import-target>

インポートするルートターゲットを追加します(複数のルートターゲットを指定する場合はオプションを繰り返します)。

--export-target <export-target>

エクスポートリストにルートターゲットを追加します(複数のルートターゲットを指定する場合はオプションを繰り返します)

--route-distinguisher <route-distinguisher>

Route Distinguisher を選択して VPN ルートを広告する一覧に Route Distinguisher を追加します (Route Distinguisher を複数指定するには、オプションを繰り返し使用します)。

--vni VNI

VXLAN カプセル化を使用する場合は、この bgpvpn に使用する VXLAN ネットワーク ID

--local-pref LOCAL_PREF

この BGPVPN へのルート広告に使用するデフォルトの bgp local_pref。

--type {l2,l3}

ip vpn (l3) と Ethernet VPN (l2) の間の Bgp vpn タイプの選択 (デフォルト: l3)

Expand
表13.2 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表13.3 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表13.4 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表13.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.2. bgpvpn delete

BGP VPN リソースを削除します。

使用方法

openstack bgpvpn delete [-h] <bgpvpn> [<bgpvpn> ...]

Expand
表13.6 位置引数
概要

<bgpvpn>

削除する BGP vpn (名前または ID)

Expand
表13.7 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

13.3. bgpvpn list

BGP VPN リソースを一覧表示します。

使用方法

openstack bgpvpn 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] [--project <project>]
                             [--project-domain <project-domain>] [--long]
                             [--property <key=value>]

Expand
表13.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--long

出力の追加フィールドを一覧表示します。

--property <key=value>

返された bgp vpns に適用する filter プロパティー(複数のプロパティーで絞り込むには繰り返し指定します)

Expand
表13.9 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表13.10 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表13.11 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表13.12 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.4. bgpvpn network association create

BGP VPN ネットワークの関連付けを作成します。

使用方法

openstack bgpvpn network association create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--project <project>]
                                                   [--project-domain <project-domain>]
                                                   <bgpvpn> <network>

Expand
表13.13 位置引数
概要

<bgpvpn>

ネットワークの関連付け(名前または ID)を適用する BGP vpn

<network>

Bgp vpn(名前または ID)を関連付けるネットワーク

Expand
表13.14 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表13.15 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表13.16 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表13.17 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表13.18 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.5. bgpvpn network association delete

特定の BGP VPN の BGP VPN ネットワーク関連付けを削除します。

使用方法

openstack bgpvpn network association delete [-h]
                                                   <network association ID>
                                                   [<network association ID> ...]
                                                   <bgpvpn>

Expand
表13.19 位置引数
概要

<network association ID>

削除するネットワークの関連付け ID

<bgpvpn>

ネットワークの関連付けが所属する BGP vpn(名前または ID)

Expand
表13.20 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

13.6. bgpvpn network association list

特定の BGP VPN の BGP VPN ネットワーク関連付けを一覧で表示します。

使用方法

openstack bgpvpn network association 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]
                                                 [--property <key=value>]
                                                 <bgpvpn>

Expand
表13.21 位置引数
概要

<bgpvpn>

記載の関連付けが(名前または ID)所属する bgp vpn

Expand
表13.22 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--property <key=value>

返された bgp vpns に適用する filter プロパティー(複数のプロパティーで絞り込むには繰り返し指定します)

Expand
表13.23 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表13.24 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表13.25 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表13.26 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.7. bgpvpn network association show

特定の BGP VPN ネットワーク関連付けの情報を表示します。

使用方法

openstack bgpvpn network association show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 <network association ID>
                                                 <bgpvpn>

Expand
表13.27 位置引数
概要

<network association ID>

検索するネットワークの関連付け ID

<bgpvpn>

この関連付けが所属する BGP vpn(名前または ID)

Expand
表13.28 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表13.29 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表13.30 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表13.31 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表13.32 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.8. bgpvpn port association create

BGP VPN ポートの関連付けを作成します。

使用方法

openstack bgpvpn port association create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--project <project>]
                                                [--project-domain <project-domain>]
                                                [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                                [--prefix-route prefix=<cidr>[,local_pref=<integer>]]
                                                [--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]]
                                                <bgpvpn> <port>

Expand
表13.33 位置引数
概要

<bgpvpn>

ポートの関連付け(名前または ID)を適用する BGP vpn

<port>

Bgp vpn(名前または ID)を関連付けるポート

Expand
表13.34 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--advertise-fixed-ips

ポートの固定 ip が bgp VPN に広告されます(デフォルト)。

--no-advertise-fixed-ips

ポートの固定 IP が BGP VPN に広告されません。

--prefix-route prefix=<cidr>[,local_pref=<integer>]

Cidr 表記でプレフィックスルートを追加します。オプションで、広告されるルートの BGP LOCAL_PREF の値を制御できます(複数のプレフィックスルートのオプション)。

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

ルートリークの bgp vpn ルートを追加します。オプションで、広告されるルートの BGP LOCAL_PREF の値を制御できます(複数の BGP VPN ルートのオプション)。

Expand
表13.35 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表13.36 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表13.37 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表13.38 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.9. bgp shared port association delete

特定の BGP VPN の BGP VPN ポートの関連付けを削除します。

使用方法

openstack bgpvpn port association delete [-h]
                                                <port association ID>
                                                [<port association ID> ...]
                                                <bgpvpn>

Expand
表13.39 位置引数
概要

<port association ID>

削除するポート関連 ID

<bgpvpn>

ポートの関連付けが属する bgp vpn(名前または ID)

Expand
表13.40 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

13.10. bgpvpn port association list

特定の BGP VPN の BGP VPN ポートの関連付けを一覧で表示します。

使用方法

openstack bgpvpn port association 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]
                                              [--property <key=value>]
                                              <bgpvpn>

Expand
表13.41 位置引数
概要

<bgpvpn>

記載の関連付けが(名前または ID)所属する bgp vpn

Expand
表13.42 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--property <key=value>

返された bgp vpns に適用する filter プロパティー(複数のプロパティーで絞り込むには繰り返し指定します)

Expand
表13.43 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表13.44 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表13.45 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表13.46 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.11. bgpvpn port association set

BGP VPN ポートの関連付けプロパティーを設定します。

使用方法

openstack bgpvpn port association set [-h]
                                             [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                             [--prefix-route prefix=<cidr>[,local_pref=<integer>]]
                                             [--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]]
                                             [--no-prefix-route]
                                             [--no-bgpvpn-route]
                                             <port association ID> <bgpvpn>

Expand
表13.47 位置引数
概要

<port association ID>

更新するポート関連付け ID

<bgpvpn>

ポートの関連付けが属する bgp vpn(名前または ID)

Expand
表13.48 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--advertise-fixed-ips

ポートの固定 ip が bgp VPN に広告されます。

--no-advertise-fixed-ips

ポートの固定 IP が BGP VPN に広告されません。

--prefix-route prefix=<cidr>[,local_pref=<integer>]

Cidr 表記でプレフィックスルートを追加します。オプションで、広告されるルートの BGP LOCAL_PREF の値を制御できます(複数のプレフィックスルートのオプション)。

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

ルートリークの bgp vpn ルートを追加します。オプションで、広告されるルートの BGP LOCAL_PREF の値を制御できます(複数の BGP VPN ルートのオプション)。

--no-prefix-route

空のプリフィックスルート一覧

--no-bgpvpn-route

Empty bgp vpn route list

13.12. bgp shared port association show

特定の BGP VPN ポートの関連付けの情報を表示します。

使用方法

openstack bgpvpn port association show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              <port association ID> <bgpvpn>

Expand
表13.49 位置引数
概要

<port association ID>

検索対象のポートの関連付け ID

<bgpvpn>

この関連付けが所属する BGP vpn(名前または ID)

Expand
表13.50 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表13.51 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表13.52 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表13.53 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表13.54 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.13. bgpvpn port association unset

BGP VPN ポートの関連付けプロパティーの設定を解除します。

使用方法

openstack bgpvpn port association unset [-h]
                                               [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                               [--prefix-route <cidr>]
                                               [--bgpvpn-route <BGP VPN ID or name>]
                                               [--all-prefix-routes]
                                               [--all-bgpvpn-routes]
                                               <port association ID> <bgpvpn>

Expand
表13.55 位置引数
概要

<port association ID>

更新するポート関連付け ID

<bgpvpn>

ポートの関連付けが属する bgp vpn(名前または ID)

Expand
表13.56 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--advertise-fixed-ips

ポートの固定 IP が BGP VPN に広告されません。

--no-advertise-fixed-ips

ポートの固定 ip が bgp VPN に広告されます。

--prefix-route <cidr>

Cidr 表記のプレフィックスルートを削除します(複数のプレフィックスルートを指定するにはオプションを繰り返し使用します)。

--bgpvpn-route <BGP VPN ID or name>

Bgp vpn ルートを削除します(複数の bgp VPN ルートの場合はオプションを繰り返し使用します)。

--all-prefix-routes

空のプリフィックスルート一覧

--all-bgpvpn-routes

Empty bgp vpn route list

13.14. bgpvpn router association create

BGP VPN ルーターの関連付けを作成します。

使用方法

openstack bgpvpn router association create [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--project <project>]
                                                  [--project-domain <project-domain>]
                                                  [--advertise_extra_routes | --no-advertise_extra_routes]
                                                  <bgpvpn> <router>

Expand
表13.57 位置引数
概要

<bgpvpn>

ルーターの関連付け(名前または ID)を適用する BGP vpn

<router>

Bgp vpn(名前または ID)を関連付けるルーター

Expand
表13.58 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--advertise_extra_routes

ルートは bgp vpn(デフォルト)に広告されます。

--no-advertise_extra_routes

ルーターからのルートは BGP VPN に広告されません。

Expand
表13.59 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表13.60 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表13.61 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表13.62 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.15. bgpvpn router association delete

特定の BGP VPN の BGP VPN ルーターの関連付けを削除します。

使用方法

openstack bgpvpn router association delete [-h]
                                                  <router association ID>
                                                  [<router association ID> ...]
                                                  <bgpvpn>

Expand
表13.63 位置引数
概要

<router association ID>

削除するルーターの関連付け ID

<bgpvpn>

ルーターの関連付けが所属する bgp vpn(名前または ID)

Expand
表13.64 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

13.16. bgpvpn router association list

特定の BGP VPN の BGP VPN ルーターの関連付けを一覧表示します。

使用方法

openstack bgpvpn router association 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]
                                                [--property <key=value>]
                                                <bgpvpn>

Expand
表13.65 位置引数
概要

<bgpvpn>

記載の関連付けが(名前または ID)所属する bgp vpn

Expand
表13.66 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--property <key=value>

返された bgp vpns に適用する filter プロパティー(複数のプロパティーで絞り込むには繰り返し指定します)

Expand
表13.67 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表13.68 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表13.69 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表13.70 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.17. bgpvpn router association set

BGP VPN ルーター関連付けプロパティーを設定します。

使用方法

openstack bgpvpn router association set [-h]
                                               [--advertise_extra_routes | --no-advertise_extra_routes]
                                               <router association ID>
                                               <bgpvpn>

Expand
表13.71 位置引数
概要

<router association ID>

更新するルーターの関連付け ID

<bgpvpn>

ルーターの関連付けが所属する bgp vpn(名前または ID)

Expand
表13.72 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--advertise_extra_routes

ルートは bgp vpn に広告されます。

--no-advertise_extra_routes

ルーターからのルートは BGP VPN に広告されません。

13.18. bgpvpn router association show

特定の BGP VPN ルーターの関連付けの情報を表示します。

使用方法

openstack bgpvpn router association show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                <router association ID>
                                                <bgpvpn>

Expand
表13.73 位置引数
概要

<router association ID>

検索するルーターの関連付け ID

<bgpvpn>

この関連付けが所属する BGP vpn(名前または ID)

Expand
表13.74 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表13.75 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表13.76 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表13.77 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表13.78 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.19. bgpvpn router association unset

BGP VPN ルーターの関連付けプロパティーの設定を解除します。

使用方法

openstack bgpvpn router association unset [-h]
                                                 [--advertise_extra_routes | --no-advertise_extra_routes]
                                                 <router association ID>
                                                 <bgpvpn>

Expand
表13.79 位置引数
概要

<router association ID>

更新するルーターの関連付け ID

<bgpvpn>

ルーターの関連付けが所属する bgp vpn(名前または ID)

Expand
表13.80 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--advertise_extra_routes

ルーターからのルートは BGP VPN に広告されません。

--no-advertise_extra_routes

ルートは bgp vpn に広告されます。

13.20. bgpvpn set

BGP VPN プロパティーを設定します。

使用方法

openstack bgpvpn set [-h] [--name <name>]
                            [--route-target <route-target>]
                            [--no-route-target]
                            [--import-target <import-target>]
                            [--no-import-target]
                            [--export-target <export-target>]
                            [--no-export-target]
                            [--route-distinguisher <route-distinguisher>]
                            [--no-route-distinguisher] [--vni VNI]
                            [--local-pref LOCAL_PREF]
                            <bgpvpn>

Expand
表13.81 位置引数
概要

<bgpvpn>

更新する BGP vpn(名前または ID)

Expand
表13.82 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

Bgp vpn の名前

--route-target <route-target>

インポート/エクスポートリストにルートターゲットを追加します(複数のルートターゲットを指定する場合はオプションを繰り返します)

--no-route-target

空のルートターゲット一覧

--import-target <import-target>

インポートするルートターゲットを追加します(複数のルートターゲットを指定する場合はオプションを繰り返します)。

--no-import-target

空のインポートルートターゲット一覧

--export-target <export-target>

エクスポートリストにルートターゲットを追加します(複数のルートターゲットを指定する場合はオプションを繰り返します)

--no-export-target

空のエクスポートルートターゲット一覧

--route-distinguisher <route-distinguisher>

Route Distinguisher を選択して VPN ルートを広告する一覧に Route Distinguisher を追加します (Route Distinguisher を複数指定するには、オプションを繰り返し使用します)。

--no-route-distinguisher

空のroute distinguisher 一覧

--vni VNI

VXLAN カプセル化を使用する場合は、この bgpvpn に使用する VXLAN ネットワーク ID

--local-pref LOCAL_PREF

この BGPVPN へのルート広告に使用するデフォルトの bgp local_pref。

13.21. bgpvpn show

特定の BGP VPN の情報を表示します。

使用方法

openstack bgpvpn show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <bgpvpn>

Expand
表13.83 位置引数
概要

<bgpvpn>

表示する BGP vpn(名前または ID)

Expand
表13.84 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表13.85 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表13.86 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表13.87 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表13.88 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.22. bgpvpn unset

BGP VPN プロパティーの設定を解除します。

使用方法

openstack bgpvpn unset [-h] [--route-target <route-target>]
                              [--all-route-target]
                              [--import-target <import-target>]
                              [--all-import-target]
                              [--export-target <export-target>]
                              [--all-export-target]
                              [--route-distinguisher <route-distinguisher>]
                              [--all-route-distinguisher] [--vni VNI]
                              [--local-pref LOCAL_PREF]
                              <bgpvpn>

Expand
表13.89 位置引数
概要

<bgpvpn>

更新する BGP vpn(名前または ID)

Expand
表13.90 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--route-target <route-target>

インポート/エクスポートリストからルートターゲットを削除します(複数のルートターゲットを指定する場合はオプションを繰り返します)。

--all-route-target

空のルートターゲット一覧

--import-target <import-target>

インポート一覧からルートターゲットを削除します(複数のルートターゲットを指定する場合はオプションを繰り返します)。

--all-import-target

空のインポートルートターゲット一覧

--export-target <export-target>

エクスポートリストからルートターゲットを削除します(複数のルートターゲットを指定する場合はオプションを繰り返します)。

--all-export-target

空のエクスポートルートターゲット一覧

--route-distinguisher <route-distinguisher>

Route Distinguisher を選択して VPN ルートを広告する一覧から Route Distinguisher を削除します (Route Distinguisher を複数指定するには、オプションを繰り返し使用します)。

--all-route-distinguisher

空のroute distinguisher 一覧

--vni VNI

VXLAN カプセル化を使用する場合は、この bgpvpn に使用する VXLAN ネットワーク ID

--local-pref LOCAL_PREF

この BGPVPN へのルート広告に使用するデフォルトの bgp local_pref。

第14章 ca

本章では、ca コマンドに含まれるコマンドについて説明します。

14.1. ca get

URI を指定して CA を取得します。

使用方法

openstack ca get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                        [--noindent] [--prefix PREFIX] [--max-width <integer>]
                        [--fit-width] [--print-empty]
                        URI

Expand
表14.1 位置引数
概要

URI

Ca の URI 参照。

Expand
表14.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表14.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表14.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表14.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表14.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

14.2. ca list

CA を一覧表示します。

使用方法

openstack ca 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]
                         [--offset OFFSET] [--name NAME]

Expand
表14.7 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit LIMIT, -l LIMIT

ページごとに表示する項目数に制限を指定します(デフォルト:10、最大: 100)。

--offset OFFSET, -o OFFSET

ページのオフセットを指定します(デフォルト:0)。

--name NAME, -n NAME

Ca 名を指定します(デフォルト:none)。

Expand
表14.8 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表14.9 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表14.10 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表14.11 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第15章 catalog

本章では、catalog コマンドに含まれるコマンドについて説明します。

15.1. catalog list

サービスカタログのサービスを一覧表示します。

使用方法

openstack catalog 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]

Expand
表15.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表15.2 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表15.3 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表15.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表15.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

15.2. catalog show

サービスカタログの詳細を表示します。

使用方法

openstack catalog show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <service>

Expand
表15.6 位置引数
概要

<service>

表示するサービス(タイプまたは名前)

Expand
表15.7 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表15.8 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表15.9 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表15.10 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表15.11 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第16章 coe

本章では、coe コマンドに含まれるコマンドについて説明します。

16.1. coe ca rotate

クラスターがアクセスを取り消すために CA 証明書をローテーションします。

使用方法

openstack coe ca rotate [-h] <cluster>

Expand
表16.1 位置引数
概要

<cluster>

クラスターの ID または名前

Expand
表16.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

16.2. coe ca show

クラスターの CA 証明書の詳細を表示します。

使用方法

openstack coe ca show [-h] <cluster>

Expand
表16.3 位置引数
概要

<cluster>

クラスターの ID または名前

Expand
表16.4 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

16.3. coe ca sign

クラスターの CA 証明書を生成します。

使用方法

openstack coe ca sign [-h] <cluster> <csr>

Expand
表16.5 位置引数
概要

<cluster>

クラスターの ID または名前

<csr>

署名を取得するために magnum に送信する csr ファイルのファイルパス。

Expand
表16.6 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

16.4. coe cluster config

クラスターの設定を取得します。

使用方法

openstack coe cluster config [-h] [--dir <dir>] [--force]
                                    [--output-certs] [--use-certificate]
                                    [--use-keystone]
                                    <cluster>

Expand
表16.7 位置引数
概要

<cluster>

更新するクラスターの名前または UUID

Expand
表16.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--dir <dir>

証明書と設定ファイルを保存するディレクトリー。

--force

ファイルが存在する場合には、ファイルを上書きします。

--output-certs

別のファイルに証明書を出力します。

--use-certificate

設定ファイルで証明書を使用します。

--use-keystone

設定ファイルで keystone トークンを使用します。

16.5. coe cluster create

クラスターを作成します。

使用方法

openstack coe cluster create [-h] --cluster-template <cluster-template>
                                    [--discovery-url <discovery-url>]
                                    [--docker-volume-size <docker-volume-size>]
                                    [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                    [--keypair <keypair>]
                                    [--master-count <master-count>]
                                    [--node-count <node-count>]
                                    [--timeout <timeout>]
                                    [--master-flavor <master-flavor>]
                                    [--flavor <flavor>]
                                    <name>

Expand
表16.9 位置引数
概要

<name>

作成するクラスターの名前。

Expand
表16.10 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--cluster-template <cluster-template>

クラスターテンプレートの ID または名前

--discovery-url <discovery-url>

ノード検出用のカスタム配信 URL を指定します。

--docker-volume-size <docker-volume-size>

Docker ボリュームが使用するサイズ (gb 単位)。

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

クラスターテンプレートに関連付ける key=valuepairs 形式の任意のラベル。複数回の使用が可能です。

--keypair <keypair>

使用するキーペアの UUID または名前。

--master-count <master-count>

クラスターのマスターノードの数。

--node-count <node-count>

クラスターノードの数。

--timeout <timeout>

クラスター作成時間のタイムアウト。デフォルトは 60 分です。

--master-flavor <master-flavor>

クラスターのマスターノードを起動する時に使用する nova フレーバーの名前または UUID。

--flavor <flavor>

クラスターの起動時に使用する nova フレーバーの名前または UUID。

16.6. coe cluster delete

クラスターを削除します。

使用方法

openstack coe cluster delete [-h] <cluster> [<cluster> ...]

Expand
表16.11 位置引数
概要

<cluster>

削除するクラスターの ID または名前。

Expand
表16.12 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

16.7. coe cluster list

クラスターを一覧表示します。

使用方法

openstack coe cluster 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>] [--sort-key <sort-key>]
                                  [--sort-dir <sort-dir>]

Expand
表16.13 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

返すことのできるクラスターの最大数。

--sort-key <sort-key>

結果を並べ替えるコラム

--sort-dir <sort-dir>

ソートの方向。「asc」または「desc」。

Expand
表16.14 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表16.15 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表16.16 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表16.17 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.8. coe cluster show

クラスターを表示します。

使用方法

openstack coe cluster show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <cluster>

Expand
表16.18 位置引数
概要

<cluster>

表示するクラスターの ID または名前。

Expand
表16.19 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表16.20 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表16.21 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表16.22 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表16.23 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.9. coe cluster template create

クラスターテンプレートを作成します。

使用方法

openstack coe cluster template create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             --coe <coe> --image <image>
                                             --external-network
                                             <external-network>
                                             [--keypair <keypair>]
                                             [--fixed-network <fixed-network>]
                                             [--fixed-subnet <fixed-subnet>]
                                             [--network-driver <network-driver>]
                                             [--volume-driver <volume-driver>]
                                             [--dns-nameserver <dns-nameserver>]
                                             [--flavor <flavor>]
                                             [--master-flavor <master-flavor>]
                                             [--docker-volume-size <docker-volume-size>]
                                             [--docker-storage-driver <docker-storage-driver>]
                                             [--http-proxy <http-proxy>]
                                             [--https-proxy <https-proxy>]
                                             [--no-proxy <no-proxy>]
                                             [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                             [--tls-disabled] [--public]
                                             [--registry-enabled]
                                             [--server-type <server-type>]
                                             [--master-lb-enabled]
                                             [--floating-ip-enabled]
                                             [--floating-ip-disabled]
                                             <name>

Expand
表16.24 位置引数
概要

<name>

作成するクラスターテンプレートの名前。

Expand
表16.25 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--Coe <coe>

使用するコンテナーオーケストレーションエンジンを指定します。

--image <image>

クラスター用にカスタマイズするベースイメージの名前または UUID。

--external-network <external-network>

このクラスターテンプレートに接続するための外部 neutron ネットワーク名または uuid。

--keypair <keypair>

クラスターノードに読み込む ssh キーペアの名前または UUID。

--fixed-network <fixed-network>

このクラスターモデルに接続するためのプライベート neutron ネットワーク名

--fixed-subnet <fixed-subnet>

クラスターに接続するためのプライベート neutron サブネット名。

--network-driver <network-driver>

コンテナーネットワークをインスタンス化するためのネットワークドライバー名。

--volume-driver <volume-driver>

コンテナーボリュームをインスタンス化するボリュームドライバー名。

--dns-nameserver <dns-nameserver>

このクラスターテンプレートに使用する dns ネームサーバー。

--flavor <flavor>

クラスターの起動時に使用する nova フレーバーの名前または UUID。

--master-flavor <master-flavor>

クラスターのマスターノードを起動する時に使用する nova フレーバーの名前または UUID。

--docker-volume-size <docker-volume-size>

Docker ボリュームで使用するサイズを GB 単位で指定します。

--docker-storage-driver <docker-storage-driver>

Docker ストレージドライバーを選択します。サポートされているドライバー:devicemapper、overlay。デフォルト:devicemapper

--http-proxy <http-proxy>

クラスターのノードに使用する http_proxy アドレス。

--https-proxy <https-proxy>

クラスターのノードに使用する https_proxy アドレス。

--no-proxy <no-proxy>

クラスターのノードに使用する no_proxy アドレス。

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

クラスターテンプレートに関連付ける key=value ペアの形式の任意のラベル。複数回の使用が可能です。

--tls-disabled

クラスターの tls を無効にします。

--public

クラスターテンプレートをパブリックにします。

--registry-enabled

クラスターでの docker レジストリーを有効化します。

--server-type <server-type>

Vm など、使用するサーバータイプを指定します。このリリースのデフォルトサーバータイプは vm です。

--master-lb-enabled

作成したクラスターにマスターノードのロードバランサーがあるかどうかを指定します。

--floating-ip-enabled

作成したクラスターに Floating IP が必要であるかどうかを指定します。

--floating-ip-disabled

新規クラスターでの Floating IP 作成を無効にします。

Expand
表16.26 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表16.27 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表16.28 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表16.29 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.10. coe cluster template delete

クラスターテンプレートを削除します。

使用方法

openstack coe cluster template delete [-h]
                                             <cluster-templates>
                                             [<cluster-templates> ...]

Expand
表16.30 位置引数
概要

<cluster-templates>

削除するクラスターテンプレートの ID または名前

Expand
表16.31 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

16.11. coe cluster template list

クラスターテンプレートを一覧表示します。

使用方法

openstack coe cluster 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>]
                                           [--sort-key <sort-key>]
                                           [--sort-dir <sort-dir>]
                                           [--fields <fields>]

Expand
表16.32 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

返すことのできるクラスターテンプレートの最大数。

--sort-key <sort-key>

結果を並べ替えるコラム

--sort-dir <sort-dir>

ソートの方向。「asc」または「desc」。

--fields <fields>

表示するフィールドのコンマ区切りリスト。uuid、name、coe、image_id、public、link、apiserver_port、server_type、tls_disabled、registry_enabled

Expand
表16.33 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表16.34 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表16.35 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表16.36 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.12. coe cluster template show

クラスターテンプレートを表示します。

使用方法

openstack coe cluster template show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           <cluster-template>

Expand
表16.37 位置引数
概要

<cluster-template>

表示するクラスターテンプレートの ID または名前。

Expand
表16.38 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表16.39 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表16.40 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表16.41 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表16.42 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.13. coe cluster template update

クラスターテンプレートを更新します。

使用方法

openstack coe cluster template update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <cluster-template> <op>
                                             <path=value> [<path=value> ...]

Expand
表16.43 位置引数
概要

<cluster-template>

更新するクラスターテンプレートの名前または UUID

<op>

操作:addreplace、または remove のいずれか

<path=value>

追加/置換または削除する属性(削除時にパスのみが必要)

Expand
表16.44 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表16.45 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表16.46 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表16.47 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表16.48 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.14. coe cluster update

クラスターを更新します。

使用方法

openstack coe cluster update [-h] [--rollback]
                                    <cluster> <op> <path=value>
                                    [<path=value> ...]

Expand
表16.49 位置引数
概要

<cluster>

更新するクラスターの名前または UUID

<op>

操作:addreplace、または remove のいずれか

<path=value>

追加/置換または削除する属性(削除時にパスのみが必要)

Expand
表16.50 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--rollback

更新の失敗時のクラスターをロールバックします。

16.15. coe quotas create

クォータを作成します。

使用方法

openstack coe quotas create [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

Expand
表16.51 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-id <project-id>

プロジェクト ID

--resource <resource>

リソース名。

--hard-limit <hard-limit>

最大リソース制限(デフォルト:hard-limit=1)

16.16. coe quotas delete

指定のリソースクォータを削除します。

使用方法

openstack coe quotas delete [-h] --project-id <project-id> --resource
                                   <resource>

Expand
表16.52 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-id <project-id>

プロジェクト ID

--resource <resource>

リソース名。

16.17. coe quotas list

利用可能なクォータ一覧を出力します。

使用方法

openstack coe quotas list [-h] [--marker <marker>] [--limit <limit>]
                                 [--sort-key <sort-key>]
                                 [--sort-dir <sort-dir>] [--all-tenants]

Expand
表16.53 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker <marker>

直前のページにある最後のクォータ uuid。「マーカー」の後ろのクォータの一覧を表示します。

--limit <limit>

返すことのできるクォータの最大数。

--sort-key <sort-key>

結果を並べ替えるコラム。

--sort-dir <sort-dir>

ソートの方向。「asc」または「desc」。

--all-tenants

すべてのテナントクォータの一覧を表示するように指定するフラグ。

16.18. coe quotas show

指定のプロジェクトリソースのクォータの詳細を表示します。

使用方法

openstack coe quotas show [-h] --project-id <project-id> --resource
                                 <resource>

Expand
表16.54 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-id <project-id>

プロジェクト ID

--resource <resource>

リソース名。

16.19. coe quotas update

指定のプロジェクトリソースクォータの情報を更新します。

使用方法

openstack coe quotas update [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

Expand
表16.55 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-id <project-id>

プロジェクト ID

--resource <resource>

リソース名。

--hard-limit <hard-limit>

最大リソース制限(デフォルト:hard-limit=1)

16.20. coe service list

Magnum サービスの一覧を出力します。

使用方法

openstack coe service 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]

Expand
表16.56 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表16.57 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表16.58 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表16.59 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表16.60 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.21. coe stats list

指定の project_id の統計を表示します。

使用方法

openstack coe stats list [-h] <project>

Expand
表16.61 位置引数
概要

<project>

プロジェクト ID

Expand
表16.62 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

第17章 command

本章では、command コマンドに含まれるコマンドについて説明します。

17.1. コマンドリスト

グループ別に認識されているコマンドを一覧表示します。

使用方法

openstack command 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]
                              [--group <group-keyword>]

Expand
表17.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--group {keywor>

コマンドグループでフィルターされたコマンドを表示します(例:identity、volume、compute、image、network、およびその他のキーワード)。

Expand
表17.2 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表17.3 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表17.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表17.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第18章 complete.adoc

本章では、complete.adoc コマンドに含まれるコマンドについて説明します。

18.1. complete

バッシュ補完コマンドを出力します。

使用方法

openstack complete [-h] [--name <command_name>] [--shell <shell>]

Expand
表18.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <command_name>

コマンド補完でサポートされるコマンド名

--shell <shell>

使用するシェル。データのみの場合には none を使用します(デフォルト:bash)。

第19章 compute

本章では、compute コマンドに含まれるコマンドについて説明します。

19.1. compute agent create

コンピュートエージェントを作成します。

使用方法

openstack compute agent create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <os> <architecture> <version> <url>
                                      <md5hash> <hypervisor>

Expand
表19.1 位置引数
概要

<os>

OS のタイプ

<architecture>

アーキテクチャーのタイプ

<version>

バージョン

<url>

Url

<md5hash>

Md5 ハッシュ

<hypervisor>

ハイパーバイザーの種別

Expand
表19.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表19.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表19.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表19.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表19.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

19.2. Compute agent delete

コンピュートエージェントを削除します。

使用方法

openstack compute agent delete [-h] <id> [<id> ...]

Expand
表19.7 位置引数
概要

<id>

削除するエージェントの ID

Expand
表19.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

19.3. compute agent list

コンピュートエージェントを一覧表示します。

使用方法

openstack compute agent 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]
                                    [--hypervisor <hypervisor>]

Expand
表19.9 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--hypervisor <hypervisor>

ハイパーバイザーの種別

Expand
表19.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表19.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表19.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表19.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

19.4. compute agent set

コンピュートエージェントのプロパティーを設定します。

使用方法

openstack compute agent set [-h] [--agent-version <version>]
                                   [--url <url>] [--md5hash <md5hash>]
                                   <id>

Expand
表19.14 位置引数
概要

<id>

エージェントの ID

Expand
表19.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--agent-version <version>

エージェントのバージョン

--url <url>

エージェントの URL

--md5hash <md5hash>

エージェントの Md5 ハッシュ

19.5. compute service delete

コンピュートサービスを削除します。

使用方法

openstack compute service delete [-h] <service> [<service> ...]

Expand
表19.16 位置引数
概要

<service>

削除する Compute サービス(id のみ)。''--os-compute- api-version'' で 2.53 以降を使用している場合、ID は UUID で、同じ 2.53+ マイクロバージョンを使用してコンピュートサービスを一覧表示して取得できます。

Expand
表19.17 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

19.6. compute service list

コンピュートサービスを一覧表示します。''--os-compute-api-version'' 2.53 以降を使用すると、ID は UUID 値として返されます。これは、マルチセルデプロイメントでサービスを一意に識別するために使用できます。

使用方法

openstack compute service 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]
                                      [--host <host>] [--service <service>]
                                      [--long]

Expand
表19.18 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--host <host>

指定したホストでサービスを一覧表示します(名前のみ)。

--service <service>

指定されたサービスのみを一覧表示します(名前のみ)。

--long

出力の追加フィールドを一覧表示します。

Expand
表19.19 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表19.20 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表19.21 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表19.22 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

19.7. compute service set

コンピュートサービス属性を設定します。

使用方法

openstack compute service set [-h] [--enable | --disable]
                                     [--disable-reason <reason>]
                                     [--up | --down]
                                     <host> <service>

Expand
表19.23 位置引数
概要

<host>

ホスト名

<service>

サービスの名前(バイナリー名)

Expand
表19.24 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--enable

サービスを有効化します。

--disable

サービスを無効化します。

--disable-reason <reason>

サービスを無効にする理由(引用符で囲む)。--disable オプションと併用する必要があります。

--up

サービスの強制

--down

サービスの強制停止

第20章 configuration

本章では、configuration コマンドに含まれるコマンドについて説明します。

20.1. configuration show

設定を詳細表示します。

使用方法

openstack configuration show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--mask | --unmask]

Expand
表20.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--mask

パスワードのマスクを試行します(デフォルト)

--unmask

パスワードをクリアテキストで表示します。

Expand
表20.2 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表20.3 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表20.4 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表20.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第21章 一貫性

本章では、consistency コマンドに含まれるコマンドについて説明します。

21.1. consistency group add volume

整合性グループにボリュームを追加します。

使用方法

openstack consistency group add volume [-h]
                                              <consistency-group> <volume>
                                              [<volume> ...]

Expand
表21.1 位置引数
概要

<consistency-group>

<volume> を含む整合性グループ (名前または id)

<volume>

<consistency-group> (名前または id) に追加するボリューム (複数のボリュームを追加する場合はオプションを繰り返し使用します)

Expand
表21.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

21.2. consistency group create

新規整合性グループを作成します。

使用方法

openstack consistency group create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          (--volume-type <volume-type> | --consistency-group-source <consistency-group> | --consistency-group-snapshot <consistency-group-snapshot>)
                                          [--description <description>]
                                          [--availability-zone <availability-zone>]
                                          [<name>]

Expand
表21.3 位置引数
概要

<name>

新規整合性グループの名前(デフォルトは none)

Expand
表21.4 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--volume-type <volume-type>

この整合性グループのボリューム種別(名前または ID)

--consistency-group-source <consistency-group>

既存の整合性グループ(名前または ID)

--consistency-group-snapshot <consistency-group-snapshot>

既存の整合性グループのスナップショット(名前または ID)

--description <description>

この整合性グループの説明

--availability-zone <availability-zone>

この整合性グループのアベイラビリティーゾーン(ソースから整合性グループを作成する場合は利用できません)

Expand
表21.5 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表21.6 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表21.7 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表21.8 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

21.3. consistency group delete

整合性グループを削除します。

使用方法

openstack consistency group delete [-h] [--force]
                                          <consistency-group>
                                          [<consistency-group> ...]

Expand
表21.9 位置引数
概要

<consistency-group>

削除する整合性グループ(名前または ID)

Expand
表21.10 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--force

Error または available 以外の状態で削除を可能にします。

21.4. consistency group list

整合性グループを一覧表示します。

使用方法

openstack consistency group 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]
                                        [--all-projects] [--long]

Expand
表21.11 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの詳細を表示します。管理者のみ(デフォルトは False)

--long

出力の追加フィールドを一覧表示します。

Expand
表21.12 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表21.13 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表21.14 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表21.15 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

21.5. consistency group remove volume

整合性グループからボリュームを削除します。

使用方法

openstack consistency group remove volume [-h]
                                                 <consistency-group> <volume>
                                                 [<volume> ...]

Expand
表21.16 位置引数
概要

<consistency-group>

<volume>(名前または ID)を含む整合性グループ

<volume>

<consistency-group> (名前または id) から削除するボリューム (複数のボリュームを削除する場合はオプションを繰り返し使用します)

Expand
表21.17 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

21.6. consistency group set

整合性グループのプロパティーを設定します。

使用方法

openstack consistency group set [-h] [--name <name>]
                                       [--description <description>]
                                       <consistency-group>

Expand
表21.18 位置引数
概要

<consistency-group>

変更する整合性グループ(名前または ID)

Expand
表21.19 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

整合性グループの新しい名前

--description <description>

整合性グループの新たな説明

21.7. consistency group show

整合性グループの詳細を表示します。

使用方法

openstack consistency group show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <consistency-group>

Expand
表21.20 位置引数
概要

<consistency-group>

表示する整合性グループ(名前または ID)

Expand
表21.21 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表21.22 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表21.23 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表21.24 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表21.25 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

21.8. consistency group snapshot create

新規整合性グループのスナップショットを作成します。

使用方法

openstack consistency group snapshot create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--consistency-group <consistency-group>]
                                                   [--description <description>]
                                                   [<snapshot-name>]

Expand
表21.26 位置引数
概要

<snapshot-name>

新規整合性グループのスナップショット名(デフォルトは None)

Expand
表21.27 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--consistency-group <consistency-group>

スナップショット(名前または ID)を作成する整合性グループ(デフォルトは <snapshot-name> と同じ)

--description <description>

この整合性グループのスナップショットの説明

Expand
表21.28 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表21.29 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表21.30 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表21.31 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

21.9. consistency group snapshot delete

整合性グループのスナップショットを削除します。

使用方法

openstack consistency group snapshot delete [-h]
                                                   <consistency-group-snapshot>
                                                   [<consistency-group-snapshot> ...]

Expand
表21.32 位置引数
概要

<consistency-group-snapshot>

削除する整合性グループのスナップショット(名前または ID)

Expand
表21.33 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

21.10. consistency group snapshot list

整合性グループのスナップショットを一覧表示します。

使用方法

openstack consistency group snapshot 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]
                                                 [--all-projects] [--long]
                                                 [--status <status>]
                                                 [--consistency-group <consistency-group>]

Expand
表21.34 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの詳細を表示します。管理者のみ(デフォルトは False)

--long

出力の追加フィールドを一覧表示します。

--status <status>

ステータスで結果をフィルターします(「available」、「error」、「deleting」、「deleting」、または「error_deleting」)。

--consistency-group <consistency-group>

整合性グループ(名前または ID)で結果をフィルターします。

Expand
表21.35 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表21.36 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表21.37 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表21.38 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

21.11. consistency group snapshot show

整合性グループのスナップショットの詳細を表示します。

使用方法

openstack consistency group snapshot show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 <consistency-group-snapshot>

Expand
表21.39 位置引数
概要

<consistency-group-snapshot>

表示する整合性グループのスナップショット(名前または ID)

Expand
表21.40 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表21.41 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表21.42 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表21.43 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表21.44 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第22章 console

本章では、console コマンドに含まれるコマンドについて説明します。

22.1. console log show

サーバーのコンソール出力を表示します。

使用方法

openstack console log show [-h] [--lines <num-lines>] <server>

Expand
表22.1 位置引数
概要

<server>

コンソールログ(名前または ID)を表示するサーバー

Expand
表22.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--lines <num-lines>

ログの末尾から表示する行数(デフォルト=all)。

22.2. console url show

サーバーのリモートコンソール URL を表示します。

使用方法

openstack console url show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  [--novnc | --xvpvnc | --spice | --rdp | --serial | --mks]
                                  <server>

Expand
表22.3 位置引数
概要

<server>

URL(名前または ID)を表示するサーバー

Expand
表22.4 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--novnc

Novnc コンソール URL を表示します(デフォルト)

--xvpvnc

Xvpvnc コンソール URL を表示します。

--SPICE

Spice コンソールの URL を表示します。

--rdp

Rdp コンソールの URL を表示します。

--serial

シリアルコンソールの URL を表示します。

--mks

Webmks コンソールの URL を表示します。

Expand
表22.5 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表22.6 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表22.7 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表22.8 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第23章 consumer

本章では、consumer コマンドに含まれるコマンドについて説明します。

23.1. consumer create

新規コンシューマーを作成します。

使用方法

openstack consumer create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--description <description>]

Expand
表23.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

新規コンシューマーの説明

Expand
表23.2 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表23.3 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表23.4 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表23.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

23.2. consumer delete

コンシューマーを削除します。

使用方法

openstack consumer delete [-h] <consumer> [<consumer> ...]

Expand
表23.6 位置引数
概要

<consumer>

削除するコンシューマー

Expand
表23.7 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

23.3. consumer list

コンシューマーを一覧表示します。

使用方法

openstack consumer 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]

Expand
表23.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表23.9 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表23.10 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表23.11 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表23.12 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

23.4. consumer set

コンシューマープロパティーを設定します。

使用方法

openstack consumer set [-h] [--description <description>] <consumer>

Expand
表23.13 位置引数
概要

<consumer>

変更するコンシューマー

Expand
表23.14 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

新規コンシューマーの説明

23.5. consumer show

コンシューマーの詳細を表示します。

使用方法

openstack consumer show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               <consumer>

Expand
表23.15 位置引数
概要

<consumer>

表示するコンシューマー

Expand
表23.16 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表23.17 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表23.18 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表23.19 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表23.20 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第24章 container

本章では、container コマンドに含まれるコマンドについて説明します。

24.1. container create

新規コンテナーを作成します。

使用方法

openstack container 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]
                                  <container-name> [<container-name> ...]

Expand
表24.1 位置引数
概要

<container-name>

新しいコンテナー名

Expand
表24.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表24.3 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表24.4 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表24.5 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表24.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

24.2. container delete

コンテナーを削除します。

使用方法

openstack container delete [-h] [--recursive]
                                  <container> [<container> ...]

Expand
表24.7 位置引数
概要

<container>

削除するコンテナー

Expand
表24.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--recursive, -r

オブジェクトおよびコンテナーを再帰的に削除します。

24.3. container list

コンテナーの一覧表示

使用方法

openstack container 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]
                                [--prefix <prefix>] [--marker <marker>]
                                [--end-marker <end-marker>]
                                [--limit <num-containers>] [--long] [--all]

Expand
表24.9 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--prefix <prefix>

<prefix> を使用して一覧をフィルターします。

--marker <marker>

ページングのアンカー

--end-marker <end-marker>

ページングの終了アンカー

--limit <num-containers>

返されるコンテナーの数を制限します。

--long

出力の追加フィールドを一覧表示します。

--all

すべてのコンテナーを一覧表示します(デフォルトは 10000)。

Expand
表24.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表24.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表24.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表24.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

24.4. container save

コンテナーのコンテンツをローカルで保存します。

使用方法

openstack container save [-h] <container>

Expand
表24.14 位置引数
概要

<container>

保存するコンテナー

Expand
表24.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

24.5. container set

コンテナープロパティーを設定します。

使用方法

openstack container set [-h] --property <key=value> <container>

Expand
表24.16 位置引数
概要

<container>

変更するコンテナー

Expand
表24.17 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key=value>

このコンテナーにプロパティーを設定します(複数のプロパティーを設定する場合はオプションを繰り返し使用します)

24.6. container show

コンテナーの詳細を表示します。

使用方法

openstack container show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                <container>

Expand
表24.18 位置引数
概要

<container>

表示するコンテナー

Expand
表24.19 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表24.20 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表24.21 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表24.22 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表24.23 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

24.7. container unset

コンテナーのプロパティーの設定を解除します。

使用方法

openstack container unset [-h] --property <key> <container>

Expand
表24.24 位置引数
概要

<container>

変更するコンテナー

Expand
表24.25 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key>

コンテナーから削除するプロパティー(複数のプロパティーを削除する場合はオプションを繰り返し使用します)

第25章 credential

本章では、credential コマンドに含まれるコマンドについて説明します。

25.1. credential create

新規認証情報を作成します。

使用方法

openstack credential create [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty] [--type <type>]
                                   [--project <project>]
                                   <user> <data>

Expand
表25.1 位置引数
概要

<user>

認証情報を所有するユーザー(名前または ID)

<data>

新しい認証情報データ

Expand
表25.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--type <type>

新規の認証タイプ:cert、ec2、tp など

--project <project>

認証情報の範囲を制限するプロジェクト(名前または ID)

Expand
表25.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表25.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表25.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表25.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

25.2. credential delete

認証情報を削除します。

使用方法

openstack credential delete [-h] <credential-id> [<credential-id> ...]

Expand
表25.7 位置引数
概要

<credential-id>

削除する認証情報の ID

Expand
表25.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

25.3. credential list

認証情報を一覧表示します。

使用方法

openstack 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>] [--type <type>]

Expand
表25.9 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--user <user>

<user>(名前または ID)別に認証情報をフィルターします。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

--type <type>

タイプで認証情報をフィルターします(cert、ec2、totp など)。

Expand
表25.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表25.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表25.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表25.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

25.4. credential set

認証情報のプロパティーを設定します。

使用方法

openstack credential set [-h] --user <user> --type <type> --data <data>
                                [--project <project>]
                                <credential-id>

Expand
表25.14 位置引数
概要

<credential-id>

変更する認証情報の ID

Expand
表25.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--user <user>

認証情報を所有するユーザー(名前または ID)

--type <type>

新規の認証タイプ:cert、ec2、tp など

--data <data>

新しい認証情報データ

--project <project>

認証情報の範囲を制限するプロジェクト(名前または ID)

25.5. credential show

認証情報の詳細を表示します。

使用方法

openstack credential show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <credential-id>

Expand
表25.16 位置引数
概要

<credential-id>

表示する認証情報の ID

Expand
表25.17 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表25.18 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表25.19 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表25.20 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表25.21 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第26章 cron

本章では、cron コマンドに含まれるコマンドについて説明します。

26.1. cron trigger create

新規トリガーを作成します。

使用方法

openstack cron trigger create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--params PARAMS] [--pattern <* * * * *>]
                                     [--first-time <YYYY-MM-DD HH:MM>]
                                     [--count <integer>] [--utc]
                                     name workflow_identifier [workflow_input]

Expand
表26.1 位置引数
概要

name

Cron trigger の名前

workflow_identifier

ワークフローの名前または ID

workflow_input

ワークフロー入力

Expand
表26.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--params PARAMS

ワークフローパラメーター

--pattern <* * * * *>

Cron trigger のパターン

--first-time <YYYY-MM-DD HH:MM>

最初の実行日時。時間は、--utc も併せて指定されていない場合にローカル時間として処理されます。

--count <integer>

任意の実行数

--utc

指定した時間はすべて utc として処理する必要があります。

Expand
表26.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表26.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表26.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表26.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

26.2. cron trigger delete

トリガーを削除します。

使用方法

openstack cron trigger delete [-h] cron_trigger [cron_trigger ...]

Expand
表26.7 位置引数
概要

cron_trigger

Cron トリガーの名前。

Expand
表26.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

26.3. cron trigger list

すべての cron トリガーを一覧表示します。

使用方法

openstack cron trigger 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]

Expand
表26.9 その他の引数 (オプション):
概要

-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

フィルター。繰り返し使用できます。

Expand
表26.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表26.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表26.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表26.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

26.4. cron trigger show

特定の cron トリガーを表示します。

使用方法

openstack cron trigger show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   cron_trigger

Expand
表26.14 位置引数
概要

cron_trigger

Cron trigger の名前

Expand
表26.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表26.16 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表26.17 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表26.18 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表26.19 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第27章 datastore

本章では、datastore コマンドに含まれるコマンドについて説明します。

27.1. datastore list

利用可能なデータストアを一覧表示します。

使用方法

openstack datastore 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]

Expand
表27.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表27.2 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表27.3 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表27.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表27.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

27.2. datastore show

データストアの詳細を表示します。

使用方法

openstack datastore show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                <datastore>

Expand
表27.6 位置引数
概要

<datastore>

データストアの ID

Expand
表27.7 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表27.8 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表27.9 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表27.10 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表27.11 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

27.3. datastore version list

データストアで利用可能なバージョンを一覧表示します。

使用方法

openstack datastore version 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]
                                        <datastore>

Expand
表27.12 位置引数
概要

<datastore>

データストアの ID または名前

Expand
表27.13 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表27.14 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表27.15 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表27.16 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表27.17 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

27.4. datastore version show

データストアバージョンの詳細を表示します。

使用方法

openstack datastore version show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--datastore <datastore>]
                                        <datastore_version>

Expand
表27.18 位置引数
概要

<datastore_version>

データストアバージョンの ID または名前。

Expand
表27.19 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--datastore <datastore>

データストアの ID または名前。Datastore_version の ID が指定されている場合はオプションになります。

Expand
表27.20 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表27.21 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表27.22 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表27.23 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第28章 dns

本章では、dns コマンドに含まれるコマンドについて説明します。

28.1. dns quota list

クォータを一覧表示します。

使用方法

openstack dns quota list [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                [--project-id PROJECT_ID]

Expand
表28.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--project-id PROJECT_ID

プロジェクト ID のデフォルト:現在のプロジェクト

Expand
表28.2 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表28.3 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表28.4 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表28.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

28.2. dns quota reset

クォータをリセットします。

使用方法

openstack dns quota reset [-h] [--all-projects] [--edit-managed]
                                 [--sudo-project-id SUDO_PROJECT_ID]
                                 [--project-id PROJECT_ID]

Expand
表28.6 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--project-id PROJECT_ID

プロジェクト ID

28.3. dns quota set

クォータを設定します。

使用方法

openstack dns quota set [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--all-projects]
                               [--edit-managed]
                               [--sudo-project-id SUDO_PROJECT_ID]
                               [--project-id PROJECT_ID]
                               [--api-export-size <api-export-size>]
                               [--recordset-records <recordset-records>]
                               [--zone-records <zone-records>]
                               [--zone-recordsets <zone-recordsets>]
                               [--zones <zones>]

Expand
表28.7 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--project-id PROJECT_ID

プロジェクト ID

--api-export-size <api-export-size>

Api-export-size クォータの新しい値

--recordset-records <recordset-records>

Recordset-records クォータの新しい値

--zone-records <zone-records>

Zone-records クォータの新しい値

--zone-recordsets <zone-recordsets>

Zone-recordsets クォータの新しい値

--zones <zones>

ゾーンクォータの新しい値

Expand
表28.8 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表28.9 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表28.10 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表28.11 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

28.4. dns service list

サービスステータスを一覧表示します。

使用方法

openstack dns service 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]
                                  [--hostname HOSTNAME]
                                  [--service_name SERVICE_NAME]
                                  [--status STATUS] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]

Expand
表28.12 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--hostname HOSTNAME

Hostname

--service_name SERVICE_NAME

サービス名

--status STATUS

Status

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

Expand
表28.13 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表28.14 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表28.15 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表28.16 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

28.5. dns service show

サービスステータスの詳細を表示します。

使用方法

openstack dns service show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  id

Expand
表28.17 位置引数
概要

id

サービスのステータス ID

Expand
表28.18 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

Expand
表28.19 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表28.20 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表28.21 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表28.22 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第29章 domain

本章では、domain コマンドに含まれるコマンドについて説明します。

29.1. domain create

新規ドメインを作成します。

使用方法

openstack domain create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--description <description>]
                               [--enable | --disable] [--or-show]
                               <domain-name>

Expand
表29.1 位置引数
概要

<domain-name>

新規ドメイン名

Expand
表29.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

新規ドメインの説明

--enable

ドメインを有効化します(デフォルト)。

--disable

ドメインを無効化します。

--or-show

既存のドメインを返します。

Expand
表29.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表29.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表29.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表29.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

29.2. domain delete

ドメインを削除します。

使用方法

openstack domain delete [-h] <domain> [<domain> ...]

Expand
表29.7 位置引数
概要

<domain>

削除するドメイン(名前または ID)

Expand
表29.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

29.3. ドメインリスト

ドメインの一覧を表示します。

使用方法

openstack domain 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]

Expand
表29.9 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表29.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表29.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表29.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表29.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

29.4. domain set

ドメインプロパティーを設定します。

使用方法

openstack domain set [-h] [--name <name>] [--description <description>]
                            [--enable | --disable]
                            <domain>

Expand
表29.14 位置引数
概要

<domain>

変更するドメイン(名前または ID)

Expand
表29.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新規ドメイン名

--description <description>

新規ドメインの説明

--enable

ドメインを有効化します。

--disable

ドメインを無効化します。

29.5. domain show

ドメインの詳細を表示します。

使用方法

openstack domain show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <domain>

Expand
表29.16 位置引数
概要

<domain>

表示するドメイン(名前または ID)

Expand
表29.17 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表29.18 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表29.19 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表29.20 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表29.21 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第30章 ec2

本章では、ec2 コマンドに含まれるコマンドについて説明します。

30.1. ec2 credentials create

EC2 認証情報を作成します。

使用方法

openstack ec2 credentials create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--project <project>]
                                        [--user <user>]
                                        [--user-domain <user-domain>]
                                        [--project-domain <project-domain>]

Expand
表30.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

プロジェクトで認証情報を作成します(名前または ID、デフォルト:現在の認証プロジェクト)。

--user <user>

ユーザーの認証情報を作成します(名前または ID、デフォルト:現在の認証ユーザー)。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表30.2 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表30.3 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表30.4 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表30.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

30.2. ec2 credentials delete

EC2 認証情報を削除します。

使用方法

openstack ec2 credentials delete [-h] [--user <user>]
                                        [--user-domain <user-domain>]
                                        <access-key> [<access-key> ...]

Expand
表30.6 位置引数
概要

<access-key>

認証情報アクセスキー

Expand
表30.7 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--user <user>

ユーザーの認証情報を削除します(名前または ID)。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

30.3. ec2 credentials list

EC2 認証情報を一覧表示します。

使用方法

openstack ec2 credentials 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>]

Expand
表30.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--user <user>

ユーザー別にリストを絞り込みます(名前または ID)。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

Expand
表30.9 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表30.10 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表30.11 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表30.12 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

30.4. ec2 credentials show

EC2 認証情報の詳細を表示します。

使用方法

openstack ec2 credentials show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--user <user>]
                                      [--user-domain <user-domain>]
                                      <access-key>

Expand
表30.13 位置引数
概要

<access-key>

認証情報アクセスキー

Expand
表30.14 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--user <user>

ユーザーの認証情報(名前または ID)を表示します。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

Expand
表30.15 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表30.16 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表30.17 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表30.18 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第31章 endpoint

本章では、endpoint コマンドに含まれるコマンドについて説明します。

31.1. endpoint add project

プロジェクトをエンドポイントに関連付けます。

使用方法

openstack endpoint add project [-h] [--project-domain <project-domain>]
                                      <endpoint> <project>

Expand
表31.1 位置引数
概要

<endpoint>

指定したプロジェクト(名前または ID)に関連付けるエンドポイント

<project>

指定のエンドポイント名または ID に関連付けるプロジェクト

Expand
表31.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

31.2. endpoint create

新規エンドポイントを作成します。

使用方法

openstack endpoint create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--region <region-id>]
                                 [--enable | --disable]
                                 <service> <interface> <url>

Expand
表31.3 位置引数
概要

<service>

新しいエンドポイント(名前または ID)に関連付けるサービス

<interface>

新規エンドポイントインターフェースタイプ(admin、public または internal)

<url>

新規エンドポイント URL

Expand
表31.4 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--region <region-id>

新規エンドポイントのリージョン ID

--enable

エンドポイントを有効化します(デフォルト)

--disable

エンドポイントを無効化します

Expand
表31.5 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表31.6 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表31.7 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表31.8 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

31.3. endpoint delete

エンドポイントを削除します。

使用方法

openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]

Expand
表31.9 位置引数
概要

<endpoint-id>

削除するエンドポイント(id のみ)

Expand
表31.10 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

31.4. endpoint group add project

プロジェクトをエンドポイントグループに追加します。

使用方法

openstack endpoint group add project [-h]
                                            [--project-domain <project-domain>]
                                            <endpoint-group> <project>

Expand
表31.11 位置引数
概要

<endpoint-group>

エンドポイントグループ(名前または ID)

<project>

関連付けるプロジェクト(名前または ID)

Expand
表31.12 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

31.5. endpoint group create

新規エンドポイントグループを作成します。

使用方法

openstack endpoint group create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--description DESCRIPTION]
                                       <name> <filename>

Expand
表31.13 位置引数
概要

<name>

エンドポイントグループの名前

<filename>

新しいフィルターセットを含むファイル名

Expand
表31.14 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--description DESCRIPTION

エンドポイントグループの説明

Expand
表31.15 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表31.16 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表31.17 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表31.18 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

31.6. endpoint group delete

エンドポイントグループを削除します。

使用方法

openstack endpoint group delete [-h]
                                       <endpoint-group> [<endpoint-group> ...]

Expand
表31.19 位置引数
概要

<endpoint-group>

削除するエンドポイントグループ(名前または ID)

Expand
表31.20 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

31.7. endpoint group list

エンドポイントグループを一覧表示します。

使用方法

openstack endpoint group 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]
                                     [--endpointgroup <endpoint-group> | --project <project>]
                                     [--domain <domain>]

Expand
表31.21 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--endpointgroup <endpoint-group>

エンドポイントグループ(名前または ID)

--project <project>

プロジェクト(名前または ID)

--domain <domain>

<project> を所有するドメイン(名前または ID)

Expand
表31.22 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表31.23 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表31.24 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表31.25 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

31.8. endpoint group remove project

エンドポイントグループからプロジェクトを削除します。

使用方法

openstack endpoint group remove project [-h]
                                               [--project-domain <project-domain>]
                                               <endpoint-group> <project>

Expand
表31.26 位置引数
概要

<endpoint-group>

エンドポイントグループ(名前または ID)

<project>

削除するプロジェクト(名前または ID)

Expand
表31.27 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

31.9. endpoint group set

エンドポイントグループプロパティーを設定します。

使用方法

openstack endpoint group set [-h] [--name <name>]
                                    [--filters <filename>]
                                    [--description <description>]
                                    <endpoint-group>

Expand
表31.28 位置引数
概要

<endpoint-group>

変更するエンドポイントグループ(名前または ID)

Expand
表31.29 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

アタrシイエンドポイントグループ名

--filters <filename>

新しいフィルターセットを含むファイル名

--description <description>

新規エンドポイントグループの説明

31.10. endpoint group show

エンドポイントグループの詳細を表示します。

使用方法

openstack endpoint group show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <endpointgroup>

Expand
表31.30 位置引数
概要

<endpointgroup>

エンドポイントグループ(名前または ID)

Expand
表31.31 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表31.32 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表31.33 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表31.34 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表31.35 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

31.11. endpoint list

エンドポイントを一覧表示します。

使用方法

openstack endpoint 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]
                               [--service <service>] [--interface <interface>]
                               [--region <region-id>]
                               [--endpoint <endpoint-group> | --project <project>]
                               [--project-domain <project-domain>]

Expand
表31.36 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--service <service>

サービス(タイプ、名前または ID)別に絞り込みます。

--interface <interface>

インターフェースタイプ別に絞り込みます(管理者、パブリック、または内部)

--region <region-id>

リージョン ID 別に絞り込みます。

--endpoint <endpoint-group>

フィルターを一覧表示するエンドポイント

--project <project>

フィルターを一覧表示するプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表31.37 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表31.38 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表31.39 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表31.40 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

31.12. endpoint remove project

エンドポイントからプロジェクトを分散します。

使用方法

openstack endpoint remove project [-h]
                                         [--project-domain <project-domain>]
                                         <endpoint> <project>

Expand
表31.41 位置引数
概要

<endpoint>

指定したプロジェクト(名前または ID)から関連付けを解除するエンドポイント

<project>

指定されたエンドポイント名または ID から関連付けを解除するプロジェクト

Expand
表31.42 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

31.13. endpoint set

エンドポイントプロパティーを設定します。

使用方法

openstack endpoint set [-h] [--region <region-id>]
                              [--interface <interface>] [--url <url>]
                              [--service <service>] [--enable | --disable]
                              <endpoint-id>

Expand
表31.43 位置引数
概要

<endpoint-id>

変更するエンドポイント(ID のみ)

Expand
表31.44 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--region <region-id>

新規エンドポイントのリージョン ID

--interface <interface>

新規エンドポイントインターフェースタイプ(admin、public または internal)

--url <url>

新規エンドポイント URL

--service <service>

新しいエンドポイントサービス(名前または ID)

--enable

エンドポイントを有効化します。

--disable

エンドポイントを無効化します

31.14. endpoint show

エンドポイントの詳細を表示します。

使用方法

openstack endpoint show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               <endpoint>

Expand
表31.45 位置引数
概要

<endpoint>

表示するエンドポイント(エンドポイント id、サービス ID、サービス名、サービスタイプ)

Expand
表31.46 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表31.47 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表31.48 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表31.49 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表31.50 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第32章 event

本章では、event コマンドに含まれるコマンドについて説明します。

32.1. event trigger create

新規トリガーを作成します。

使用方法

openstack event trigger create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--params PARAMS]
                                      name workflow_id exchange topic event
                                      [workflow_input]

Expand
表32.1 位置引数
概要

name

イベントトリガー名

workflow_id

ワークフロー id

exchange

イベントトリガーの交換

topic

イベントトリガートピック

event

イベントトリガーイベント名

workflow_input

ワークフロー入力

Expand
表32.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--params PARAMS

ワークフローパラメーター

Expand
表32.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表32.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表32.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表32.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

32.2. event trigger delete

トリガーを削除します。

使用方法

openstack event trigger delete [-h]
                                      event_trigger_id [event_trigger_id ...]

Expand
表32.7 位置引数
概要

event_trigger_id

イベントトリガーの ID。

Expand
表32.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

32.3. event trigger list

すべてのイベントトリガーを一覧表示します。

使用方法

openstack event trigger 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]

Expand
表32.9 その他の引数 (オプション):
概要

-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

フィルター。繰り返し使用できます。

Expand
表32.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表32.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表32.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表32.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

32.4. event trigger show

特定のイベントトリガーを表示します。

使用方法

openstack event trigger show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    event_trigger

Expand
表32.14 位置引数
概要

event_trigger

イベントトリガー ID

Expand
表32.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表32.16 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表32.17 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表32.18 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表32.19 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第33章 extension

本章では、extension コマンドに含まれるコマンドについて説明します。

33.1. extension list

API 拡張を一覧表示します。

使用方法

openstack extension 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]
                                [--identity] [--network] [--volume] [--long]

Expand
表33.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--compute

コンピュート api の拡張機能を一覧表示します。

--identity

アイデンティティー api の拡張機能を一覧表示します。

--network

ネットワーク api の拡張機能を一覧表示します。

--volume

ブロックストレージ api の拡張機能を一覧表示します。

--long

出力の追加フィールドを一覧表示します。

Expand
表33.2 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表33.3 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表33.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表33.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

33.2. extension show

API 拡張機能を表示します。

使用方法

openstack extension show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                <extension>

Expand
表33.6 位置引数
概要

<bx id="1" />

表示する拡張機能。現在、ネットワーク拡張機能のみがサポートされます。(名前またはエイリアス)

Expand
表33.7 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表33.8 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表33.9 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表33.10 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表33.11 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第34章 federation

本章では、federation コマンドに含まれるコマンドについて説明します。

34.1. federation domain list

アクセス可能なドメインを一覧表示します。

使用方法

openstack federation domain 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]

Expand
表34.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表34.2 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表34.3 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表34.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表34.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

34.2. federation project list

アクセス可能なプロジェクトを一覧表示します。

使用方法

openstack federation project 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]

Expand
表34.6 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表34.7 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表34.8 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表34.9 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表34.10 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

34.3. federation protocol create

新規フェデレーションプロトコルを作成します。

使用方法

openstack federation protocol create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            --identity-provider
                                            <identity-provider> --mapping
                                            <mapping>
                                            <name>

Expand
表34.11 位置引数
概要

<name>

新しいフェデレーションプロトコル名(認証プロバイダーごとに一意である必要があります)

Expand
表34.12 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--identity-provider <identity-provider>

新しいフェデレーションプロトコル(名前または ID)をサポートする認証プロバイダー(必須)

--mapping <mapping>

使用されるマッピング(名前または ID)(必須)

Expand
表34.13 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表34.14 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表34.15 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表34.16 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

34.4. federation protocol delete

フェデレーションプロトコルを削除します。

使用方法

openstack federation protocol delete [-h] --identity-provider
                                            <identity-provider>
                                            <federation-protocol>
                                            [<federation-protocol> ...]

Expand
表34.17 位置引数
概要

<federation-protocol>

削除するフェデレーションプロトコル(名前または ID)

Expand
表34.18 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--identity-provider <identity-provider>

<federation-protocol>(名前または ID)をサポートする認証プロバイダー(必須)

34.5. federation protocol list

フェデレーションプロトコルを一覧表示します。

使用方法

openstack federation protocol 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]
                                          --identity-provider
                                          <identity-provider>

Expand
表34.19 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--identity-provider <identity-provider>

一覧表示する認証プロバイダー(名前または ID)(必須)

Expand
表34.20 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表34.21 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表34.22 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表34.23 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

34.6. federation protocol set

フェデレーションプロトコルプロパティーを設定します。

使用方法

openstack federation protocol set [-h] --identity-provider
                                         <identity-provider>
                                         [--mapping <mapping>]
                                         <name>

Expand
表34.24 位置引数
概要

<name>

変更するフェデレーションプロトコル(名前または ID)

Expand
表34.25 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--identity-provider <identity-provider>

<federation-protocol>(名前または ID)をサポートする認証プロバイダー(必須)

--mapping <mapping>

使用されるマッピング(名前または ID)

34.7. federation protocol show

フェデレーションプロトコルの詳細を表示します。

使用方法

openstack federation protocol show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          --identity-provider
                                          <identity-provider>
                                          <federation-protocol>

Expand
表34.26 位置引数
概要

<federation-protocol>

表示するフェデレーションプロトコル(名前または ID)

Expand
表34.27 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--identity-provider <identity-provider>

<federation-protocol>(名前または ID)をサポートする認証プロバイダー(必須)

Expand
表34.28 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表34.29 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表34.30 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表34.31 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第35章 flavor

本章では、flavor コマンドに含まれるコマンドについて説明します。

35.1. flavor create

新規フレーバーを作成します。

使用方法

openstack flavor create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--id <id>] [--ram <size-mb>]
                               [--disk <size-gb>] [--ephemeral <size-gb>]
                               [--swap <size-mb>] [--vcpus <vcpus>]
                               [--rxtx-factor <factor>] [--public | --private]
                               [--property <key=value>] [--project <project>]
                               [--description <description>]
                               [--project-domain <project-domain>]
                               <flavor-name>

Expand
表35.1 位置引数
概要

<flavor-name>

新規フレーバー名

Expand
表35.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--id <id>

一意のフレーバー ID。uuid を自動生成します(デフォルト:auto)

--ram <size-mb>

MB単位のメモリーサイズ(デフォルトは 256m)

--disk <size-gb>

GB 単位のディスクサイズ(デフォルトは 0g)

--ephemeral <size-gb>

GB 単位の一時ディスクサイズ(デフォルトは 0g)

--swap <size-mb>

MB 単位の追加のスワップ領域サイズ(デフォルト: 0m)

--vcpus <vcpus>

仮想 CPU の数(デフォルトは 1)

--rxtx-factor <factor>

Rx/tx ファクター(デフォルトは 1.0)

--public

他のプロジェクトでフレーバーが利用できます(デフォルト)

--private

他のプロジェクトでフレーバーは利用できません。

--property <key=value>

このフレーバーに追加する属性(複数の属性を設定する場合はオプションを繰り返し使用します)

--project <project>

<project> がプライベートフレーバー(名前または ID)にアクセスできるようにします(--private オプションと併せて使用する必要があります)。

--description <description>

フレーバーの説明(api バージョン 2.55 - 2.latest でサポート)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表35.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表35.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表35.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表35.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

35.2. flavor delete

フレーバーを削除します。

使用方法

openstack flavor delete [-h] <flavor> [<flavor> ...]

Expand
表35.7 位置引数
概要

<flavor>

削除するフレーバー(名前または ID)

Expand
表35.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

35.3. flavor list

フレーバーを一覧表示します。

使用方法

openstack flavor 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]
                             [--public | --private | --all] [--long]
                             [--marker <flavor-id>] [--limit <num-flavors>]

Expand
表35.9 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--public

パブリックフレーバーのみを一覧表示します(デフォルト)

--private

プライベートフレーバーのみを一覧表示します。

--all

パブリックまたはプライベートのすべてのフレーバーを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--marker <flavor-id>

前のページにある最後のフレーバー ID

--limit <num-flavors>

表示するフレーバーの最大数

Expand
表35.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表35.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表35.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表35.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

35.4. flavor set

フレーバーのプロパティを設定します。

使用方法

openstack flavor set [-h] [--no-property] [--property <key=value>]
                            [--project <project>]
                            [--description <description>]
                            [--project-domain <project-domain>]
                            <flavor>

Expand
表35.14 位置引数
概要

<flavor>

変更するフレーバー(名前または ID)

Expand
表35.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--no-property

このフレーバーからすべてのプロパティーを削除します(新しいプロパティを設定する前に現在のプロパティを削除するには --no-property と --property の両方を指定)。

--property <key=value>

このフレーバーに追加または変更する属性(複数の属性を設定する場合はオプションを繰り返し使用します)

--project <project>

プロジェクト(名前または ID)へのフレーバーアクセスを設定します(管理者のみ)。

--description <description>

フレーバーの説明を設定します(api バージョン 2.55 - 2.latest でサポート)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

35.5. flavor show

フレーバーの詳細を表示します。

使用方法

openstack flavor show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <flavor>

Expand
表35.16 位置引数
概要

<flavor>

表示するフレーバー(名前または ID)

Expand
表35.17 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表35.18 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表35.19 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表35.20 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表35.21 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

35.6. flavor unset

フレーバーのプロパティを設定します。

使用方法

openstack flavor unset [-h] [--property <key>] [--project <project>]
                              [--project-domain <project-domain>]
                              <flavor>

Expand
表35.22 位置引数
概要

<flavor>

変更するフレーバー(名前または ID)

Expand
表35.23 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key>

フレーバーから削除するプロパティー(複数プロパティーの設定を解除する場合はオプションを繰り返し使用します)

--project <project>

プロジェクト(名前または ID)からフレーバーアクセスを削除します(管理者のみ)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

第36章 floating

本章では、floating コマンドに含まれるコマンドについて説明します。

36.1. floating ip create

Floating IP を作成します。

使用方法

openstack floating ip create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--subnet <subnet>]
                                    [--port <port>]
                                    [--floating-ip-address <ip-address>]
                                    [--fixed-ip-address <ip-address>]
                                    [--qos-policy <qos-policy>]
                                    [--description <description>]
                                    [--project <project>]
                                    [--dns-domain <dns-domain>]
                                    [--dns-name <dns-name>]
                                    [--project-domain <project-domain>]
                                    [--tag <tag> | --no-tag]
                                    <network>

Expand
表36.1 位置引数
概要

<network>

Floating IP の割り当て元のネットワーク(名前または ID)

Expand
表36.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--subnet <subnet>

Floating IP(名前または ID)を作成するサブネット

--port <port>

Floating IP(名前または ID)に関連付けるポート

--floating-ip-address <ip-address>

Floating IP アドレス

--fixed-ip-address <ip-address>

Floating IP にマッピングされた Fixed IP アドレス

--qos-policy <qos-policy>

Floating IP(名前または ID)に qos ポリシーを割り当てます。

--description <description>

Floating IP の説明を設定します。

--project <project>

所有者のプロジェクト(名前または ID)

--dns-domain <dns-domain>

この Floating IP に DNS ドメインを設定します。

--dns-name <dns-name>

この Floating IP に DNS 名を設定します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--tag <tag>

Floating IP に追加するタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

Floating IP にタグを関連付けない

Expand
表36.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表36.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表36.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表36.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

36.2. floating ip delete

Floating IP を削除します。

使用方法

openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]

Expand
表36.7 位置引数
概要

<floating-ip>

削除する Floating IP(IP アドレスまたは ID)

Expand
表36.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

36.3. floating ip list

Floating IP を一覧表示します。

使用方法

openstack floating ip 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]
                                  [--network <network>] [--port <port>]
                                  [--fixed-ip-address <ip-address>]
                                  [--floating-ip-address <ip-address>]
                                  [--long] [--status <status>]
                                  [--project <project>]
                                  [--project-domain <project-domain>]
                                  [--router <router>]
                                  [--tags <tag>[,<tag>,...]]
                                  [--any-tags <tag>[,<tag>,...]]
                                  [--not-tags <tag>[,<tag>,...]]
                                  [--not-any-tags <tag>[,<tag>,...]]

Expand
表36.9 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--network <network>

指定されたネットワーク(名前または ID)に従って Floating IP を一覧表示します。

--port <port>

指定ポート(名前または ID)に従って Floating IP を一覧表示します。

--fixed-ip-address <ip-address>

指定の Fixed IP アドレスに従って、Floating IP を一覧表示します。

--floating-ip-address <ip-address>

指定の Floating IP アドレスに従って Floating IP を一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--status <status>

指定されたステータス(ACTIVE, DOWN) に従って Floating IP を一覧表示します。

--project <project>

指定のプロジェクト(名前または ID)に従って Floating IP を一覧表示します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--router <router>

指定のルーター(名前または ID)に従って Floating IP を一覧表示します。

--tags <tag>[,<tag>,…​]

指定されたタグ(タグのコンマ区切りリスト)がすべて割り当てられた Floating IP を一覧表示します。

--any-tags <tag>[,<tag>,…​]

指定されたタグ(タグのコンマ区切りリスト)のいずれかが割り当てられた Floating IP を一覧表示します。

--not-tags <tag>[,<tag>,…​]

指定されたタグ(タグのコンマ区切りリスト)がすべて割り当てられた Floating IP を除外します。

--not-any-tags <tag>[,<tag>,…​]

指定されたタグ(タグのコンマ区切りリスト)のいずれかが割り当てられた Floating IP を除外します。

Expand
表36.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表36.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表36.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表36.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

36.4. floating ip pool list

Floating IP アドレスのプールを一覧表示します。

使用方法

openstack floating ip pool 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]

Expand
表36.14 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表36.15 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表36.16 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表36.17 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表36.18 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

36.5. floating ip set

Floating IP 属性を設定します。

使用方法

openstack floating ip set [-h] [--port <port>]
                                 [--fixed-ip-address <ip-address>]
                                 [--qos-policy <qos-policy> | --no-qos-policy]
                                 [--tag <tag>] [--no-tag]
                                 <floating-ip>

Expand
表36.19 位置引数
概要

<floating-ip>

変更する Floating IP(IP アドレスまたは ID)

Expand
表36.20 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--port <port>

Floating IP をポートに関連付けます(名前または ID)。

--fixed-ip-address <ip-address>

ポートの Fixed IP(ポートに複数の IP がある場合のみ必要)

--qos-policy <qos-policy>

Floating IP(名前または ID)に qos ポリシーを割り当てます。

--no-qos-policy

Floating IP に割り当てられた qos ポリシーを削除します。

--tag <tag>

Floating IP に追加するタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

Floating IPに関連付けられたタグを消去します。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。

36.6. floating ip show

Floating IP の詳細を表示します。

使用方法

openstack floating ip show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <floating-ip>

Expand
表36.21 位置引数
概要

<floating-ip>

表示する Floating IP(IP アドレスまたは ID)

Expand
表36.22 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表36.23 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表36.24 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表36.25 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表36.26 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

36.7. floating ip unset

Floating IP 属性の設定を解除します。

使用方法

openstack floating ip unset [-h] [--port] [--qos-policy]
                                   [--tag <tag> | --all-tag]
                                   <floating-ip>

Expand
表36.27 位置引数
概要

<floating-ip>

関連付けを解除する Floating IP(IP アドレスまたは ID)

Expand
表36.28 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--port

Floating IP に関連付けられたポートの関連付けを解除します。

--qos-policy

Floating IP に割り当てられた qos ポリシーを削除します。

--tag <tag>

Floating IP から削除するタグ(複数のタグを削除する場合はオプションを繰り返し使用します)

--all-tag

Floating IP に関連付けられたすべてのタグを消去します。

第37章 group

本章では、group コマンドに含まれるコマンドについて説明します。

37.1. group add user

ユーザーをグループに追加します。

使用方法

openstack group add user [-h] [--group-domain <group-domain>]
                                [--user-domain <user-domain>]
                                <group> <user> [<user> ...]

Expand
表37.1 位置引数
概要

<group>

<user>が含まれるグループ(名前または ID)

<user>

<group>(名前または ID)に追加するユーザー(複数のユーザーを追加する場合はオプションを繰り返し使用します)

Expand
表37.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--group-domain <group-domain>

グループが所属するドメイン(名前または ID)。グループ名の競合が発生した場合に、使用できます。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

37.2. group contains user

グループ内のユーザーメンバーシップを確認します。

使用方法

openstack group contains user [-h] [--group-domain <group-domain>]
                                     [--user-domain <user-domain>]
                                     <group> <user>

Expand
表37.3 位置引数
概要

<group>

チェックするグループ(名前または ID)

<user>

確認するユーザー(名前または ID)

Expand
表37.4 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--group-domain <group-domain>

グループが所属するドメイン(名前または ID)。グループ名の競合が発生した場合に、使用できます。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

37.3. group create

新規グループを作成します。

使用方法

openstack group create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--domain <domain>]
                              [--description <description>] [--or-show]
                              <group-name>

Expand
表37.5 位置引数
概要

<group-name>

新しいグループ名

Expand
表37.6 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

新しいグループが含まれるドメイン(名前または ID)

--description <description>

新しいグループの説明

--or-show

既存グループを返します。

Expand
表37.7 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表37.8 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表37.9 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表37.10 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

37.4. group delete

グループを削除します。

使用方法

openstack group delete [-h] [--domain <domain>] <group> [<group> ...]

Expand
表37.11 位置引数
概要

<group>

削除するグループ(名前または ID)

Expand
表37.12 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

グループが含まれるドメイン(名前または ID)

37.5. group list

グループの一覧表示

使用方法

openstack group 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]
                            [--domain <domain>] [--user <user>]
                            [--user-domain <user-domain>] [--long]

Expand
表37.13 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

<domain>でグループリストをフィルターします(名前または ID)。

--user <user>

<user>でグループリストをフィルターします(名前または ID)。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

--long

出力の追加フィールドを一覧表示します。

Expand
表37.14 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表37.15 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表37.16 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表37.17 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

37.6. group remove user

グループからユーザーを削除します。

使用方法

openstack group remove user [-h] [--group-domain <group-domain>]
                                   [--user-domain <user-domain>]
                                   <group> <user> [<user> ...]

Expand
表37.18 位置引数
概要

<group>

<user>が含まれるグループ(名前または ID)

<user>

<group> (名前または id) から削除するユーザー (複数のボリュームを削除する場合はオプションを繰り返し使用します)

Expand
表37.19 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--group-domain <group-domain>

グループが所属するドメイン(名前または ID)。グループ名の競合が発生した場合に、使用できます。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

37.7. group set

グループ属性を設定します。

使用方法

openstack group set [-h] [--domain <domain>] [--name <name>]
                           [--description <description>]
                           <group>

Expand
表37.20 位置引数
概要

<group>

変更するグループ(名前または ID)

Expand
表37.21 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

<group>が含まれるドメイン(名前または ID)

--name <name>

新しいグループ名

--description <description>

新しいグループの説明

37.8. group show

グループの詳細を表示します。

使用方法

openstack group show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--domain <domain>]
                            <group>

Expand
表37.22 位置引数
概要

<group>

表示するグループ(名前または ID)

Expand
表37.23 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

<group>が含まれるドメイン(名前または ID)

Expand
表37.24 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表37.25 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表37.26 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表37.27 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第38章 help.adoc

本章では、help.adoc コマンドに含まれるコマンドについて説明します。

38.1. help

別のコマンドの詳細なヘルプを出力します。

使用方法

openstack help [-h] [cmd [cmd ...]]

Expand
表38.1 位置引数
概要

cmd

コマンドの名前

Expand
表38.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

第39章 host

本章では、host コマンドに含まれるコマンドについて説明します。

39.1. host list

ホストを一覧表示します。

使用方法

openstack host 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]
                           [--zone <zone>]

Expand
表39.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--zone <zone>

アベイラビリティーゾーン内のホストのみを返します。

Expand
表39.2 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表39.3 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表39.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

39.2. host set

ホスト属性を設定します。

使用方法

openstack host set [-h] [--enable | --disable]
                          [--enable-maintenance | --disable-maintenance]
                          <host>

Expand
表39.6 位置引数
概要

<host>

変更するホスト(名前のみ)

Expand
表39.7 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--enable

ホストを有効にします。

--disable

ホストを無効にします。

--enable-maintenance

ホストのメンテナンスモードを有効にします。

--disable-maintenance

ホストのメンテナンスモードを無効にします。

39.3. host show

ホストの詳細を表示します。

使用方法

openstack host 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]
                           <host>

Expand
表39.8 位置引数
概要

<host>

ホスト名

Expand
表39.9 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表39.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表39.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表39.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第40章 hypervisor

本章では、hypervisor コマンドに含まれるコマンドについて説明します。

40.1. hypervisor list

ハイパーバイザーを一覧表示します。

使用方法

openstack hypervisor 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]
                                 [--matching <hostname>] [--long]

Expand
表40.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--matching <hostname>

<hostname> 部分文字列を使用してハイパーバイザーをフィルターします。

--long

出力の追加フィールドを一覧表示します。

Expand
表40.2 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表40.3 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表40.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

40.2. hypervisor show

ハイパーバイザーの詳細を表示します。

使用方法

openstack hypervisor show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <hypervisor>

Expand
表40.6 位置引数
概要

<hypervisor>

表示するハイパーバイザー(名前または ID)

Expand
表40.7 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表40.8 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.9 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.10 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表40.11 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

40.3. hypervisor stats show

ハイパーバイザーの統計情報を表示します。

使用方法

openstack hypervisor stats show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]

Expand
表40.12 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表40.13 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.14 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.15 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表40.16 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第41章 identity

本章では、identity コマンドに含まれるコマンドについて説明します。

41.1. identity provider create

新規認証プロバイダーを作成します。

使用方法

openstack identity provider create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--remote-id <remote-id> | --remote-id-file <file-name>]
                                          [--description <description>]
                                          [--domain <domain>]
                                          [--enable | --disable]
                                          <name>

Expand
表41.1 位置引数
概要

<name>

新しい認証プロバイダー名(一意である必要があります)

Expand
表41.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--remote-id <remote-id>

認証プロバイダーに関連付けるリモート ID(複数の値を指定する場合はオプションを繰り返し使用します)

--remote-id-file <file-name>

認証プロバイダーに関連付ける多数のリモート ID が含まれるファイルの名前(行ごとに 1 つ)

--description <description>

新規の認証プロバイダーの説明

--domain <domain>

認証プロバイダーに関連付けるドメイン。指定されていない場合、ドメインが自動的に作成されます。(名前または ID)

--enable

認証プロバイダーを有効にします(デフォルト)。

--disable

認証プロバイダーを無効にします。

Expand
表41.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表41.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

41.2. identity provider delete

認証プロバイダーを削除します。

使用方法

openstack identity provider delete [-h]
                                          <identity-provider>
                                          [<identity-provider> ...]

Expand
表41.7 位置引数
概要

<identity-provider>

削除する認証プロバイダー

Expand
表41.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

41.3. identity provider list

認証プロバイダーを一覧表示します。

使用方法

openstack identity provider 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]

Expand
表41.9 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表41.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表41.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表41.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

41.4. identity provider set

認証プロバイダー属性を設定します。

使用方法

openstack identity provider set [-h] [--description <description>]
                                       [--remote-id <remote-id> | --remote-id-file <file-name>]
                                       [--enable | --disable]
                                       <identity-provider>

Expand
表41.14 位置引数
概要

<identity-provider>

変更する認証プロバイダー

Expand
表41.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

認証プロバイダーの説明を設定します。

--remote-id <remote-id>

認証プロバイダーに関連付けるリモート ID(複数の値を指定する場合はオプションを繰り返し使用します)

--remote-id-file <file-name>

認証プロバイダーに関連付ける多数のリモート ID が含まれるファイルの名前(行ごとに 1 つ)

--enable

認証プロバイダーを有効にします。

--disable

認証プロバイダーを無効にします。

41.5. identity provider show

認証プロバイダーの詳細を表示します。

使用方法

openstack identity provider show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <identity-provider>

Expand
表41.16 位置引数
概要

<identity-provider>

表示する認証プロバイダー

Expand
表41.17 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表41.18 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.19 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.20 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表41.21 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第42章 image

本章では、image コマンドに含まれるコマンドについて説明します。

42.1. image add project

プロジェクトをイメージに関連付けます。

使用方法

openstack image add project [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   [--project-domain <project-domain>]
                                   <image> <project>

Expand
表42.1 位置引数
概要

<image>

共有するイメージ(名前または ID)

<project>

イメージに関連付けるプロジェクト(id)

Expand
表42.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表42.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表42.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表42.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表42.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

42.2. image create

イメージを作成/アップロードします。

使用方法

openstack image create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--id <id>]
                              [--container-format <container-format>]
                              [--disk-format <disk-format>]
                              [--min-disk <disk-gb>] [--min-ram <ram-mb>]
                              [--file <file> | --volume <volume>] [--force]
                              [--sign-key-path <sign-key-path>]
                              [--sign-cert-id <sign-cert-id>]
                              [--protected | --unprotected]
                              [--public | --private | --community | --shared]
                              [--property <key=value>] [--tag <tag>]
                              [--project <project>]
                              [--project-domain <project-domain>]
                              <image-name>

Expand
表42.7 位置引数
概要

<image-name>

新しいイメージ名

Expand
表42.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--id <id>

予約するイメージ ID

--Container-format <container-format>

イメージコンテナーの形式。サポートされるオプションは ami、ari、aki、bare、docker、ova、ovf です。デフォルトの形式は bare です。

--disk-format <disk-format>

イメージディスクの形式。サポートされるオプションは ami、ari、aki、vhd、vmdk、raw、qcow2、vhdx、vdi、iso、ploop です。デフォルトの形式は raw です。

--min-disk <disk-gb>

イメージのブートに必要な最小ディスクサイズ(ギガバイト単位)

--min-ram <ram-mb>

イメージのブートに必要な最小RAMサイズ(メガバイト単位)

--file <file>

ローカルファイルからイメージをアップロードします。

--volume <volume>

ボリュームからイメージを作成します。

--force

ボリュームが使用中の場合にイメージ作成を強制的に実行します(--volume と共に使用する場合にのみ意味があります)。

--sign-key-path <sign-key-path>

指定した秘密鍵を使用してイメージを署名します。--sign-cert-id と併用する場合にのみ使用します。

--Sign-cert-id <sign-cert-id>

指定された証明書の uuid は、公開鍵に対応し、署名の検証に使用されるキーマネージャーの証明書への参照です。--sign-key-path と併用する場合にのみ使用します。

--protected

イメージが削除されないようにします。

--unprotected

イメージの削除を許可します(デフォルト)

--public

イメージは一般に公開されます。

--private

イメージは一般に公開されません(デフォルト)。

--community

イメージはコミュニティーに公開されます。

--shared

イメージを共有可能です。

--property <key=value>

このイメージにプロパティーを設定します(複数のプロパティーを設定する場合はオプションを繰り返し使用します)。

--tag <tag>

このイメージにタグを設定します(複数のタグを設定する場合はオプションを繰り返し使用します)。

--project <project>

このイメージの代替プロジェクトを設定します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表42.9 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表42.10 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表42.11 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表42.12 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

42.3. image delete

イメージを削除します。

使用方法

openstack image delete [-h] <image> [<image> ...]

Expand
表42.13 位置引数
概要

<image>

削除するイメージ(名前または ID)

Expand
表42.14 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

42.4. image list

利用可能なイメージを一覧表示します。

使用方法

openstack image 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]
                            [--public | --private | --community | --shared]
                            [--property <key=value>] [--name <name>]
                            [--status <status>]
                            [--member-status <member-status>] [--tag <tag>]
                            [--long] [--sort <key>[:<direction>]]
                            [--limit <num-images>] [--marker <image>]

Expand
表42.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--public

パブリックイメージのみを一覧表示します。

--private

プライベートイメージのみを一覧表示します。

--community

コミュニティーイメージのみを一覧表示します。

--shared

共有イメージのみを一覧表示します。

--property <key=value>

プロパティーに基づいて出力をフィルターします(複数のプロパティーでフィルタリングする場合はオプションを繰り返し使用します)

--name <name>

名前に基づいてイメージをフィルターします。

--status <status>

ステータスに基づいてイメージをフィルタリングします。

--member-status <member-status>

メンバーステータスをもとにイメージをフィルターします。サポートされるオプションは、accepted、pending、rejected、all です。

--tag <tag>

タグに基づいてイメージをフィルターします。

--long

出力の追加フィールドを一覧表示します。

--sort <key>[:<direction>]

選択した鍵と方向(asc または desc)で出力をソートします(デフォルト:name:asc)。複数のキーと方向をコンマで区切ることができます。

--limit <num-images>

表示するイメージの最大数。

--marker <image>

前のページにある最後のイメージ。マーカーの後にイメージの一覧を表示します。指定されていない場合には、すべてのイメージを表示します(名前または ID)。

Expand
表42.16 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表42.17 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表42.18 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表42.19 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

42.5. image member list

イメージに関連付けられたプロジェクトを一覧表示します。

使用方法

openstack image member 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]
                                   [--project-domain <project-domain>]
                                   <image>

Expand
表42.20 位置引数
概要

<image>

イメージ(名前または ID)

Expand
表42.21 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表42.22 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表42.23 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表42.24 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表42.25 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

42.6. image remove project

イメージとプロジェクトの関連付けを解除します。

使用方法

openstack image remove project [-h] [--project-domain <project-domain>]
                                      <image> <project>

Expand
表42.26 位置引数
概要

<image>

共有を解除するイメージ(名前または ID)

<project>

イメージとの関連付けを解除するプロジェクト(名前または ID)

Expand
表42.27 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

42.7. image save

イメージをローカルに保存します。

使用方法

openstack image save [-h] [--file <filename>] <image>

Expand
表42.28 位置引数
概要

<image>

保存するイメージ(名前または ID)

Expand
表42.29 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--file <filename>

ダウンロードしたイメージを保存するファイル名(デフォルト:stdout)

42.8. image set

イメージ属性を設定します。

使用方法

openstack image set [-h] [--name <name>] [--min-disk <disk-gb>]
                           [--min-ram <ram-mb>]
                           [--container-format <container-format>]
                           [--disk-format <disk-format>]
                           [--protected | --unprotected]
                           [--public | --private | --community | --shared]
                           [--property <key=value>] [--tag <tag>]
                           [--architecture <architecture>]
                           [--instance-id <instance-id>]
                           [--kernel-id <kernel-id>] [--os-distro <os-distro>]
                           [--os-version <os-version>]
                           [--ramdisk-id <ramdisk-id>]
                           [--deactivate | --activate] [--project <project>]
                           [--project-domain <project-domain>]
                           [--accept | --reject | --pending]
                           <image>

Expand
表42.30 位置引数
概要

<image>

変更するイメージ(名前または ID)

Expand
表42.31 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新しいイメージ名

--min-disk <disk-gb>

イメージのブートに必要な最小ディスクサイズ(ギガバイト単位)

--min-ram <ram-mb>

イメージのブートに必要な最小RAMサイズ(メガバイト単位)

--Container-format <container-format>

イメージコンテナーの形式。サポートされるオプションは ami、ari、aki、bare、docker、ova、ovf です。

--disk-format <disk-format>

イメージディスクの形式。サポートされるオプションは ami、ari、aki、vhd、vmdk、raw、qcow2、vhdx、vdi、iso、ploop です。

--protected

イメージが削除されないようにします。

--unprotected

イメージの削除を許可します(デフォルト)

--public

イメージは一般に公開されます。

--private

イメージは一般に公開されません(デフォルト)。

--community

イメージはコミュニティーに公開されます。

--shared

イメージを共有可能です。

--property <key=value>

このイメージにプロパティーを設定します(複数のプロパティーを設定する場合はオプションを繰り返し使用します)。

--tag <tag>

このイメージにタグを設定します(複数のタグを設定する場合はオプションを繰り返し使用します)。

--architecture <architecture>

オペレーティングシステムのアーキテクチャー

--instance-id <instance-id>

このイメージの作成に使用するサーバーインスタンスの ID

--kernel-id <kernel-id>

このディスクイメージのブートに使用するカーネルイメージの ID

--os-distro <os-distro>

オペレーティングシステムのディストリビューション名

--os-version <os-version>

オペレーティングシステムディストリビューションのバージョン

--ramdisk-id <ramdisk-id>

このディスクイメージのブートに使用するramdiskイメージの ID

--deactivate

イメージを非アクティブ化します。

--activate

イメージをアクティベートします。

--project <project>

このイメージの代替プロジェクトを設定します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--accept

イメージメンバーシップを許可します。

--reject

イメージメンバーシップを拒否します。

--pending

イメージのメンバーシップを 保留中にリセットします。

42.9. image show

イメージの詳細を表示します。

使用方法

openstack image show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--human-readable]
                            <image>

Expand
表42.32 位置引数
概要

<image>

表示するイメージ(名前または ID)

Expand
表42.33 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--human-readable

人間が解読しやすい形式でイメージサイズを出力します。

Expand
表42.34 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表42.35 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表42.36 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表42.37 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

42.10. image unset

イメージタグおよび属性の設定を解除します。

使用方法

openstack image unset [-h] [--tag <tag>] [--property <property-key>]
                             <image>

Expand
表42.38 位置引数
概要

<image>

変更するイメージ(名前または ID)

Expand
表42.39 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--tag <tag>

このイメージのタグ設定を解除します(複数のタグの設定を解除する場合はオプションを繰り返し使用します)。

--property <property-key>

このイメージのプロパティーの設定を解除します(複数のプロパティー設定を解除する場合はオプションを繰り返し使用します)。

第43章 implied

本章では、implied コマンドに含まれるコマンドについて説明します。

43.1. implied role create

以前のロールと暗黙的なロール間の関連付けを作成します。

使用方法

openstack implied role create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     --implied-role <role>
                                     <role>

Expand
表43.1 位置引数
概要

<role>

別のロールを暗示するロール(名前または ID)

Expand
表43.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--implied-role <role>

別のロールによって暗示される<role>(名前または id)

Expand
表43.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表43.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表43.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表43.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

43.2. implied role delete

以前のロールと暗黙的なロール間の関連付けを削除します。

使用方法

openstack implied role delete [-h] --implied-role <role> <role>

Expand
表43.7 位置引数
概要

<role>

別のロールを暗示するロール(名前または ID)

Expand
表43.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--implied-role <role>

別のロールによって暗示される<role>(名前または id)

43.3. implied role list

暗黙的なロールを一覧表示します。

使用方法

openstack implied role 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]

Expand
表43.9 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表43.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表43.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表43.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表43.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第44章 ip

本章では、ip コマンドに含まれるコマンドについて説明します。

44.1. ip availability list

ネットワークの IP の可用性を一覧表示します。

使用方法

openstack ip availability 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]
                                      [--ip-version <ip-version>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]

Expand
表44.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--ip-version <ip-version>

指定した ip バージョンのネットワーク(デフォルトは 4)の ip の可用性を一覧表示します。

--project <project>

指定されたプロジェクトの ip の可用性を一覧表示します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表44.2 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表44.3 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表44.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表44.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

44.2. ip availability show

ネットワーク IP の可用性の詳細を表示します。

使用方法

openstack ip availability show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <network>

Expand
表44.6 位置引数
概要

<network>

特定のネットワークの ip 可用性を表示します(名前または ID)。

Expand
表44.7 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表44.8 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表44.9 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表44.10 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表44.11 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第45章 keypair

本章では、keypair コマンドに含まれるコマンドについて説明します。

45.1. keypair create

サーバーの ssh アクセス用に新しい公開鍵または秘密鍵を作成します。

使用方法

openstack keypair create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                [--public-key <file> | --private-key <file>]
                                <name>

Expand
表45.1 位置引数
概要

<name>

新しい公開鍵または秘密鍵名

Expand
表45.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--public-key <file>

追加する公開鍵のファイル名。使用されていない場合は、秘密鍵を作成します。

--private-key <file>

保存する秘密鍵のファイル名。使用されていない場合は、秘密鍵をコンソールに出力します。

Expand
表45.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表45.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表45.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表45.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

45.2. keypair delete

公開鍵または秘密鍵を削除します。

使用方法

openstack keypair delete [-h] <key> [<key> ...]

Expand
表45.7 位置引数
概要

<key>

削除する鍵の名前(名前のみ)

Expand
表45.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

45.3. keypair list

鍵のフィンガープリントを一覧表示します。

使用方法

openstack keypair 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]

Expand
表45.9 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表45.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表45.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表45.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表45.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

45.4. keypair show

鍵の詳細を表示します。

使用方法

openstack keypair show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--public-key]
                              <key>

Expand
表45.14 位置引数
概要

<key>

表示する公開鍵または秘密鍵(名前のみ)

Expand
表45.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--public-key

生成された鍵とペアになったベア公開鍵のみを表示します。

Expand
表45.16 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表45.17 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表45.18 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表45.19 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第46章 l2gw

本章では、l2gw コマンドに含まれるコマンドについて説明します。

46.1. l2gw connection create

l2gateway-connection を作成します。

使用方法

openstack l2gw connection create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--default-segmentation-id SEG_ID]
                                        <GATEWAY-NAME/UUID>
                                        <NETWORK-NAME/UUID>

Expand
表46.1 位置引数
概要

<GATEWAY-NAME/UUID>

論理ゲートウェイの説明的な名前。

<NETWORK-NAME/UUID>

ネットワーク名または uuid

Expand
表46.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--default-segmentation-id SEG_ID

l2-gateway-create コマンドでセグメンテーション ID が指定されていなかったインターフェースに適用されるデフォルトのセグメンテーション ID。

Expand
表46.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表46.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表46.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表46.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

46.2. l2gw connection delete

指定した l2gateway-connection を削除します。

使用方法

openstack l2gw connection delete [-h]
                                        <L2_GATEWAY_CONNECTIONS>
                                        [<L2_GATEWAY_CONNECTIONS> ...]

Expand
表46.7 位置引数
概要

<L2_GATEWAY_CONNECTIONS>

削除する l2_gateway_connections(s)の ID。

Expand
表46.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

46.3. l2gw connection list

l2gateway-connections を一覧表示します。

使用方法

openstack l2gw connection 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]
                                      [--project <project>]
                                      [--project-domain <project-domain>]

Expand
表46.9 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表46.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表46.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表46.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表46.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

46.4. l2gw connection show

指定した l2gateway-connection の情報を表示します。

使用方法

openstack l2gw connection show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <L2_GATEWAY_CONNECTION>

Expand
表46.14 位置引数
概要

<L2_GATEWAY_CONNECTION>

検索する l2_gateway_connection の ID。

Expand
表46.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表46.16 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表46.17 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表46.18 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表46.19 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

46.5. l2gw create

l2gateway リソースを作成します。

使用方法

openstack l2gw create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--project <project>]
                             [--project-domain <project-domain>]
                             [--device name=name,interface_names=INTERFACE-DETAILS]
                             <GATEWAY-NAME>

Expand
表46.20 位置引数
概要

<GATEWAY-NAME>

論理ゲートウェイの説明的な名前。

Expand
表46.21 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--device name=name,interface_names=INTERFACE-DETAILS

l2gateway のデバイス名およびインターフェース名。INTERFACE-DETAILS の形式は"<interface_name1>;[<inte rface_name2>][です。

Expand
表46.22 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表46.23 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表46.24 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表46.25 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

46.6. l2gw delete

指定の l2gateway を削除します。

使用方法

openstack l2gw delete [-h] <L2_GATEWAY> [<L2_GATEWAY> ...]

Expand
表46.26 位置引数
概要

<L2_GATEWAY>

削除する l2_gateway の IDまたは名前。

Expand
表46.27 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

46.7. l2gw list

指定のテナントに属する l2gateway を一覧表示します。

使用方法

openstack l2gw 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]
                           [--project <project>]
                           [--project-domain <project-domain>]

Expand
表46.28 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表46.29 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表46.30 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表46.31 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表46.32 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

46.8. l2gw show

指定の l2gateway の情報を表示します。

使用方法

openstack l2gw show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty]
                           <L2_GATEWAY>

Expand
表46.33 位置引数
概要

<L2_GATEWAY>

検索する l2_gateway の ID または名前。

Expand
表46.34 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表46.35 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表46.36 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表46.37 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表46.38 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

46.9. l2gw update

指定の l2gateway を更新します。

使用方法

openstack l2gw update [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--name name]
                             [--device name=name,interface_names=INTERFACE-DETAILS]
                             <L2_GATEWAY>

Expand
表46.39 位置引数
概要

<L2_GATEWAY>

更新する l2_gateway の ID または名前。

Expand
表46.40 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name name

論理ゲートウェイの説明的な名前。

--device name=name,interface_names=INTERFACE-DETAILS

l2gateway のデバイス名およびインターフェース名。INTERFACE-DETAILS の形式は"<interface_name1>;[<inte rface_name2>][です。

Expand
表46.41 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表46.42 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表46.43 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表46.44 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第47章 limit

本章では、limit コマンドに含まれるコマンドについて説明します。

47.1. limit create

制限を作成します。

使用方法

openstack limit create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--description <description>]
                              [--region <region>] --project <project>
                              --service <service> --resource-limit
                              <resource-limit>
                              <resource-name>

Expand
表47.1 位置引数
概要

<resource-name>

制限するリソースの名前

Expand
表47.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

制限の説明

--region <region>

影響する制限のリージョン。

--project <project>

リソース制限を関連付けるプロジェクト

--service <service>

制限するリソースに関するサービス

--resource-limit <resource-limit>

仮定するプロジェクトのリソース制限

Expand
表47.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表47.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表47.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表47.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

47.2. limit delete

制限を削除します。

使用方法

openstack limit delete [-h] <limit-id> [<limit-id> ...]

Expand
表47.7 位置引数
概要

<limit-id>

削除の制限(id)

Expand
表47.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

47.3. limit list

制限を一覧表示します。

使用方法

openstack limit 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]
                            [--service <service>]
                            [--resource-name <resource-name>]
                            [--region <region>] [--project <project>]

Expand
表47.9 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--service <service>

制限するリソースに関するサービス

--resource-name <resource-name>

制限するリソースの名前

--region <region>

影響する登録された制限のリージョン。

--project <project>

プロジェクトに関連付けられたリソース制限を一覧表示します。

Expand
表47.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表47.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表47.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表47.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

47.4. limit set

制限に関する情報を更新します。

使用方法

openstack limit set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--description <description>]
                           [--resource-limit <resource-limit>]
                           <limit-id>

Expand
表47.14 位置引数
概要

<limit-id>

更新する制限(id)

Expand
表47.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

制限の説明

--resource-limit <resource-limit>

仮定するプロジェクトのリソース制限

Expand
表47.16 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表47.17 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表47.18 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表47.19 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

47.5. limit show

制限の詳細を表示します。

使用方法

openstack limit show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty]
                            <limit-id>

Expand
表47.20 位置引数
概要

<limit-id>

表示する制限(id)

Expand
表47.21 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表47.22 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表47.23 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表47.24 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表47.25 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第48章 limits

本章では、limits コマンドに含まれるコマンドについて説明します。

48.1. limits show

コンピュートおよびブロックストレージの制限を表示します。

使用方法

openstack limits 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] (--absolute | --rate)
                             [--reserved] [--project <project>]
                             [--domain <domain>]

Expand
表48.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--absolute

絶対制限を表示します。

--rate

流量制御の表示

--reserved

予約数を含めます [--absoluteと共に使用する場合にのみ有効]。

--project <project>

特定のプロジェクト(名前または ID)の制限を表示します [--absoluteと共に使用する場合にのみ有効]。

--domain <domain>

プロジェクトが属するドメイン(名前または ID)[--absoluteと共に使用する場合にのみ有効]。

Expand
表48.2 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表48.3 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表48.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表48.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第49章 loadbalancer

本章では、loadbalancer コマンドに含まれるコマンドについて説明します。

49.1. loadbalancer amphora configure

amphora エージェントの設定を更新します。

使用方法

openstack loadbalancer amphora configure [-h] <amphora-id>

Expand
表49.1 位置引数
概要

<amphora-id>

設定する amphora の UUID

Expand
表49.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

49.2. loadbalancer amphora failover

amphora を強制的にフェイルオーバーします。

使用方法

openstack loadbalancer amphora failover [-h] <amphora-id>

Expand
表49.3 位置引数
概要

<amphora-id>

amphora の UUID

Expand
表49.4 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

49.3. loadbalancer amphora list

amphora を一覧表示します。

使用方法

openstack loadbalancer amphora 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]
                                           [--loadbalancer <loadbalancer>]
                                           [--compute-id <compute-id>]
                                           [--role {BACKUP,MASTER,STANDALONE}]
                                           [--status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}]

Expand
表49.5 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--loadbalancer <loadbalancer>

ロードバランサーでフィルタリングします(名前または ID)。

--compute-id <compute-id>

コンピュート ID でフィルタリングします。

--role {BACKUP,MASTER,STANDALONE}

ロールでフィルタリングします。

--status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}, --provisioning-status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}

amphora のプロビジョニングステータスでフィルタリングします。

Expand
表49.6 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表49.7 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表49.8 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.9 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.4. loadbalancer amphora show

1 つの amphora の詳細を表示します。

使用方法

openstack loadbalancer amphora show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           <amphora-id>

Expand
表49.10 位置引数
概要

<amphora-id>

amphora の UUID

Expand
表49.11 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.12 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.13 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.14 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.15 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.5. loadbalancer create

ロードバランサーを作成します。

使用方法

openstack loadbalancer create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--name <name>]
                                     [--description <description>]
                                     [--vip-address <vip_address>]
                                     [--vip-port-id <vip_port_id>]
                                     [--vip-subnet-id <vip_subnet_id>]
                                     [--vip-network-id <vip_network_id>]
                                     [--vip-qos-policy-id <vip_qos_policy_id>]
                                     [--project <project>]
                                     [--provider <provider>]
                                     [--enable | --disable]
                                     [--flavor <flavor>]

Expand
表49.16 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新しいロードバランサー名。

--description <description>

ロードバランサーの説明を設定します。

--vip-address <vip_address>

vip ip アドレスを設定します。

--vip-qos-policy-id <vip_qos_policy_id>

vip port に qos policy id を設定します。設定を解除する場合は none にします。

--project <project>

ロードバランサーのプロジェクト(名前または id)。

--provider <provider>

ロードバランサーのプロバイダー名。

--enable

ロードバランサーを有効にします(デフォルト)。

--disable

ロードバランサーを無効にします。

--flavor <flavor>

ロードバランサーのフレーバーの名前または ID。

Expand
表49.17 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.18 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.19 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.20 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

Expand
表49.21 VIP ネットワーク
概要

少なくとも以下の引数のいずれかが必要です。--vip-port-id <vip_port_id>

ロードバランサーのポートを設定します(名前または id)。

--vip-subnet-id <vip_subnet_id>

ロードバランサーにサブネットを設定します(名前または ID)。

--vip-network-id <vip_network_id>

ロードバランサーにネットワークを設定します(名前または id)。

49.6. loadbalancer delete

ロードバランサーを削除します。

使用方法

openstack loadbalancer delete [-h] [--cascade] <load_balancer>

Expand
表49.22 位置引数
概要

<load_balancer>

削除するロードバランサー(名前または ID)

Expand
表49.23 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--cascade

削除をロードバランサーのすべての子要素に適用します。

49.7. loadbalancer failover

ロードバランサーのフェイルオーバーをトリガーします。

使用方法

openstack loadbalancer failover [-h] <load_balancer>

Expand
表49.24 位置引数
概要

<load_balancer>

ロードバランサーの名前または uuid

Expand
表49.25 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

49.8. loadbalancer flavor create

octavia フレーバーを作成します。

使用方法

openstack loadbalancer flavor create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            --name <name> --flavorprofile
                                            <flavor_profile>
                                            [--description <description>]
                                            [--enable | --disable]

Expand
表49.26 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新規フレーバー名。

--flavorprofile <flavor_profile>

フレーバーを追加するフレーバープロファイル(名前または ID)

--description <description>

フレーバーの説明を設定します。

--enable

フレーバーを有効にします。

--disable

フレーバーを無効にします。

Expand
表49.27 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.28 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.29 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.30 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.9. loadbalancer flavor delete

フレーバーを削除します。

使用方法

openstack loadbalancer flavor delete [-h] <flavor>

Expand
表49.31 位置引数
概要

<flavor>

削除するフレーバー(名前または ID)

Expand
表49.32 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

49.10. loadbalancer flavor list

フレーバーを一覧表示します。

使用方法

openstack loadbalancer flavor 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>]
                                          [--flavorprofile <flavor_profile>]
                                          [--enable | --disable]

Expand
表49.33 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

名前に従ってフレーバーを一覧表示します。

--flavorprofile <flavor_profile>

フレーバープロファイルに従ってフレーバーを一覧表示します。

--enable

有効なフレーバーを一覧表示します。

--disable

無効なフレーバーを一覧表示します。

Expand
表49.34 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表49.35 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表49.36 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.37 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.11. loadbalancer flavor set

フレーバーを更新します。

使用方法

openstack loadbalancer flavor set [-h] [--name <name>]
                                         [--enable | --disable]
                                         <flavor>

Expand
表49.38 位置引数
概要

<flavor>

更新するフレーバーの名前または uuid

Expand
表49.39 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

フレーバーの名前を設定します。

--enable

フレーバーを有効にします。

--disable

フレーバーを無効にします。

49.12. loadbalancer flavor show

1 つのフレーバーの詳細を表示します。

使用方法

openstack loadbalancer flavor show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <flavor>

Expand
表49.40 位置引数
概要

<flavor>

フレーバーの名前または uuid

Expand
表49.41 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.42 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.43 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.44 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.45 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.13. loadbalancer flavorprofile create

octavia フレーバープロファイルを作成します。

使用方法

openstack loadbalancer flavorprofile create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty] --name
                                                   <name> --provider <provider
                                                   name> --flavor-data
                                                   <flavor_data>

Expand
表49.46 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新規 octavia フレーバープロファイル名。

--provider <provider name>

フレーバープロファイルのプロバイダー名。

--flavor-data <flavor_data>

フレーバーメタデータが含まれる json 文字列。

Expand
表49.47 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.48 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.49 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.50 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.14. loadbalancer flavorprofile delete

フレーバープロファイルを削除します。

使用方法

openstack loadbalancer flavorprofile delete [-h] <flavor_profile>

Expand
表49.51 位置引数
概要

<flavor_profile>

削除するフレーバープロファイル(名前または ID)

Expand
表49.52 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

49.15. loadbalancer flavorprofile list

フレーバープロファイルを一覧表示します。

使用方法

openstack loadbalancer flavorprofile 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>]
                                                 [--provider <provider_name>]

Expand
表49.53 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

フレーバープロファイル名でフレーバープロファイルを一覧表示します。

--provider <provider_name>

プロバイダーに従ってフレーバープロファイルを一覧表示します。

Expand
表49.54 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表49.55 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表49.56 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.57 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.16. loadbalancer flavorprofile set

フレーバープロファイルを更新します。

使用方法

openstack loadbalancer flavorprofile set [-h] [--name <name>]
                                                [--provider <provider_name>]
                                                [--flavor-data <flavor_data>]
                                                <flavor_profile>

Expand
表49.58 位置引数
概要

<flavor_profile>

更新するフレーバープロファイルの名前または uuid。

Expand
表49.59 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

フレーバープロファイルの名前を設定します。

--provider <provider_name>

フレーバープロファイルのプロバイダーを設定します。

--flavor-data <flavor_data>

フレーバープロファイルのフレーバーデータを設定します。

49.17. loadbalancer flavorprofile show

1 つのフレーバープロファイルの詳細を表示します。

使用方法

openstack loadbalancer flavorprofile show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 <flavor_profile>

Expand
表49.60 位置引数
概要

<flavor_profile>

表示するフレーバープロファイルの名前または uuid

Expand
表49.61 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.62 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.63 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.64 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.65 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.18. loadbalancer healthmonitor create

ヘルスモニターを作成します。

使用方法

openstack loadbalancer healthmonitor create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--name <name>] --delay
                                                   <delay>
                                                   [--domain-name <domain_name>]
                                                   [--expected-codes <codes>]
                                                   [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
                                                   [--http-version <http_version>]
                                                   --timeout <timeout>
                                                   --max-retries <max_retries>
                                                   [--url-path <url_path>]
                                                   --type
                                                   {PING,HTTP,TCP,HTTPS,TLS-HELLO,UDP-CONNECT}
                                                   [--max-retries-down <max_retries_down>]
                                                   [--enable | --disable]
                                                   <pool>

Expand
表49.66 位置引数
概要

<pool>

ヘルスモニターのプールを設定します(名前または ID)。

Expand
表49.67 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ヘルスモニター名を設定します。

--delay <delay>

プローブをメンバーに送信する間隔を秒単位で設定します。

--domain-name <domain_name>

HTTP ヘルスチェックのバックエンドサーバーに、http ホストヘッダーにインジェクトされるドメイン名を設定します。

--expected-codes <codes>

正常であることを宣言するためのメンバーからの応答で予想される http ステータスコードの一覧を設定します。

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

ヘルスモニターがリクエストに使用する http メソッドを設定します。

--http-version <http_version>

http バージョンを設定します。

--timeout <timeout>

モニターが接続を待つ最大のタイムアウト時間を秒単位で設定します。この値は delay 値よりも小さくなければなりません。

--max-retries <max_retries>

メンバーの稼働ステータスを ONLINE に変更するのに必要な正常なチェックの数。

--url-path <url_path>

バックエンドメンバーの健全性をテストするためにモニターによって送信されるリクエストの http url パスを設定します。

--type {PING,HTTP,TCP,HTTPS,TLS-HELLO,UDP-CONNECT}

ヘルスモニターのタイプを設定します。

--max-retries-down <max_retries_down>

メンバーのオペレーティングステータスを ERROR に変更する前に許容されるチェックの失敗数を設定します。

--enable

ヘルスモニターを有効にします(デフォルト)。

--disable

ヘルスモニターを無効にします。

Expand
表49.68 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.69 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.70 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.71 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.19. loadbalancer healthmonitor delete

ヘルスモニターを削除します。

使用方法

openstack loadbalancer healthmonitor delete [-h] <health_monitor>

Expand
表49.72 位置引数
概要

<health_monitor>

削除するヘルスモニター(名前または ID)

Expand
表49.73 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

49.20. loadbalancer healthmonitor list

ヘルスモニターを一覧表示します。

使用方法

openstack loadbalancer healthmonitor 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]

Expand
表49.74 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.75 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表49.76 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表49.77 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.78 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.21. loadbalancer healthmonitor set

ヘルスモニターを更新します。

使用方法

openstack loadbalancer healthmonitor set [-h] [--name <name>]
                                                [--delay <delay>]
                                                [--domain-name <domain_name>]
                                                [--expected-codes <codes>]
                                                [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
                                                [--http-version <http_version>]
                                                [--timeout <timeout>]
                                                [--max-retries <max_retries>]
                                                [--max-retries-down <max_retries_down>]
                                                [--url-path <url_path>]
                                                [--enable | --disable]
                                                <health_monitor>

Expand
表49.79 位置引数
概要

<health_monitor>

更新するヘルスモニター(名前または ID)

Expand
表49.80 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ヘルスモニター名を設定します。

--delay <delay>

プローブをメンバーに送信する間隔を秒単位で設定します。

--domain-name <domain_name>

HTTP ヘルスチェックのバックエンドサーバーに、http ホストヘッダーにインジェクトされるドメイン名を設定します。

--expected-codes <codes>

正常であることを宣言するためのメンバーからの応答で予想される http ステータスコードの一覧を設定します。

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

ヘルスモニターがリクエストに使用する http メソッドを設定します。

--http-version <http_version>

http バージョンを設定します。

--timeout <timeout>

モニターが接続を待つ最大のタイムアウト時間を秒単位で設定します。この値は delay 値よりも小さくなければなりません。

--max-retries <max_retries>

メンバーの稼働ステータスを ONLINE に変更するのに必要な正常なチェックの数を設定します。

--max-retries-down <max_retries_down>

メンバーのオペレーティングステータスを ERROR に変更する前に許容されるチェックの失敗数を設定します。

--url-path <url_path>

バックエンドメンバーの健全性をテストするためにモニターによって送信されるリクエストの http url パスを設定します。

--enable

ヘルスモニターを有効にします。

--disable

ヘルスモニターを無効にします。

49.22. loadbalancer healthmonitor show

単一のヘルスモニターの詳細を表示します。

使用方法

openstack loadbalancer healthmonitor show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 <health_monitor>

Expand
表49.81 位置引数
概要

<health_monitor>

ヘルスモニターの名前または uuid。

Expand
表49.82 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.83 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.84 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.85 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.86 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.23. loadbalancer l7policy create

l7policy を作成します。

使用方法

openstack loadbalancer l7policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--name <name>]
                                              [--description <description>]
                                              --action
                                              {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}
                                              [--redirect-pool <pool> | --redirect-url <url> | --redirect-prefix <url>]
                                              [--redirect-http-code <redirect_http_code>]
                                              [--position <position>]
                                              [--enable | --disable]
                                              <listener>

Expand
表49.87 位置引数
概要

<listener>

l7policy をに追加するリスナー(名前または id)。

Expand
表49.88 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

l7policy 名を設定します。

--description <description>

l7policy の説明を設定します。

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}

ポリシーのアクションを設定します。

--redirect-pool <pool>

要求をリダイレクトするプールを設定します(名前または ID)。

--redirect-url <url>

要求のリダイレクト先となる URL を設定します。

--redirect-prefix <url>

要求のリダイレクト先となる url プレフィックスを設定します。

--redirect-http-code <redirect_http_code>

redirect_url またはREDIRECT_PREFIX アクションの http 応答コードを設定します。

--position <position>

この l7 ポリシーのシーケンス番号。

--enable

l7policyを有効にします(デフォルト)。

--disable

l7policy を無効にします。

Expand
表49.89 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.90 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.91 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.92 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.24. loadbalancer l7policy delete

l7policy を削除します。

使用方法

openstack loadbalancer l7policy delete [-h] <policy>

Expand
表49.93 位置引数
概要

<policy>

削除するL7policy(名前または ID)。

Expand
表49.94 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

49.25. loadbalancer l7policy list

l7policies を一覧表示します。

使用方法

openstack loadbalancer l7policy 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]

Expand
表49.95 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.96 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表49.97 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表49.98 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.99 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.26. loadbalancer l7policy set

l7policy を更新します。

使用方法

openstack loadbalancer l7policy set [-h] [--name <name>]
                                           [--description <description>]
                                           [--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}]
                                           [--redirect-pool <pool> | --redirect-url <url> | --redirect-prefix <url>]
                                           [--redirect-http-code <redirect_http_code>]
                                           [--position <position>]
                                           [--enable | --disable]
                                           <policy>

Expand
表49.100 位置引数
概要

<policy>

更新する L7policy(名前または ID)。

Expand
表49.101 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

l7policy 名を設定します。

--description <description>

l7policy の説明を設定します。

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}

ポリシーのアクションを設定します。

--redirect-pool <pool>

要求をリダイレクトするプールを設定します(名前または ID)。

--redirect-url <url>

要求のリダイレクト先となる URL を設定します。

--redirect-prefix <url>

要求のリダイレクト先となる url プレフィックスを設定します。

--redirect-http-code <redirect_http_code>

redirect_url またはREDIRECT_PREFIX アクションの http 応答コードを設定します。

--position <position>

この l7 ポリシーのシーケンス番号を設定します。

--enable

l7policy を有効にします。

--disable

l7policy を無効にします。

49.27. loadbalancer l7policy show

1 つの l7policy の詳細を表示します。

使用方法

openstack loadbalancer l7policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <policy>

Expand
表49.102 位置引数
概要

<policy>

l7policy の名前または uuid

Expand
表49.103 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.104 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.105 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.106 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.107 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.28. loadbalancer l7rule create

l7rule を作成します。

使用方法

openstack loadbalancer l7rule create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            --compare-type
                                            {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}
                                            [--invert] --value <value>
                                            [--key <key>] --type
                                            {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}
                                            [--enable | --disable]
                                            <l7policy>

Expand
表49.108 位置引数
概要

<l7policy>

l7rule を追加する L7policy(名前または ID)。

Expand
表49.109 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

l7rule の比較タイプを設定します。

--invert

l7ruleを反転します。

--value <value>

照合するルールの値を設定します。

--key <key>

照合するl7rule の値のキーを設定します。

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}

l7rule のタイプを設定します。

--enable

l7ruleを有効にします(デフォルト)。

--disable

l7rule を無効にします。

Expand
表49.110 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.111 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.112 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.113 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.29. loadbalancer l7rule delete

l7rule を削除します。

使用方法

openstack loadbalancer l7rule delete [-h] <l7policy> <rule_id>

Expand
表49.114 位置引数
概要

<l7policy>

ルールを削除するL7policy(名前または ID)

<rule_id>

削除する L7rule。

Expand
表49.115 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

49.30. loadbalancer l7rule list

l7policy の l7rules を一覧表示します。

使用方法

openstack loadbalancer l7rule 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]
                                          <l7policy>

Expand
表49.116 位置引数
概要

<l7policy>

ルールを一覧表示するL7policy(名前または ID)

Expand
表49.117 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.118 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表49.119 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表49.120 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.121 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.31. loadbalancer l7rule set

l7rule を更新します。

使用方法

openstack loadbalancer l7rule set [-h]
                                         [--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}]
                                         [--invert] [--value <value>]
                                         [--key <key>]
                                         [--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}]
                                         [--enable | --disable]
                                         <l7policy> <l7rule_id>

Expand
表49.122 位置引数
概要

<l7policy>

l7ruleを更新するl7policy(名前または id)

<l7rule_id>

更新する L7rule。

Expand
表49.123 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

l7rule の比較タイプを設定します。

--invert

l7ruleを反転します。

--value <value>

照合するルールの値を設定します。

--key <key>

照合するl7rule の値のキーを設定します。

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}

l7rule のタイプを設定します。

--enable

l7rule を有効にします。

--disable

l7rule を無効にします。

49.32. loadbalancer l7rule show

1 つの l7ruleの詳細を表示します。

使用方法

openstack loadbalancer l7rule show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <l7policy> <l7rule_id>

Expand
表49.124 位置引数
概要

<l7policy>

ルールを表示するL7policy(名前または ID)。

<l7rule_id>

表示する L7rule。

Expand
表49.125 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.126 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.127 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.128 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.129 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.33. loadbalancer list

ロードバランサーを一覧表示します。

使用方法

openstack loadbalancer 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>]
                                   [--enable | --disable]
                                   [--project <project-id>]
                                   [--vip-network-id <vip_network_id>]
                                   [--vip-subnet-id <vip_subnet_id>]
                                   [--vip-qos-policy-id <vip_qos_policy_id>]
                                   [--vip-port-id <vip_port_id>]
                                   [--provisioning-status {ACTIVE,DELETED,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE}]
                                   [--operating-status {ONLINE,DRAINING,OFFLINE,DEGRADED,ERROR,NO_MONITOR}]
                                   [--provider <provider>] [--flavor <flavor>]

Expand
表49.130 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

名前に従ってロードバランサーを一覧表示します。

--enable

有効なロードバランサーを一覧表示します。

--disable

無効にされたロードバランサーを一覧表示します。

--project <project-id>

プロジェクトに従ってロードバランサーを一覧表示します(名前または ID)。

--vip-network-id <vip_network_id>

vip ネットワークに従ってロードバランサーを一覧表示します(名前または ID)。

--vip-subnet-id <vip_subnet_id>

vip サブネットに従ってロードバランサーを一覧表示します(名前または ID)。

--vip-qos-policy-id <vip_qos_policy_id>

vip qos ポリシーに従ってロードバランサーを一覧表示します(名前または ID)。

--vip-port-id <vip_port_id>

vip ポートに従ってロードバランサーを一覧表示します(名前または ID)。

--provisioning-status {ACTIVE,DELETED,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE}

プロビジョニングのステータスに従ってロードバランサーを一覧表示します。

--operating-status {ONLINE,DRAINING,OFFLINE,DEGRADED,ERROR,NO_MONITOR}

動作ステータスに従ってロードバランサーを一覧表示します。

--provider <provider>

プロバイダーに従ってロードバランサーを一覧表示します。

--flavor <flavor>

フレーバーに従ってロードバランサーを一覧表示します。

Expand
表49.131 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表49.132 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表49.133 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.134 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.34. loadbalancer listener create

リスナーを作成します。

使用方法

openstack loadbalancer listener create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--name <name>]
                                              [--description <description>]
                                              --protocol
                                              {TCP,HTTP,HTTPS,TERMINATED_HTTPS,UDP}
                                              [--connection-limit <limit>]
                                              [--default-pool <pool>]
                                              [--default-tls-container-ref <container_ref>]
                                              [--sni-container-refs [<container_ref> [<container_ref> ...]]]
                                              [--insert-headers <header=value,...>]
                                              --protocol-port <port>
                                              [--timeout-client-data <timeout>]
                                              [--timeout-member-connect <timeout>]
                                              [--timeout-member-data <timeout>]
                                              [--timeout-tcp-inspect <timeout>]
                                              [--enable | --disable]
                                              [--client-ca-tls-container-ref <container_ref>]
                                              [--client-authentication {NONE,OPTIONAL,MANDATORY}]
                                              [--client-crl-container-ref <client_crl_container_ref>]
                                              <loadbalancer>

Expand
表49.135 位置引数
概要

<loadbalancer>

リスナーのロードバランサー(名前または id)

Expand
表49.136 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

リスナー名を設定します。

--description <description>

このリスナーの説明を設定します。

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,UDP}

リスナーのプロトコル。

--connection-limit <limit>

このリスナーで許可される接続の最大数を設定します。

--default-pool <pool>

L7 ポリシーが一致しない場合、リスナーによって使用されるプールの名前または ID を設定します。

--default-tls-container-ref <container_ref>

TERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--sni-container-refs [<container_ref> [<container_ref> …​]]

Server Name Indication を使用するTERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI の一覧。

--insert-headers <header=value,…​>

バックエンドメンバーに送信される前にリクエストに挿入するオプションヘッダーのディクショナリー。

--protocol-port <port>

リスナーのプロトコルポート番号を設定します。

--timeout-client-data <timeout>

フロントエンドクライアントの停止状態タイムアウト(ミリ秒単位)。デフォルト: 50000。

--timeout-member-connect <timeout>

バックエンドメンバーの接続タイムアウト(ミリ秒単位)。Default: 5000。

--timeout-member-data <timeout>

バックエンドメンバーの停止状態タイムアウト(ミリ秒単位)。デフォルト: 50000。

--timeout-tcp-inspect <timeout>

コンテンツの検査用に追加の tcp パケットを待機する時間(ミリ秒単位)。デフォルト: 0

--enable

リスナーを有効にします(デフォルト)。

--disable

リスナーを無効にします。

--client-ca-tls-container-ref <container_ref>

TERMINATED_TLS リスナーのCA証明書が含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--client-authentication {NONE,OPTIONAL,MANDATORY}

TERMINATED_TLS リスナーのtls クライアントの認証検証オプション。

--client-crl-container-ref <client_crl_container_ref>

TERMINATED_TLS リスナーのCA失効リストファイルが含まれるキーマネージャーサービスシークレットコンテナーへの URI。

Expand
表49.137 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.138 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.139 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.140 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.35. loadbalancer listener delete

リスナーを削除します。

使用方法

openstack loadbalancer listener delete [-h] <listener>

Expand
表49.141 位置引数
概要

<listener>

削除するリスナー(名前または ID)

Expand
表49.142 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

49.36. loadbalancer listener list

リスナーの一覧を表示します。

使用方法

openstack loadbalancer listener 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>]
                                            [--loadbalancer <loadbalancer>]
                                            [--enable | --disable]
                                            [--project <project>]

Expand
表49.143 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

リスナー名でリスナーを一覧表示します。

--loadbalancer <loadbalancer>

ロードバランサーでフィルタリングします(名前または ID)。

--enable

有効なリスナーを一覧表示します。

--disable

無効なリスナーを一覧表示します。

--project <project>

プロジェクト ID でリスナーを一覧表示します。

Expand
表49.144 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表49.145 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表49.146 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.147 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.37. loadbalancer listener set

リスナーを更新します。

使用方法

openstack loadbalancer listener set [-h] [--name <name>]
                                           [--description <description>]
                                           [--connection-limit <limit>]
                                           [--default-pool <pool>]
                                           [--default-tls-container-ref <container-ref>]
                                           [--sni-container-refs [<container-ref> [<container-ref> ...]]]
                                           [--insert-headers <header=value>]
                                           [--timeout-client-data <timeout>]
                                           [--timeout-member-connect <timeout>]
                                           [--timeout-member-data <timeout>]
                                           [--timeout-tcp-inspect <timeout>]
                                           [--enable | --disable]
                                           [--client-ca-tls-container-ref <container_ref>]
                                           [--client-authentication {NONE,OPTIONAL,MANDATORY}]
                                           [--client-crl-container-ref <client_crl_container_ref>]
                                           <listener>

Expand
表49.148 位置引数
概要

<listener>

変更するリスナー(名前または ID)。

Expand
表49.149 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

リスナー名を設定します。

--description <description>

このリスナーの説明を設定します。

--connection-limit <limit>

このリスナーで許可される接続の最大数。デフォルト値は -1 で、無限接続を表します。

--default-pool <pool>

l7 ポリシーが一致していない場合、リスナーによって使用されるプールの ID。

--default-tls-container-ref <container-ref>

TERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--sni-container-refs [<container-ref> [<container-ref> …​]]

Server Name Indication を使用するTERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI の一覧。

--insert-headers <header=value>

バックエンドメンバーに送信される前にリクエストに挿入するオプションヘッダーのディクショナリー。

--timeout-client-data <timeout>

フロントエンドクライアントの停止状態タイムアウト(ミリ秒単位)。デフォルト: 50000。

--timeout-member-connect <timeout>

バックエンドメンバーの接続タイムアウト(ミリ秒単位)。Default: 5000。

--timeout-member-data <timeout>

バックエンドメンバーの停止状態タイムアウト(ミリ秒単位)。デフォルト: 50000。

--timeout-tcp-inspect <timeout>

コンテンツの検査用に追加の tcp パケットを待機する時間(ミリ秒単位)。デフォルト: 0

--enable

リスナーを有効にします。

--disable

リスナーを無効にします。

--client-ca-tls-container-ref <container_ref>

TERMINATED_TLS リスナーのCA証明書が含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--client-authentication {NONE,OPTIONAL,MANDATORY}

TERMINATED_TLS リスナーのtls クライアントの認証検証オプション。

--client-crl-container-ref <client_crl_container_ref>

TERMINATED_TLS リスナーのCA失効リストファイルが含まれるキーマネージャーサービスシークレットコンテナーへの URI。

49.38. loadbalancer listener show

単一のリスナーの詳細を表示します。

使用方法

openstack loadbalancer listener show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <listener>

Expand
表49.150 位置引数
概要

<listener>

リスナーの名前または uuid

Expand
表49.151 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.152 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.153 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.154 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.155 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.39. loadbalancer listener stats show

リスナーの現在の統計を表示します。

使用方法

openstack loadbalancer listener stats show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  <listener>

Expand
表49.156 位置引数
概要

<listener>

リスナーの名前または uuid

Expand
表49.157 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.158 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.159 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.160 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.161 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.40. loadbalancer member create

プールにメンバーを作成します。

使用方法

openstack loadbalancer member create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--name <name>]
                                            [--disable-backup | --enable-backup]
                                            [--weight <weight>] --address
                                            <ip_address>
                                            [--subnet-id <subnet_id>]
                                            --protocol-port <protocol_port>
                                            [--monitor-port <monitor_port>]
                                            [--monitor-address <monitor_address>]
                                            [--enable | --disable]
                                            <pool>

Expand
表49.162 位置引数
概要

<pool>

メンバーを作成するプールの ID または名前。

Expand
表49.163 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

メンバーの名前。

--disable-backup

メンバーバックアップを無効にします(デフォルト)。

--enable-backup

メンバーバックアップを有効にします。

--weight <weight>

プールの他のメンバーと比較して、提供する要求または接続の部分を決定するメンバーの重み。

--address <ip_address>

バックエンドメンバーサーバーの IP アドレス

--subnet-id <subnet_id>

メンバーサービスがアクセスできるサブネット ID。

--protocol-port <protocol_port>

バックエンドメンバーサーバーがリッスンするプロトコルポート番号。

--monitor-port <monitor_port>

バックエンドメンバーの正常性モニタリングに使用する別のプロトコルポート。

--monitor-address <monitor_address>

バックエンドメンバーの正常性モニタリングに使用する別の IP アドレス。

--enable

メンバーを有効にします(デフォルト)。

--disable

メンバーを無効にします。

Expand
表49.164 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.165 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.166 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.167 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.41. loadbalancer member delete

プールからメンバーを削除します。

使用方法

openstack loadbalancer member delete [-h] <pool> <member>

Expand
表49.168 位置引数
概要

<pool>

メンバーを削除するプール名または id。

<member>

削除するメンバーの名前または ID。

Expand
表49.169 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

49.42. loadbalancer member list

プール内のメンバーを一覧表示します。

使用方法

openstack loadbalancer member 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]
                                          <pool>

Expand
表49.170 位置引数
概要

<pool>

メンバーを一覧表示するプール名または id。

Expand
表49.171 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.172 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表49.173 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表49.174 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.175 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.43. loadbalancer member set

メンバーを更新します。

使用方法

openstack loadbalancer member set [-h] [--name <name>]
                                         [--disable-backup | --enable-backup]
                                         [--weight <weight>]
                                         [--monitor-port <monitor_port>]
                                         [--monitor-address <monitor_address>]
                                         [--enable | --disable]
                                         <pool> <member>

Expand
表49.176 位置引数
概要

<pool>

更新するメンバーが属するプール(名前または ID)。

<member>

更新するメンバーの名前または ID

Expand
表49.177 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

メンバーの名前を設定します。

--disable-backup

メンバーバックアップを無効にします(デフォルト)。

--enable-backup

メンバーバックアップを有効にします。

--weight <weight>

プール内のメンバーの重みを設定します。

--monitor-port <monitor_port>

バックエンドメンバーの正常性モニタリングに使用する別のプロトコルポート。

--monitor-address <monitor_address>

バックエンドメンバーの正常性モニタリングに使用する別の IP アドレス。

--enable

admin_state_up を true に設定します。

--disable

admin_state_up を false に設定します。

49.44. loadbalancer member show

1 つのメンバーの詳細を表示します。

使用方法

openstack loadbalancer member show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <pool> <member>

Expand
表49.178 位置引数
概要

<pool>

メンバーを表示するプール名または id。

<member>

表示するメンバーの名前または ID。

Expand
表49.179 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.180 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.181 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.182 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.183 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.45. loadbalancer pool create

プールを作成します。

使用方法

openstack loadbalancer pool create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--name <name>]
                                          [--description <description>]
                                          --protocol
                                          {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY,UDP}
                                          (--listener <listener> | --loadbalancer <load_balancer>)
                                          [--session-persistence <session persistence>]
                                          --lb-algorithm
                                          {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}
                                          [--enable | --disable]
                                          [--tls-container-ref <container-ref>]
                                          [--ca-tls-container-ref <ca_tls_container_ref>]
                                          [--crl-container-ref <crl_container_ref>]
                                          [--enable-tls | --disable-tls]

Expand
表49.184 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

プール名を設定します。

--description <description>

プールの説明を設定します。

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY,UDP}

プールプロトコルを設定します。

--listener <listener>

プールを追加するリスナー(名前または ID)。

--loadbalancer <load_balancer>

プールを追加するロードバランサー(名前または ID)

--session-persistence <session persistence>

リスナーのセッション永続性を設定します(key=value)。

--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}

使用するロードバランシングアルゴリズム。

--enable

プールを有効にします(デフォルト)。

--disable

プールを無効にします。

--tls-container-ref <container-ref>

バックエンドメンバーサーバーへのトラフィックを再暗号化するための``tls_enabled``プールの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの参照。

--ca-tls-container-ref <ca_tls_container_ref>

バックエンドメンバーサーバー証明書を確認するための``tls_enabled``プールのCA証明書が含まれるキーマネージャーサービスシークレットコンテナーへの参照。

--crl-container-ref <crl_container_ref>

バックエンドメンバーサーバー証明書を検証するための``tls_enabled``プールのCA失効リストファイルが含まれるキーマネージャーサービスシークレットコンテナーへの参照。

--enable-tls

バックエンドメンバーの再暗号化を有効にします。

--disable-tls

バックエンドメンバーの再暗号化を無効にします。

Expand
表49.185 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.186 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.187 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.188 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.46. loadbalancer pool delete

プールを削除します。

使用方法

openstack loadbalancer pool delete [-h] <pool>

Expand
表49.189 位置引数
概要

<pool>

削除するプール(名前または ID)

Expand
表49.190 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

49.47. loadbalancer pool list

プールを一覧表示します。

使用方法

openstack loadbalancer pool 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]
                                        [--loadbalancer <loadbalancer>]

Expand
表49.191 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--loadbalancer <loadbalancer>

ロードバランサーでフィルタリングします(名前または ID)。

Expand
表49.192 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表49.193 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表49.194 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.195 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.48. loadbalancer pool set

プールを更新します。

使用方法

openstack loadbalancer pool set [-h] [--name <name>]
                                       [--description <description>]
                                       [--session-persistence <session_persistence>]
                                       [--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}]
                                       [--enable | --disable]
                                       [--tls-container-ref <container-ref>]
                                       [--ca-tls-container-ref <ca_tls_container_ref>]
                                       [--crl-container-ref <crl_container_ref>]
                                       [--enable-tls | --disable-tls]
                                       <pool>

Expand
表49.196 位置引数
概要

<pool>

更新するプール(名前または ID)。

Expand
表49.197 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

プールの名前を設定します。

--description <description>

プールの説明を設定します。

--session-persistence <session_persistence>

リスナーのセッション永続性を設定します(key=value)。

--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}

使用するロードバランシングアルゴリズムを設定します。

--enable

プールを有効にします。

--disable

プールを無効にします。

--tls-container-ref <container-ref>

TERMINATED_TLSリスナーからバックエンドサーバーへのトラフィックを再暗号化するためのTERMINATED_TLSプールの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへのuri。

--ca-tls-container-ref <ca_tls_container_ref>

sslトラフィックのバックエンドサーバー証明書を確認するためのTERMINATED_TLS リスナーのCA証明書が含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--crl-container-ref <crl_container_ref>

sslトラフィックのバックエンドサーバー証明書を検証するためのTERMINATED_TLS リスナーのCA失効リストファイルが含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--enable-tls

バックエンドの関連メンバーの再暗号化を有効にします。

--disable-tls

バックエンドの関連メンバーの再暗号化を無効にします。

49.49. loadbalancer pool show

単一プールの詳細を表示します。

使用方法

openstack loadbalancer pool show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <pool>

Expand
表49.198 位置引数
概要

<pool>

プールの名前または uuid。

Expand
表49.199 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.200 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.201 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.202 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.203 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.50. loadbalancer provider capability list

指定したプロバイダードライバーのフレーバーの機能を一覧表示します。

使用方法

openstack loadbalancer provider capability 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]
                                                       <provider_name>

Expand
表49.204 位置引数
概要

<provider_name>

プロバイダードライバーの名前。

Expand
表49.205 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.206 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表49.207 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表49.208 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.209 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.51. loadbalancer provider list

プロバイダーの一覧を表示します。

使用方法

openstack loadbalancer provider 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]

Expand
表49.210 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.211 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表49.212 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表49.213 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.214 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.52. loadbalancer quota defaults show

クォータのデフォルトを表示します。

使用方法

openstack loadbalancer quota defaults show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]

Expand
表49.215 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.216 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.217 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.218 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.219 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.53. loadbalancer quota list

クォータを一覧表示します。

使用方法

openstack loadbalancer quota 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]
                                         [--project <project-id>]

Expand
表49.220 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project-id>

プロジェクトの名前または uuid。

Expand
表49.221 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表49.222 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表49.223 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.224 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.54. loadbalancer quota reset

クォータをデフォルトのクォータにリセットします。

使用方法

openstack loadbalancer quota reset [-h] <project>

Expand
表49.225 位置引数
概要

<project>

クォータをリセットするプロジェクト(名前または ID)

Expand
表49.226 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

49.55. loadbalancer quota set

クォータを更新します。

使用方法

openstack loadbalancer quota set [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--healthmonitor <health_monitor>]
                                        [--listener <listener>]
                                        [--loadbalancer <load_balancer>]
                                        [--member <member>] [--pool <pool>]
                                        <project>

Expand
表49.227 位置引数
概要

<project>

プロジェクトの名前または uuid。

Expand
表49.228 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.229 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.230 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.231 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.232 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

Expand
表49.233 クォータの制限
概要

以下の引数のいずれかが必要です。--healthmonitor <health_monitor>

ヘルスモニタークォータの新しい値。値が -1 の場合は無制限を意味します。

--listener <listener>

リスナークォータの新しい値。値が -1 の場合は無制限を意味します。

--loadbalancer <load_balancer>

ロードバランサークォータ制限の新しい値。値が -1 の場合は無制限を意味します。

--member <member>

メンバークォータ制限の新しい値。値が -1 の場合は無制限を意味します。

--pool <pool>

プールクォータ制限の新しい値。値が -1 の場合は無制限を意味します。

49.56. loadbalancer quota show

プロジェクトのクォータの詳細を表示します。

使用方法

openstack loadbalancer quota show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <project>

Expand
表49.234 位置引数
概要

<project>

プロジェクトの名前または uuid。

Expand
表49.235 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.236 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.237 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.238 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.239 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.57. loadbalancer set

ロードバランサーを更新します。

使用方法

openstack loadbalancer set [-h] [--name <name>]
                                  [--description <description>]
                                  [--vip-qos-policy-id <vip_qos_policy_id>]
                                  [--enable | --disable]
                                  <load_balancer>

Expand
表49.240 位置引数
概要

<load_balancer>

更新するロードバランサーの名前または uuid

Expand
表49.241 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ロードバランサー名を設定します。

--description <description>

ロードバランサーの説明を設定します。

--vip-qos-policy-id <vip_qos_policy_id>

vip port に qos policy id を設定します。設定を解除する場合は none にします。

--enable

ロードバランサーを有効にします。

--disable

ロードバランサーを無効にします。

49.58. loadbalancer show

単一のロードバランサーの詳細を表示します。

使用方法

openstack loadbalancer show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <load_balancer>

Expand
表49.242 位置引数
概要

<load_balancer>

ロードバランサーの名前または uuid

Expand
表49.243 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.244 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.245 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.246 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.247 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.59. loadbalancer stats show

ロードバランサーの現在の統計を表示します。

使用方法

openstack loadbalancer stats show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <load_balancer>

Expand
表49.248 位置引数
概要

<load_balancer>

ロードバランサーの名前または uuid

Expand
表49.249 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表49.250 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表49.251 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表49.252 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表49.253 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.60. loadbalancer status show

json 形式でのロードバランサーのステータスツリーを表示します。

使用方法

openstack loadbalancer status show [-h] <load_balancer>

Expand
表49.254 位置引数
概要

<load_balancer>

ロードバランサーの名前または uuid

Expand
表49.255 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

第50章 mapping

本章では、mapping コマンドに含まれるコマンドについて説明します。

50.1. mapping create

新規マッピングを作成します。

使用方法

openstack mapping create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] --rules <filename>
                                <name>

Expand
表50.1 位置引数
概要

<name>

新しいマッピング名(一意である必要があります)

Expand
表50.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--rules <filename>

一連のマッピングルールが含まれるファイル名(必須)

Expand
表50.3 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表50.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表50.5 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表50.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

50.2. mapping delete

マッピングを削除します。

使用方法

openstack mapping delete [-h] <mapping> [<mapping> ...]

Expand
表50.7 位置引数
概要

<mapping>

削除するマッピング

Expand
表50.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

50.3. mapping list

マッピングを一覧表示します。

使用方法

openstack mapping 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]

Expand
表50.9 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表50.10 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表50.11 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表50.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表50.13 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

50.4. mapping set

マッピングの属性を設定します。

使用方法

openstack mapping set [-h] [--rules <filename>] <name>

Expand
表50.14 位置引数
概要

<name>

変更するマッピング

Expand
表50.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--rules <filename>

新しいマッピングルールセットが含まれるファイル名

50.5. mapping show

マッピングの詳細を表示します。

使用方法

openstack mapping show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <mapping>

Expand
表50.16 位置引数
概要

<mapping>

表示するパッピング

Expand
表50.17 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表50.18 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表50.19 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表50.20 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表50.21 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第51章 messaging

本章では、messaging コマンドに含まれるコマンドについて説明します。

51.1. messaging claim create

要求を作成し、要求されたメッセージの一覧を返します。

使用方法

openstack messaging claim 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]
                                        [--ttl <ttl>] [--grace <grace>]
                                        [--limit <limit>]
                                        <queue_name>

Expand
表51.1 位置引数
概要

<queue_name>

要求するキューの名前

Expand
表51.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--ttl <ttl>

要求の存続期間(秒単位)

--grace <grace>

メッセージの猶予期間(秒単位)

--limit <limit>

制限まで、メッセージのセットを要求します。

Expand
表51.3 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表51.4 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表51.5 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.2. messaging claim query

要求の詳細を表示します。

使用方法

openstack messaging claim query [-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]
                                       <queue_name> <claim_id>

Expand
表51.7 位置引数
概要

<queue_name>

要求されたキューの名前

<claim_id>

要求の ID

Expand
表51.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表51.9 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表51.10 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表51.11 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.12 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.3. messaging claim release

要求を削除します。

使用方法

openstack messaging claim release [-h] <queue_name> <claim_id>

Expand
表51.13 位置引数
概要

<queue_name>

要求されたキューの名前

<claim_id>

削除する要求 ID

Expand
表51.14 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

51.4. messaging claim renew

要求を更新します。

使用方法

openstack messaging claim renew [-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]
                                       [--ttl <ttl>] [--grace <grace>]
                                       <queue_name> <claim_id>

Expand
表51.15 位置引数
概要

<queue_name>

要求されたキューの名前

<claim_id>

要求 ID

Expand
表51.16 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--ttl <ttl>

要求の存続期間(秒単位)

--grace <grace>

メッセージの猶予期間(秒単位)

Expand
表51.17 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表51.18 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表51.19 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.20 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.5. messaging flavor create

プールのフレーバーを作成します。

使用方法

openstack messaging flavor create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         [--capabilities <capabilities>]
                                         <flavor_name> <pool_group>

Expand
表51.21 位置引数
概要

<flavor_name>

フレーバーの名前

<pool_group>

フレーバーのプールグループ

Expand
表51.22 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--capabilities <capabilities>

フレーバー固有の機能を記述します。このオプションはクライアント api バージョン が 2 より前の場合のみ利用可能です。

Expand
表51.23 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表51.24 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.25 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表51.26 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.6. messaging flavor delete

プールのフレーバーを削除します。

使用方法

openstack messaging flavor delete [-h] <flavor_name>

Expand
表51.27 位置引数
概要

<flavor_name>

フレーバーの名前

Expand
表51.28 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

51.7. messaging flavor list

利用可能なプールのフレーバーを一覧表示します。

使用方法

openstack messaging flavor 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 <flavor_name>]
                                       [--limit <limit>] [--detailed]

Expand
表51.29 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker <flavor_name>

フレーバーのページングマーカー

--limit <limit>

ページサイズの制限

--detailed

フレーバーの詳細な機能を表示する場合

Expand
表51.30 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表51.31 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表51.32 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.33 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.8. messaging flavor show

プールフレーバーの詳細を表示します。

使用方法

openstack messaging flavor show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <flavor_name>

Expand
表51.34 位置引数
概要

<flavor_name>

表示するフレーバー(名前)

Expand
表51.35 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表51.36 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表51.37 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.38 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表51.39 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.9. messaging flavor update

フレーバーの属性を更新します。

使用方法

openstack messaging flavor update [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         [--pool_group <pool_group>]
                                         [--capabilities <capabilities>]
                                         <flavor_name>

Expand
表51.40 位置引数
概要

<flavor_name>

フレーバーの名前

Expand
表51.41 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--pool_group <pool_group>

フレーバーが配置されているプールグループ

--capabilities <capabilities>

フレーバー固有の機能を説明します。

Expand
表51.42 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表51.43 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.44 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表51.45 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.10. messaging health

Zaqar サーバーの詳細なヘルスステータスを表示します。

使用方法

openstack messaging health [-h]

Expand
表51.46 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

51.11. messaging homedoc

Zaqar サーバーの詳細なリソースドキュメントを表示します。

使用方法

openstack messaging homedoc [-h]

Expand
表51.47 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

51.12. messaging message list

指定のキューのすべてのメッセージを一覧表示します。

使用方法

openstack messaging message 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]
                                        [--message-ids <message_ids>]
                                        [--limit <limit>] [--echo]
                                        [--include-claimed]
                                        [--include-delayed]
                                        [--client-id <client_id>]
                                        <queue_name>

Expand
表51.48 位置引数
概要

<queue_name>

キューの名前

Expand
表51.49 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--message-ids <message_ids>

取得するメッセージの ID の一覧

--limit <limit>

取得するメッセージの最大数。

--echo

このクライアント自体のメッセージを受信するかどうか。

--include-claimed

要求されたメッセージを含めるかどうか。

--include-delayed

遅延メッセージを含めるかどうか。

--client-id <client_id>

各クライアントインスタンスの UUID。

Expand
表51.50 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表51.51 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表51.52 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.53 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.13. messaging message post

指定のキューのメッセージを投稿します。

使用方法

openstack messaging message post [-h] [--client-id <client_id>]
                                        <queue_name> <messages>

Expand
表51.54 位置引数
概要

<queue_name>

キューの名前

<messages>

投稿されるメッセージ。

Expand
表51.55 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--client-id <client_id>

各クライアントインスタンスの UUID。

51.14. messaging ping

Zaqar サーバーが稼働しているかどうかを確認します。

使用方法

openstack messaging ping [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]

Expand
表51.56 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表51.57 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表51.58 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.59 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表51.60 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.15. messaging pool create

プールを作成します。

使用方法

openstack messaging pool create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--pool_group <pool_group>]
                                       [--pool_options <pool_options>]
                                       <pool_name> <pool_uri> <pool_weight>

Expand
表51.61 位置引数
概要

<pool_name>

プールの名前

<pool_uri>

ストレージエンジン URI

<pool_weight>

プールの重み

Expand
表51.62 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--pool_group <pool_group>

プールのグループ

--pool_options <pool_options>

ストレージ固有のオプションに関連するオプションの要求コンポーネント

Expand
表51.63 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表51.64 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.65 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表51.66 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.16. messaging pool delete

プールを削除します。

使用方法

openstack messaging pool delete [-h] <pool_name>

Expand
表51.67 位置引数
概要

<pool_name>

プールの名前

Expand
表51.68 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

51.17. messaging pool list

利用可能なプールを一覧表示します。

使用方法

openstack messaging pool 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 <pool_name>] [--limit <limit>]
                                     [--detailed]

Expand
表51.69 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker <pool_name>

プールのページングマーカー

--limit <limit>

ページサイズの制限

--detailed

詳細出力

Expand
表51.70 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表51.71 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表51.72 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.73 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.18. messaging pool show

プールの詳細を表示します。

使用方法

openstack messaging pool show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <pool_name>

Expand
表51.74 位置引数
概要

<pool_name>

表示するプール(名前)

Expand
表51.75 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表51.76 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表51.77 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.78 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表51.79 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.19. messaging pool update

プール属性を更新します。

使用方法

openstack messaging pool update [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] [--pool_uri <pool_uri>]
                                       [--pool_weight <pool_weight>]
                                       [--pool_group <pool_group>]
                                       [--pool_options <pool_options>]
                                       <pool_name>

Expand
表51.80 位置引数
概要

<pool_name>

プールの名前

Expand
表51.81 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--pool_uri <pool_uri>

ストレージエンジン URI

--pool_weight <pool_weight>

プールの重み

--pool_group <pool_group>

プールのグループ

--pool_options <pool_options>

ストレージ固有のオプションに関連するオプションの要求コンポーネント

Expand
表51.82 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表51.83 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.84 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表51.85 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.20. messaging queue create

キューを作成します。

使用方法

openstack messaging queue create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <queue_name>

Expand
表51.86 位置引数
概要

<queue_name>

キューの名前

Expand
表51.87 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表51.88 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表51.89 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.90 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表51.91 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.21. messaging queue delete

キューを削除します。

使用方法

openstack messaging queue delete [-h] <queue_name>

Expand
表51.92 位置引数
概要

<queue_name>

キューの名前

Expand
表51.93 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

51.22. messaging queue get metadata

キューのメタデータを取得します。

使用方法

openstack messaging queue get metadata [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              <queue_name>

Expand
表51.94 位置引数
概要

<queue_name>

キューの名前

Expand
表51.95 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表51.96 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表51.97 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.98 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表51.99 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.23. messaging queue list

利用可能なキューを一覧表示します。

使用方法

openstack messaging queue 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 <queue_id>] [--limit <limit>]
                                      [--detailed]

Expand
表51.100 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker <queue_id>

キューのページングマーカー

--limit <limit>

ページサイズの制限

--detailed

キューの詳細情報を表示する場合

Expand
表51.101 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表51.102 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表51.103 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.104 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.24. messaging queue purge

キューをパージします。

使用方法

openstack messaging queue purge [-h]
                                       [--resource_types <resource_types>]
                                       <queue_name>

Expand
表51.105 位置引数
概要

<queue_name>

キューの名前

Expand
表51.106 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource_types <resource_types>

パージするリソースタイプ。

51.25. messaging queue set metadata

キューのメタデータを設定します。

使用方法

openstack messaging queue set metadata [-h]
                                              <queue_name> <queue_metadata>

Expand
表51.107 位置引数
概要

<queue_name>

キューの名前

<queue_metadata>

キューメタデータ。キューのメタデータはすべて queue_metadata に置き換えられます。

Expand
表51.108 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

51.26. messaging queue signed url

事前に署名された URL を作成します。

使用方法

openstack messaging queue signed url [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--paths <paths>]
                                            [--ttl-seconds <ttl_seconds>]
                                            [--methods <methods>]
                                            <queue_name>

Expand
表51.109 位置引数
概要

<queue_name>

キューの名前

Expand
表51.110 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--paths <paths>

許可されるパスのコンマ区切りリスト。オプション:messages、subscriptions、claims

--ttl-seconds <ttl_seconds>

署名の有効期限が切れるまでの期間(秒単位)

--methods <methods>

許可する HTTP メソッドのコンマ区切りリスト。オプション:GET、HEAD、OPTIONS、POST、PUT、DELETE

Expand
表51.111 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表51.112 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.113 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表51.114 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.27. messaging queue stats

キューの統計値を取得します。

使用方法

openstack messaging queue stats [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <queue_name>

Expand
表51.115 位置引数
概要

<queue_name>

キューの名前

Expand
表51.116 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表51.117 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表51.118 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.119 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表51.120 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.28. messaging subscription create

キューのサブスクリプションを作成します。

使用方法

openstack messaging subscription create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--options <options>]
                                               <queue_name> <subscriber> <ttl>

Expand
表51.121 位置引数
概要

<queue_name>

サブスクライブするキューの名前

<subscriber>

通知されるサブスクライバー

<ttl>

サブスクリプションの存続期間(秒単位)

Expand
表51.122 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--options <options>

json 形式のサブスクリプションのメタデータ

Expand
表51.123 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表51.124 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.125 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表51.126 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.29. messaging subscription delete

サブスクリプションを削除します。

使用方法

openstack messaging subscription delete [-h]
                                               <queue_name> <subscription_id>

Expand
表51.127 位置引数
概要

<queue_name>

サブスクリプションのキューの名前

<subscription_id>

サブスクリプションの ID

Expand
表51.128 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

51.30. messaging subscription list

利用可能なサブスクリプションを一覧表示します。

使用方法

openstack messaging subscription 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 <subscription_id>]
                                             [--limit <limit>]
                                             <queue_name>

Expand
表51.129 位置引数
概要

<queue_name>

サブスクライブするキューの名前

Expand
表51.130 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker <subscription_id>

サブスクリプションのページングマーカー、前のページにある最後のサブスクリプションの ID

--limit <limit>

ページサイズの制限。デフォルト値は 20 です。

Expand
表51.131 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表51.132 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表51.133 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.134 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.31. messaging subscription show

サブスクリプションの詳細を表示します。

使用方法

openstack messaging subscription show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <queue_name> <subscription_id>

Expand
表51.135 位置引数
概要

<queue_name>

サブスクライブするキューの名前

<subscription_id>

サブスクリプションの ID

Expand
表51.136 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表51.137 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表51.138 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.139 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表51.140 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.32. messaging subscription update

サブスクリプションを更新します。

使用方法

openstack messaging subscription update [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--subscriber <subscriber>]
                                               [--ttl <ttl>]
                                               [--options <options>]
                                               <queue_name> <subscription_id>

Expand
表51.141 位置引数
概要

<queue_name>

サブスクライブするキューの名前

<subscription_id>

サブスクリプションの ID

Expand
表51.142 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--subscriber <subscriber>

通知されるサブスクライバー

--ttl <ttl>

サブスクリプションの存続期間(秒単位)

--options <options>

json 形式のサブスクリプションのメタデータ

Expand
表51.143 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表51.144 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表51.145 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表51.146 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第52章 metric

本章では、metric コマンドに含まれるコマンドについて説明します。

52.1. metric aggregates

集約されたメトリクスの計測値を取得します。

使用方法

openstack metric aggregates [-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]
                                   [--resource-type RESOURCE_TYPE]
                                   [--start START] [--stop STOP]
                                   [--granularity GRANULARITY]
                                   [--needed-overlap NEEDED_OVERLAP]
                                   [--groupby GROUPBY] [--fill FILL]
                                   operations [search]

Expand
表52.1 位置引数
概要

operations

時系列に適用する操作

search

リソースをフィルターするクエリー。構文は、属性、演算子、および値の組み合わせです。たとえば、id=90d58eea-70d7-4294-a49a-170dcdf44c3c は特定の ID でリソースをフィルターします。より複雑なクエリーを構築することができます(例:not (flavor_id!="1" and memory>=24))。"" を使用して、データを文字列として解釈するように強制します。サポートされる演算子は not、and、∧、or、∨、>=、⇐、!=、>、<、=、==、eq、ne、lt、gt、ge、le、in、like、≠、≥、≤、like、in です。

Expand
表52.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-type RESOURCE_TYPE

問い合わせるリソースタイプ

--start START

期間の開始

--stop STOP

期間の終了

--granularity GRANULARITY

取得する際の詳細度

--needed-overlap NEEDED_OVERLAP

データポイント間での重複の割合

--groupby GROUPBY

リソースをグループ化するために使用する属性

--fill FILL

シリーズのサブセットに値がない状態でタイムスタンプをバックフィルする際に使用する値。値は浮動小数点または null である必要があります。

Expand
表52.3 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表52.4 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表52.5 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.6 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.2. metric archive-policy create

アーカイブポリシーを作成します。

使用方法

openstack metric archive-policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty] -d
                                              <DEFINITION> [-b BACK_WINDOW]
                                              [-m AGGREGATION_METHODS]
                                              name

Expand
表52.7 位置引数
概要

name

アーカイブポリシーの名前

Expand
表52.8 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

-D <DEFINITION>、--definition <DEFINITION>

名前と値を:で区切った、アーカイブポリシー定義の (,で区切られた)2 つの属性

-b BACK_WINDOW, --back-window BACK_WINDOW

アーカイブポリシーのバックウィンドウ

-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS

アーカイブポリシーの集約メソッド

Expand
表52.9 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.10 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.11 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.12 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.3. metric archive-policy delete

アーカイブポリシーを削除します。

使用方法

openstack metric archive-policy delete [-h] name

Expand
表52.13 位置引数
概要

name

アーカイブポリシーの名前

Expand
表52.14 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

52.4. metric archive-policy list

アーカイブポリシーを一覧表示します。

使用方法

openstack metric archive-policy 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]

Expand
表52.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表52.16 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表52.17 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表52.18 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.19 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.5. metric archive-policy-rule create

アーカイブポリシールールを作成します。

使用方法

openstack metric archive-policy-rule create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty] -a
                                                   ARCHIVE_POLICY_NAME -m
                                                   METRIC_PATTERN
                                                   name

Expand
表52.20 位置引数
概要

name

ルール名

Expand
表52.21 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME

アーカイブポリシー名

-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN

照合するメトリクス名のワイルドカード

Expand
表52.22 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.23 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.24 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.25 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.6. metric archive-policy-rule delete

アーカイブポリシールールを削除します。

使用方法

openstack metric archive-policy-rule delete [-h] name

Expand
表52.26 位置引数
概要

name

アーカイブポリシールールの名前

Expand
表52.27 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

52.7. metric archive-policy-rule list

アーカイブポリシールールを一覧表示します。

使用方法

openstack metric archive-policy-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]

Expand
表52.28 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表52.29 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表52.30 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表52.31 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.32 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.8. metric archive-policy-rule show

アーカイブポリシールールを表示します。

使用方法

openstack metric archive-policy-rule show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 name

Expand
表52.33 位置引数
概要

name

アーカイブポリシールールの名前

Expand
表52.34 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表52.35 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.36 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.37 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.38 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.9. metric archive-policy show

アーカイブポリシーを表示します。

使用方法

openstack metric archive-policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            name

Expand
表52.39 位置引数
概要

name

アーカイブポリシーの名前

Expand
表52.40 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表52.41 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.42 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.43 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.44 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.10. metric archive-policy update

アーカイブポリシーを更新します。

使用方法

openstack metric archive-policy update [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty] -d
                                              <DEFINITION>
                                              name

Expand
表52.45 位置引数
概要

name

アーカイブポリシーの名前

Expand
表52.46 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

-D <DEFINITION>、--definition <DEFINITION>

名前と値を:で区切った、アーカイブポリシー定義の (,で区切られた)2 つの属性

Expand
表52.47 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.48 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.49 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.50 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.11. metric benchmark measures add

測定の追加のベンチマークテストを行います。

使用方法

openstack metric benchmark measures add [-h]
                                               [--resource-id RESOURCE_ID]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--workers WORKERS] --count
                                               COUNT [--batch BATCH]
                                               [--timestamp-start TIMESTAMP_START]
                                               [--timestamp-end TIMESTAMP_END]
                                               [--wait]
                                               metric

Expand
表52.51 位置引数
概要

metric

メトリクスの ID または名前

Expand
表52.52 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--workers WORKERS, -w WORKERS

使用するワーカー数

--count COUNT, -n COUNT

送信する合計計測値の数

--batch BATCH, -b BATCH

各バッチで送信する計測値の数

--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START

使用する最初のタイムスタンプ

--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END

使用する最終タイムスタンプ

--wait

全計測が処理されるのを待ちます。

Expand
表52.53 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.54 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.55 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.56 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.12. metric benchmark measures show

measurements show のベンチマークテストを行います。

使用方法

openstack metric benchmark measures show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                [--utc]
                                                [--resource-id RESOURCE_ID]
                                                [--aggregation AGGREGATION]
                                                [--start START] [--stop STOP]
                                                [--granularity GRANULARITY]
                                                [--refresh]
                                                [--resample RESAMPLE]
                                                [--workers WORKERS] --count
                                                COUNT
                                                metric

Expand
表52.57 位置引数
概要

metric

メトリクスの ID または名前

Expand
表52.58 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--utc

タイムスタンプを utc として返します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--aggregation AGGREGATION

取得する集約

--start START

期間の開始

--stop STOP

期間の終了

--granularity GRANULARITY

取得する際の詳細度

--refresh

すべての既知の計測値を強制的に集計します。

--resample RESMYBACKUPDIRLE

時系列を再サンプリングする粒度(秒単位)

--workers WORKERS, -w WORKERS

使用するワーカー数

--count COUNT, -n COUNT

送信する合計計測値の数

Expand
表52.59 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表52.60 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.61 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.62 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.13. metric benchmark metric create

メトリクス作成のベンチマークテストを行います。

使用方法

openstack metric benchmark metric create [-h]
                                                [--resource-id RESOURCE_ID]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--archive-policy-name ARCHIVE_POLICY_NAME]
                                                [--workers WORKERS] --count
                                                COUNT [--keep]

Expand
表52.63 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

アーカイブポリシーの名前

--workers WORKERS, -w WORKERS

使用するワーカー数

--count COUNT, -n COUNT

作成するメトリクスの数

--keep, -k

作成されたメトリクスを保持します。

Expand
表52.64 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.65 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.66 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.67 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.14. metric benchmark metric show

metric show のベンチマークテストを行います。

使用方法

openstack metric benchmark metric show [-h] [--resource-id RESOURCE_ID]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--workers WORKERS] --count
                                              COUNT
                                              metric [metric ...]

Expand
表52.68 位置引数
概要

metric

メトリクス ID または名前

Expand
表52.69 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--workers WORKERS, -w WORKERS

使用するワーカー数

--count COUNT, -n COUNT

取得するメトリクスの数

Expand
表52.70 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.71 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.72 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.73 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.15. metric capabilities list

機能を一覧表示します。

使用方法

openstack metric capabilities list [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]

Expand
表52.74 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表52.75 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.76 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.77 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.78 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.16. metric create

メトリクスを作成します。

使用方法

openstack metric create [-h] [--resource-id RESOURCE_ID]
                               [-f {json,shell,table,value,yaml}] [-c COLUMN]
                               [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               [--archive-policy-name ARCHIVE_POLICY_NAME]
                               [--unit UNIT]
                               [METRIC_NAME]

Expand
表52.79 位置引数
概要

METRIC_NAME

メトリクスの名前

Expand
表52.80 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

アーカイブポリシーの名前

--unit UNIT, -u UNIT

メトリクスの単位

Expand
表52.81 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.82 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.83 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.84 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.17. metric delete

メトリクスを削除します。

使用方法

openstack metric delete [-h] [--resource-id RESOURCE_ID]
                               metric [metric ...]

Expand
表52.85 位置引数
概要

metric

メトリクスの ID または名前

Expand
表52.86 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

52.18. metric list

メトリクスを一覧表示します。

使用方法

openstack metric 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 <MARKER>] [--sort <SORT>]

Expand
表52.87 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <LIMIT>

返すメトリクスの数(デフォルトはサーバーのデフォルトです)

--marker <MARKER>

前の一覧の最後のアイテム。この値の後に来る結果を返します。

--sort <SORT>

メトリクス属性のソート(例:user_id:desc- nullslast)

Expand
表52.88 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表52.89 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表52.90 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.91 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.19. metric measures add

計測値をメトリクスに追加します。

使用方法

openstack metric measures add [-h] [--resource-id RESOURCE_ID] -m
                                     MEASURE
                                     metric

Expand
表52.92 位置引数
概要

metric

メトリクスの ID または名前

Expand
表52.93 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

-m MEASURE、--measure MEASURE

@で区切った計測のタイムスタンプおよび値

52.20. metric measures aggregation

集約されたメトリクスの計測値を取得します。

使用方法

openstack metric measures aggregation [-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]
                                             [--utc] -m METRIC [METRIC ...]
                                             [--aggregation AGGREGATION]
                                             [--reaggregation REAGGREGATION]
                                             [--start START] [--stop STOP]
                                             [--granularity GRANULARITY]
                                             [--needed-overlap NEEDED_OVERLAP]
                                             [--query QUERY]
                                             [--resource-type RESOURCE_TYPE]
                                             [--groupby GROUPBY] [--refresh]
                                             [--resample RESAMPLE]
                                             [--fill FILL]

Expand
表52.94 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--utc

タイムスタンプを utc として返します。

-m METRIC [METRIC …​], --metric METRIC [METRIC …​]

メトリクス ID またはメトリクス名

--aggregation AGGREGATION

取得する粒度集約機能

--reaggregation REAGGREGATION

取得する groupBy 集約機能

--start START

期間の開始

--stop STOP

期間の終了

--granularity GRANULARITY

取得する際の詳細度

--needed-overlap NEEDED_OVERLAP

要求される各メトリクスのデータポイントの割合(パーセント)

--query QUERY

リソースをフィルターするクエリー。構文は、属性、演算子、および値の組み合わせです。たとえば、id=90d58eea-70d7-4294-a49a-170dcdf44c3c は特定の ID でリソースをフィルターします。より複雑なクエリーを構築することができます(例:not (flavor_id!="1" and memory>=24))。"" を使用して、データを文字列として解釈するように強制します。サポートされる演算子は not、and、∧、or、∨、>=、⇐、!=、>、<、=、==、eq、ne、lt、gt、ge、le、in、like、≠、≥、≤、like、in です。

--resource-type RESOURCE_TYPE

問い合わせるリソースタイプ

--groupby GROUPBY

リソースをグループ化するために使用する属性

--refresh

すべての既知の計測値を強制的に集計します。

--resample RESMYBACKUPDIRLE

時系列を再サンプリングする粒度(秒単位)

--fill FILL

シリーズのサブセットに値がない状態でタイムスタンプをバックフィルする際に使用する値。値は浮動小数点または null である必要があります。

Expand
表52.95 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表52.96 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表52.97 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.98 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.21. metric measures batch-metrics

使用方法

openstack metric measures batch-metrics [-h] file

Expand
表52.99 位置引数
概要

file

バッチ処理またはstdinの測定値が含まれるファイル(形式は Gnocchi REST API のドキュメントを参照してください)。

Expand
表52.100 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

52.22. metric measures batch-resources-metrics

使用方法

openstack metric measures batch-resources-metrics [-h]
                                                         [--create-metrics]
                                                         file

Expand
表52.101 位置引数
概要

file

バッチ処理またはstdinの測定値が含まれるファイル(形式は Gnocchi REST API のドキュメントを参照してください)。

Expand
表52.102 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--create-metrics

不明なメトリクスを作成します。

52.23. metric measures show

メトリクスの測定値を取得します。

使用方法

openstack metric measures 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] [--utc]
                                      [--resource-id RESOURCE_ID]
                                      [--aggregation AGGREGATION]
                                      [--start START] [--stop STOP]
                                      [--granularity GRANULARITY] [--refresh]
                                      [--resample RESAMPLE]
                                      metric

Expand
表52.103 位置引数
概要

metric

メトリクスの ID または名前

Expand
表52.104 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--utc

タイムスタンプを utc として返します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--aggregation AGGREGATION

取得する集約

--start START

期間の開始

--stop STOP

期間の終了

--granularity GRANULARITY

取得する際の詳細度

--refresh

すべての既知の計測値を強制的に集計します。

--resample RESMYBACKUPDIRLE

時系列を再サンプリングする粒度(秒単位)

Expand
表52.105 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表52.106 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表52.107 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.108 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.24. metric metric create

非推奨:メトリクスを作成します。

使用方法

openstack metric metric create [-h] [--resource-id RESOURCE_ID]
                                      [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--archive-policy-name ARCHIVE_POLICY_NAME]
                                      [--unit UNIT]
                                      [METRIC_NAME]

Expand
表52.109 位置引数
概要

METRIC_NAME

メトリクスの名前

Expand
表52.110 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

アーカイブポリシーの名前

--unit UNIT, -u UNIT

メトリクスの単位

Expand
表52.111 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.112 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.113 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.114 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.25. metric metric delete

非推奨:メトリクスを削除します。

使用方法

openstack metric metric delete [-h] [--resource-id RESOURCE_ID]
                                      metric [metric ...]

Expand
表52.115 位置引数
概要

metric

メトリクスの ID または名前

Expand
表52.116 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

52.26. metric metric list

非推奨:メトリクスを一覧表示します。

使用方法

openstack metric metric 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 <MARKER>]
                                    [--sort <SORT>]

Expand
表52.117 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <LIMIT>

返すメトリクスの数(デフォルトはサーバーのデフォルトです)

--marker <MARKER>

前の一覧の最後のアイテム。この値の後に来る結果を返します。

--sort <SORT>

メトリクス属性のソート(例:user_id:desc- nullslast)

Expand
表52.118 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表52.119 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表52.120 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.121 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.27. metric metric show

非推奨:メトリクスを表示します。

使用方法

openstack metric metric show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    [--resource-id RESOURCE_ID]
                                    metric

Expand
表52.122 位置引数
概要

metric

メトリクスの ID または名前

Expand
表52.123 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

Expand
表52.124 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.125 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.126 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.127 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.28. metric resource batch delete

属性値に基づいてリソースのバッチを削除します。

使用方法

openstack metric resource batch delete [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--type RESOURCE_TYPE]
                                              query

Expand
表52.128 位置引数
概要

query

リソースをフィルターするクエリー。構文は、属性、演算子、および値の組み合わせです。たとえば、id=90d58eea-70d7-4294-a49a-170dcdf44c3c は特定の ID でリソースをフィルターします。より複雑なクエリーを構築することができます(例:not (flavor_id!="1" and memory>=24))。"" を使用して、データを文字列として解釈するように強制します。サポートされる演算子は not、and、∧、or、∨、>=、⇐、!=、>、<、=、==、eq、ne、lt、gt、ge、le、in、like、≠、≥、≤、like、in です。

Expand
表52.129 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

Expand
表52.130 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.131 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.132 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.133 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.29. metric resource create

リソースを作成します。

使用方法

openstack metric resource create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--type RESOURCE_TYPE]
                                        [-a ATTRIBUTE] [-m ADD_METRIC]
                                        [-n CREATE_METRIC]
                                        resource_id

Expand
表52.134 位置引数
概要

resource_id

リソースの ID

Expand
表52.135 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

-a MYBACKUPDIR、--attribute MYBACKUPDIR

:で区切った属性の名前および値

-m ADD_METRIC, --add-metric ADD_METRIC

追加するメトリクスのName:id

-n CREATE_METRIC, --create-metric CREATE_METRIC

作成するメトリックの Name:archive_policy_name

Expand
表52.136 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.137 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.138 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.139 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.30. metric resource delete

リソースを削除します。

使用方法

openstack metric resource delete [-h] resource_id

Expand
表52.140 位置引数
概要

resource_id

リソースの ID

Expand
表52.141 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

52.31. metric resource history

リソースの履歴を表示します。

使用方法

openstack metric resource history [-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]
                                         [--details] [--limit <LIMIT>]
                                         [--marker <MARKER>] [--sort <SORT>]
                                         [--type RESOURCE_TYPE]
                                         resource_id

Expand
表52.142 位置引数
概要

resource_id

リソースの ID

Expand
表52.143 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--details

汎用リソースの属性をすべて表示します。

--limit <LIMIT>

返すリソースの数(デフォルトはサーバーのデフォルトです)。

--marker <MARKER>

前の一覧の最後のアイテム。この値の後に来る結果を返します。

--sort <SORT>

リソース属性のソート(例:user_id:desc- nullslast)

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

Expand
表52.144 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表52.145 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表52.146 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.147 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.32. metric resource list

リソースを一覧表示します。

使用方法

openstack metric resource 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] [--details]
                                      [--history] [--limit <LIMIT>]
                                      [--marker <MARKER>] [--sort <SORT>]
                                      [--type RESOURCE_TYPE]

Expand
表52.148 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--details

汎用リソースの属性をすべて表示します。

--history

リソースの履歴を表示します。

--limit <LIMIT>

返すリソースの数(デフォルトはサーバーのデフォルトです)。

--marker <MARKER>

前の一覧の最後のアイテム。この値の後に来る結果を返します。

--sort <SORT>

リソース属性のソート(例:user_id:desc- nullslast)

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

Expand
表52.149 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表52.150 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表52.151 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.152 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.34. metric resource show

リソースを表示します。

使用方法

openstack metric resource show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--type RESOURCE_TYPE]
                                      resource_id

Expand
表52.159 位置引数
概要

resource_id

リソースの ID

Expand
表52.160 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

Expand
表52.161 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.162 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.163 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.164 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.35. metric resource-type create

リソース種別を作成します。

使用方法

openstack metric resource-type create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [-a ATTRIBUTE]
                                             name

Expand
表52.165 位置引数
概要

name

リソース種別の名前

Expand
表52.166 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

-a MYBACKUPDIR、--attribute MYBACKUPDIR

属性定義、attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:…​ 例: display_name:string:true:max_length=255

Expand
表52.167 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.168 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.169 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.170 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.36. metric resource-type delete

リソース種別を削除します。

使用方法

openstack metric resource-type delete [-h] name

Expand
表52.171 位置引数
概要

name

リソース種別の名前

Expand
表52.172 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

52.37. metric resource-type list

リソース種別を一覧表示します。

使用方法

openstack metric resource-type 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]

Expand
表52.173 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表52.174 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表52.175 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表52.176 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.177 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.38. metric resource-type show

リソース種別を表示します。

使用方法

openstack metric resource-type show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           name

Expand
表52.178 位置引数
概要

name

リソース種別の名前

Expand
表52.179 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表52.180 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.181 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.182 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.183 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.39. metric resource-type update

リソース種別を作成します。

使用方法

openstack metric resource-type update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [-a ATTRIBUTE]
                                             [-r REMOVE_ATTRIBUTE]
                                             name

Expand
表52.184 位置引数
概要

name

リソース種別の名前

Expand
表52.185 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

-a MYBACKUPDIR、--attribute MYBACKUPDIR

属性定義、attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:…​ 例: display_name:string:true:max_length=255

-r REMOVE_ATTRIBUTE, --remove-attribute REMOVE_ATTRIBUTE

属性名

Expand
表52.186 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.187 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.188 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.189 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.40. metric resource update

リソースを更新します。

使用方法

openstack metric resource update [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--type RESOURCE_TYPE]
                                        [-a ATTRIBUTE] [-m ADD_METRIC]
                                        [-n CREATE_METRIC] [-d DELETE_METRIC]
                                        resource_id

Expand
表52.190 位置引数
概要

resource_id

リソースの ID

Expand
表52.191 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

-a MYBACKUPDIR、--attribute MYBACKUPDIR

:で区切った属性の名前および値

-m ADD_METRIC, --add-metric ADD_METRIC

追加するメトリクスのName:id

-n CREATE_METRIC, --create-metric CREATE_METRIC

作成するメトリックの Name:archive_policy_name

-d DELETE_METRIC, --delete-metric DELETE_METRIC

削除するメトリクスの名前

Expand
表52.192 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.193 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.194 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.195 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.41. metric server version

Gnocchi サーバーのバージョンを表示します。

使用方法

openstack metric server version [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]

Expand
表52.196 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表52.197 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.198 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.199 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.200 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.42. metric show

メトリクスを表示します。

使用方法

openstack metric show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--resource-id RESOURCE_ID]
                             metric

Expand
表52.201 位置引数
概要

metric

メトリクスの ID または名前

Expand
表52.202 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

Expand
表52.203 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.204 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.205 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.206 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.43. metric status

測定値処理のステータスを表示します。

使用方法

openstack metric status [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]

Expand
表52.207 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表52.208 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表52.209 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表52.210 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表52.211 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第53章 module

本章では、module コマンドに含まれるコマンドについて説明します。

53.1. module list

モジュールのバージョンを一覧表示します。

使用方法

openstack module list [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--all]

Expand
表53.1 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--all

バージョン情報を持つモジュールをすべて表示します。

Expand
表53.2 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表53.3 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表53.4 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表53.5 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第54章 network

本章では、network コマンドに含まれるコマンドについて説明します。

54.1. network agent add network

エージェントにネットワークを追加します。

使用方法

openstack network agent add network [-h] [--dhcp] <agent-id> <network>

Expand
表54.1 位置引数
概要

<agent-id>

ネットワークが追加されるエージェント(id のみ)

<network>

エージェントに追加されるネットワーク(名前または ID)

Expand
表54.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--dhcp

dhcp エージェントにネットワークを追加します。

54.2. network agent add router

エージェントにルーターを追加します。

使用方法

openstack network agent add router [-h] [--l3] <agent-id> <router>

Expand
表54.3 位置引数
概要

<agent-id>

ルーターが追加されるエージェント(id のみ)

<router>

エージェントに追加されるルーター(名前または ID)

Expand
表54.4 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--l3

ルーターを l3 エージェントに追加します。

54.3. network agent delete

ネットワークエージェントを削除します。

使用方法

openstack network agent delete [-h]
                                      <network-agent> [<network-agent> ...]

Expand
表54.5 位置引数
概要

<network-agent>

削除するネットワークエージェント(id のみ)

Expand
表54.6 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

54.4. network agent list

ネットワークエージェントの一覧を表示します。

使用方法

openstack network agent 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]
                                    [--agent-type <agent-type>]
                                    [--host <host>]
                                    [--network <network> | --router <router>]
                                    [--long]

Expand
表54.7 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--agent-type <agent-type>

指定したエージェントタイプのエージェントのみを一覧表示します。サポートされるエージェントタイプは、bgp、dhcp、open-vswitch、linux-bridge、ofa、l3、loadbalancer、metering、metadata、macvtap、nic です。

--host <host>

指定されたホストで実行されているエージェントのみを一覧表示します。

--network <network>

ネットワークをホストするエージェント(名前または ID)を一覧表示します。

--router <router>

このルーターをホストするエージェントを一覧表示します(名前または ID)。

--long

出力の追加フィールドを一覧表示します。

Expand
表54.8 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表54.9 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表54.10 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.11 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.5. network agent remove network

エージェントからネットワークを削除します。

使用方法

openstack network agent remove network [-h] [--dhcp]
                                              <agent-id> <network>

Expand
表54.12 位置引数
概要

<agent-id>

ネットワークを削除するエージェント(id のみ)

<network>

エージェントから削除されるネットワーク(名前または ID)

Expand
表54.13 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--dhcp

dhcp エージェントからネットワークを削除します。

54.6. network agent remove router

エージェントからルーターを削除します。

使用方法

openstack network agent remove router [-h] [--l3] <agent-id> <router>

Expand
表54.14 位置引数
概要

<agent-id>

ルーターを削除するエージェント(id のみ)

<router>

エージェントから削除されるルーター(名前または ID)

Expand
表54.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--l3

l3 エージェントからルーターを削除します。

54.7. network agent set

ネットワークエージェントの属性を設定します。

使用方法

openstack network agent set [-h] [--description <description>]
                                   [--enable | --disable]
                                   <network-agent>

Expand
表54.16 位置引数
概要

<network-agent>

変更するネットワークエージェント(id のみ)

Expand
表54.17 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ネットワークエージェントの説明を設定します。

--enable

ネットワークエージェントを有効にします。

--disable

ネットワークエージェントを無効にします。

54.8. network agent show

ネットワークエージェントの詳細を表示します。

使用方法

openstack network agent show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <network-agent>

Expand
表54.18 位置引数
概要

<network-agent>

表示するネットワークエージェント(id のみ)

Expand
表54.19 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.20 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.21 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.22 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.23 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.9. network auto allocated topology create

プロジェクトの自動割り当てトポロジーを作成します。

使用方法

openstack network auto allocated topology create [-h]
                                                        [-f {json,shell,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--noindent]
                                                        [--prefix PREFIX]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]
                                                        [--check-resources]
                                                        [--or-show]

Expand
表54.24 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

指定されたプロジェクトに対して自動的に割り当てられたトポロジーを返します。デフォルトは現在のプロジェクトです。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--check-resources

自動割り当てトポロジーの要件を検証します。トポロジーを返しません。

--or-show

トポロジーが存在する場合は、トポロジーの情報を返します(デフォルト)。

Expand
表54.25 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.26 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.27 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.28 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.10. network auto allocated topology delete

プロジェクトの自動割り当てトポロジーを削除します。

使用方法

openstack network auto allocated topology delete [-h]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]

Expand
表54.29 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

特定のプロジェクトに対して自動的に割り当てられたトポロジーを削除します。デフォルトは現在のプロジェクトです。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

54.11. network create

新規ネットワークを作成します。

使用方法

openstack network create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--share | --no-share]
                                [--enable | --disable] [--project <project>]
                                [--description <description>] [--mtu <mtu>]
                                [--project-domain <project-domain>]
                                [--availability-zone-hint <availability-zone>]
                                [--enable-port-security | --disable-port-security]
                                [--external | --internal]
                                [--default | --no-default]
                                [--qos-policy <qos-policy>]
                                [--transparent-vlan | --no-transparent-vlan]
                                [--provider-network-type <provider-network-type>]
                                [--provider-physical-network <provider-physical-network>]
                                [--provider-segment <provider-segment>]
                                [--dns-domain <dns-domain>]
                                [--tag <tag> | --no-tag]
                                <name>

Expand
表54.30 位置引数
概要

<name>

新しいネットワーク名

Expand
表54.31 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--share

プロジェクト間でネットワークを共有します。

--no-share

プロジェクト間でネットワークを共有しません。

--enable

ネットワークを有効にします(デフォルト)。

--disable

ネットワークを無効にします。

--project <project>

所有者のプロジェクト(名前または ID)

--description <description>

ネットワークの説明を設定します。

--mtu <mtu>

ネットワークのmtuを設定します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--availability-zone-hint <availability-zone>

このネットワークを作成するアベイラビリティーゾーン(Network Availability Zone 拡張機能が必要、複数のアベイラビリティーゾーンに設定するにはオプションを繰り返します)

--enable-port-security

このネットワークで作成されたポートで、デフォルトでポートセキュリティーを有効にします(デフォルト)。

--disable-port-security

このネットワークで作成されたポートで、デフォルトでポートセキュリティーを無効にします。

--external

このネットワークを外部ネットワークとして設定します(external-net 拡張機能が必要)

--internal

このネットワークを内部ネットワークとして設定します(デフォルト)。

--default

このネットワークをデフォルトの外部ネットワークとして使用するかどうかを指定します。

--no-default

ネットワークをデフォルトの外部ネットワークとして使用しません(デフォルト)。

--qos-policy <qos-policy>

このネットワークにアタッチする QoS ポリシー(名前または ID)

--transparent-vlan

ネットワーク vlan を透過的にします。

--no-transparent-vlan

ネットワーク vlan を透過的にしません。

--provider-network-type <provider-network-type>

仮想ネットワークが実装される物理メカニズム。例:flat、geneve、gre、local、vlan、vxlan

--provider-physical-network <provider-physical-network>

仮想ネットワークが実装される物理ネットワークの名前

--provider-segment <provider-segment>

vlan ネットワークの VLAN id、または GENEVE/GRE/VXLAN ネットワークのトンネル ID

--dns-domain <dns-domain>

このネットワークに dns ドメインを設定します(dns 統合拡張が必要です)。

--tag <tag>

ネットワークに追加するタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

ネットワークにタグを関連付けません。

Expand
表54.32 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.33 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.34 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.35 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.12. network delete

ネットワークを削除します。

使用方法

openstack network delete [-h] <network> [<network> ...]

Expand
表54.36 位置引数
概要

<network>

削除するネットワーク(名前または ID)

Expand
表54.37 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

54.13. network flavor add profile

サービスプロファイルをネットワークフレーバーに追加します。

使用方法

openstack network flavor add profile [-h] <flavor> <service-profile>

Expand
表54.38 位置引数
概要

<flavor>

ネットワークフレーバー(名前または ID)

<service-profile>

サービスプロファイル(id のみ)

Expand
表54.39 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

54.14. network flavor create

新規ネットワークフレーバーを作成します。

使用方法

openstack network flavor create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] --service-type
                                       <service-type>
                                       [--description DESCRIPTION]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       [--enable | --disable]
                                       <name>

Expand
表54.40 位置引数
概要

<name>

フレーバーの名前

Expand
表54.41 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--service-type <service-type>

フレーバーを適用するサービス種別 (例:vpn)。ロードされた例は openstack network service provider list を参照してください。

--description DESCRIPTION

フレーバーの説明

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--enable

フレーバーを有効にします(デフォルト)。

--disable

フレーバーを無効にします。

Expand
表54.42 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.43 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.44 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.45 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.15. network flavor delete

ネットワークフレーバーを削除します。

使用方法

openstack network flavor delete [-h] <flavor> [<flavor> ...]

Expand
表54.46 位置引数
概要

<flavor>

削除するフレーバー(名前または ID)

Expand
表54.47 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

54.16. network flavor list

ネットワークフレーバーを一覧表示します。

使用方法

openstack network flavor 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]

Expand
表54.48 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.49 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表54.50 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表54.51 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.52 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.17. network flavor profile create

新規ネットワークフレーバープロファイルを作成します。

使用方法

openstack network flavor profile create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--project <project>]
                                               [--project-domain <project-domain>]
                                               [--description <description>]
                                               [--enable | --disable]
                                               [--driver DRIVER]
                                               [--metainfo METAINFO]

Expand
表54.53 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--description <description>

フレーバープロファイルの説明

--enable

フレーバープロファイルを有効にします。

--disable

フレーバープロファイルを無効にします。

--driver DRIVER

ドライバーへの Python モジュールパス。これは、--metainfo がない場合は必須です (逆の場合も同様)。

--metainfo METAINFO

フレーバープロファイルの metainfo。これは、--driver がない場合は必須です (逆の場合も同様)。

Expand
表54.54 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.55 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.56 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.57 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.18. network flavor profile delete

ネットワークフレーバープロファイルを削除します。

使用方法

openstack network flavor profile delete [-h]
                                               <flavor-profile>
                                               [<flavor-profile> ...]

Expand
表54.58 位置引数
概要

<flavor-profile>

削除するフレーバープロファイル(id のみ)

Expand
表54.59 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

54.19. network flavor profile list

ネットワークフレーバープロファイルを一覧表示します。

使用方法

openstack network flavor profile 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]

Expand
表54.60 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.61 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表54.62 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表54.63 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.64 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.20. network flavor profile set

ネットワークフレーバープロファイル属性を設定します。

使用方法

openstack network flavor profile set [-h]
                                            [--project-domain <project-domain>]
                                            [--description <description>]
                                            [--enable | --disable]
                                            [--driver DRIVER]
                                            [--metainfo METAINFO]
                                            <flavor-profile>

Expand
表54.65 位置引数
概要

<flavor-profile>

更新するフレーバープロファイル(id のみ)

Expand
表54.66 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--description <description>

フレーバープロファイルの説明

--enable

フレーバープロファイルを有効にします。

--disable

フレーバープロファイルを無効にします。

--driver DRIVER

ドライバーへの Python モジュールパス。これは、--metainfo がない場合は必須です (逆の場合も同様)。

--metainfo METAINFO

フレーバープロファイルの metainfo。これは、--driver がない場合は必須です (逆の場合も同様)。

54.21. network flavor profile show

ネットワークフレーバープロファイルの詳細を表示します。

使用方法

openstack network flavor profile show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <flavor-profile>

Expand
表54.67 位置引数
概要

<flavor-profile>

表示するフレーバープロファイル(id のみ)

Expand
表54.68 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.69 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.70 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.71 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.72 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.22. network flavor remove profile

ネットワークフレーバーからサービスプロファイルを削除します。

使用方法

openstack network flavor remove profile [-h] <flavor> <service-profile>

Expand
表54.73 位置引数
概要

<flavor>

ネットワークフレーバー(名前または ID)

<service-profile>

サービスプロファイル(id のみ)

Expand
表54.74 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

54.23. network flavor set

ネットワークフレーバー属性を設定します。

使用方法

openstack network flavor set [-h] [--description DESCRIPTION]
                                    [--disable | --enable] [--name <name>]
                                    <flavor>

Expand
表54.75 位置引数
概要

<flavor>

更新するフレーバー(名前または ID)

Expand
表54.76 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--description DESCRIPTION

ネットワークフレーバーの説明を設定します。

--disable

ネットワークフレーバーを無効にします。

--enable

ネットワークフレーバーを有効にします。

--name <name>

フレーバー名を設定します。

54.24. network flavor show

ネットワークフレーバーの詳細を表示します。

使用方法

openstack network flavor show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <flavor>

Expand
表54.77 位置引数
概要

<flavor>

表示するフレーバー(名前または ID)

Expand
表54.78 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.79 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.80 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.81 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.82 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.25. network list

ネットワークを一覧表示します。

使用方法

openstack network 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]
                              [--external | --internal] [--long]
                              [--name <name>] [--enable | --disable]
                              [--project <project>]
                              [--project-domain <project-domain>]
                              [--share | --no-share] [--status <status>]
                              [--provider-network-type <provider-network-type>]
                              [--provider-physical-network <provider-physical-network>]
                              [--provider-segment <provider-segment>]
                              [--agent <agent-id>] [--tags <tag>[,<tag>,...]]
                              [--any-tags <tag>[,<tag>,...]]
                              [--not-tags <tag>[,<tag>,...]]
                              [--not-any-tags <tag>[,<tag>,...]]

Expand
表54.83 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--external

外部ネットワークを一覧表示します。

--internal

内部ネットワークを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--name <name>

名前に従ってネットワークを一覧表示します。

--enable

有効なネットワークの一覧を表示します。

--disable

無効なネットワークの一覧を表示します。

--project <project>

プロジェクトに従ってネットワークを一覧表示します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--share

プロジェクト間で共有されるネットワークを一覧表示します。

--no-share

プロジェクト間で共有されていないネットワークの一覧を表示します。

--status <status>

ステータス(activeBUILDDOWNERROR)に従ってネットワークを一覧表示します。

--provider-network-type <provider-network-type>

物理メカニズムに従ってネットワークを一覧表示します。サポートされているオプションは flat、geneve、gre、local、vlan、vxlan です。

--provider-physical-network <provider-physical-network>

物理ネットワークの名前に従ってネットワークを一覧表示します。

--provider-segment <provider-segment>

vlan ネットワークの vlan id か、GENEVE/GRE/VXLAN ネットワークの Tunnel ID に従ってネットワークを一覧表示します。

--agent <agent-id>

エージェントがホストするネットワークの一覧を表示します(id のみ)。

--tags <tag>[,<tag>,…​]

指定したすべてのタグ(タグのコンマ区切りリスト)が設定されたネットワークを一覧表示します。

--any-tags <tag>[,<tag>,…​]

指定したタグ(タグのコンマ区切りリスト)のいずれかが設定されたネットワークを一覧表示します。

--not-tags <tag>[,<tag>,…​]

指定したすべてのタグ(タグのコンマ区切りリスト)が設定されたネットワークを除外します。

--not-any-tags <tag>[,<tag>,…​]

指定したタグ(タグのコンマ区切りリスト)のいずれかが設定されたネットワークを除外します。

Expand
表54.84 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表54.85 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表54.86 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.87 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.26. network log create

新規ネットワークログを作成指定します。

使用方法

openstack network log create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    [--description <description>]
                                    [--enable | --disable]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--event <event>] --resource-type
                                    <resource-type> [--resource <resource>]
                                    [--target <target>]
                                    <name>

Expand
表54.88 位置引数
概要

<name>

ネットワークログの名前

Expand
表54.89 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ネットワークログの説明

--enable

このログを有効にします(デフォルトは無効)。

--disable

このログを無効にします。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--event <event>

ログと共に保存するイベント

--resource-type <resource-type>

ネットワークログのタイプ。サポートされる種別は、$ openstack network loggable resources list で確認することができます。

--resource <resource>

ロギングに使用されるリソース(セキュリティーグループまたはファイアウォールグループ)の名前または ID--target オプションを使用して、ロギングターゲットの組み合わせを制御できます。

--target <target>

ロギング用のポート(名前または ID)。ロギングターゲットの組み合わせは、--resource オプションで制御できます。

Expand
表54.90 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.91 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.92 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.93 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.27. network log delete

ネットワークログを削除します。

使用方法

openstack network log delete [-h] <network-log> [<network-log> ...]

Expand
表54.94 位置引数
概要

<network-log>

削除するネットワークログ(名前または ID)

Expand
表54.95 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

54.28. network log list

ネットワークログを一覧表示します。

使用方法

openstack network log 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]

Expand
表54.96 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

Expand
表54.97 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表54.98 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表54.99 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.100 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.29. network log set

ネットワークログの属性を設定します。

使用方法

openstack network log set [-h] [--description <description>]
                                 [--enable | --disable] [--name <name>]
                                 <network-log>

Expand
表54.101 位置引数
概要

<network-log>

設定するネットワークログ(名前または ID)

Expand
表54.102 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ネットワークログの説明

--enable

このログを有効にします(デフォルトは無効)。

--disable

このログを無効にします。

--name <name>

ネットワークログの名前

54.30. network log show

ネットワークログの詳細を表示します。

使用方法

openstack network log show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <network-log>

Expand
表54.103 位置引数
概要

<network-log>

表示するネットワークログ(名前または ID)

Expand
表54.104 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.105 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.106 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.107 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.108 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.31. network loggable resources list

サポートされるログ可能なリソースを一覧表示します。

使用方法

openstack network loggable resources 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]

Expand
表54.109 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

Expand
表54.110 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表54.111 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表54.112 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.113 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.32. network meter create

ネットワークメーターを作成します。

使用方法

openstack network meter create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--description <description>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--share | --no-share]
                                      <name>

Expand
表54.114 位置引数
概要

<name>

メーターの名前

Expand
表54.115 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

メーターの説明を作成します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--share

プロジェクト間でメーターを共有します。

--no-share

プロジェクト間でメーターを共有しません。

Expand
表54.116 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.117 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.118 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.119 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.33. network meter delete

ネットワークメーターを削除します。

使用方法

openstack network meter delete [-h] <meter> [<meter> ...]

Expand
表54.120 位置引数
概要

<meter>

削除するメーター(名前または ID)

Expand
表54.121 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

54.34. network meter list

ネットワークメーターを一覧表示します。

使用方法

openstack network meter 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]

Expand
表54.122 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.123 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表54.124 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表54.125 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.126 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.35. network meter rule create

新しいメータールールを作成します。

使用方法

openstack network meter rule create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--project <project>]
                                           [--project-domain <project-domain>]
                                           [--exclude | --include]
                                           [--ingress | --egress]
                                           --remote-ip-prefix
                                           <remote-ip-prefix>
                                           <meter>

Expand
表54.127 位置引数
概要

<meter>

このメータリングルールに関連付けるラベル(名前または ID)

Expand
表54.128 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--exclude

トラフィック数からリモート ip プレフィックスを除外します。

--include

トラフィック数にリモート ip プレフィックスを含めます(デフォルト)。

--ingress

受信ネットワークトラフィックにルールを適用します(デフォルト)。

--egress

発信ネットワークトラフィックにルールを適用します。

--remote-ip-prefix <remote-ip-prefix>

このルールに関連付けるリモート IP プレフィックス

Expand
表54.129 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.130 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.131 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.132 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.36. network meter rule delete

メータールールを削除します。

使用方法

openstack network meter rule delete [-h]
                                           <meter-rule-id>
                                           [<meter-rule-id> ...]

Expand
表54.133 位置引数
概要

<meter-rule-id>

削除するメータールール(id のみ)

Expand
表54.134 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

54.37. network meter rule list

メータールールを一覧表示します。

使用方法

openstack network meter 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]

Expand
表54.135 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.136 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表54.137 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表54.138 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.139 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.38. network meter rule show

メータールールの詳細を表示削除します。

使用方法

openstack network meter rule show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <meter-rule-id>

Expand
表54.140 位置引数
概要

<meter-rule-id>

メータールール(id のみ)

Expand
表54.141 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.142 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.143 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.144 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.145 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.39. network meter show

ネットワークメーターを表示します。

使用方法

openstack network meter show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <meter>

Expand
表54.146 位置引数
概要

<meter>

表示するメーター(名前または ID)

Expand
表54.147 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.148 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.149 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.150 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.151 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.40. network onboard subnets

サブネットプールにネットワークサブネットをオンボードします。

使用方法

openstack network onboard subnets [-h] <network> <subnetpool>

Expand
表54.152 位置引数
概要

<network>

このネットワークに関連付けられた全サブネットをオンボードします。

<subnetpool>

サブネットをオンボーディングするターゲットサブネットプール

Expand
表54.153 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

54.41. network qos policy create

QoS ポリシーを作成します。

使用方法

openstack network qos policy create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--description <description>]
                                           [--share | --no-share]
                                           [--project <project>]
                                           [--project-domain <project-domain>]
                                           [--default | --no-default]
                                           <name>

Expand
表54.154 位置引数
概要

<name>

作成する qos ポリシーの名前

Expand
表54.155 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

qos ポリシーの説明

--share

他のプロジェクトから qos ポリシーにアクセスできるようにします。

--no-share

他のプロジェクトから qos ポリシーにアクセスできないようにします(デフォルト)。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--default

これをデフォルトのネットワーク qos ポリシーとして設定します。

--no-default

これをデフォルト以外のネットワーク qos ポリシーとして設定します。

Expand
表54.156 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.157 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.158 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.159 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.42. network qos policy delete

Qos ポリシーを削除します。

使用方法

openstack network qos policy delete [-h]
                                           <qos-policy> [<qos-policy> ...]

Expand
表54.160 位置引数
概要

<qos-policy>

削除する QoS ポリシー(名前または ID)

Expand
表54.161 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

54.43. network qos policy list

QoS ポリシーを一覧表示します。

使用方法

openstack network qos policy 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]
                                         [--project <project>]
                                         [--project-domain <project-domain>]
                                         [--share | --no-share]

Expand
表54.162 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

プロジェクトに従ってqosポリシーを一覧表示します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--share

プロジェクト間で共有されるQoS ポリシーを一覧表示します。

--no-share

プロジェクト間で共有されない qos ポリシーを一覧表示します。

Expand
表54.163 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表54.164 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表54.165 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.166 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.44. network qos policy set

QoS ポリシー属性を設定します。

使用方法

openstack network qos policy set [-h] [--name <name>]
                                        [--description <description>]
                                        [--share | --no-share]
                                        [--default | --no-default]
                                        <qos-policy>

Expand
表54.167 位置引数
概要

<qos-policy>

変更する QoS ポリシー(名前または ID)

Expand
表54.168 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

qos ポリシー名を設定します。

--description <description>

qos ポリシーの説明

--share

他のプロジェクトから qos ポリシーにアクセスできるようにします。

--no-share

他のプロジェクトから qos ポリシーにアクセスできないようにします。

--default

これをデフォルトのネットワーク qos ポリシーとして設定します。

--no-default

これをデフォルト以外のネットワーク qos ポリシーとして設定します。

54.45. network qos policy show

QoS ポリシーの詳細を表示します。

使用方法

openstack network qos policy show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <qos-policy>

Expand
表54.169 位置引数
概要

<qos-policy>

表示する QoS ポリシー(名前または ID)

Expand
表54.170 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.171 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.172 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.173 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.174 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.46. network qos rule create

新規 Network QoS ルールを作成します。

使用方法

openstack network qos rule create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty] [--type <type>]
                                         [--max-kbps <max-kbps>]
                                         [--max-burst-kbits <max-burst-kbits>]
                                         [--dscp-mark <dscp-mark>]
                                         [--min-kbps <min-kbps>]
                                         [--ingress | --egress]
                                         <qos-policy>

Expand
表54.175 位置引数
概要

<qos-policy>

ルールが含まれる QoS ポリシー(名前または id)

Expand
表54.176 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--type <type>

QoS ルールタイプ(minimum-bandwidth、dscp-marking、bandwidth-limit)

--max-kbps <max-kbps>

最大帯域幅(kbps)

--max-burst-kbits <max-burst-kbits>

キロビット単位の最大バースト。0 または指定しない場合は帯域幅の制限の 80% で、通常の TCP トラフィックで機能します。詳細は、QoS ユーザーワークフローを確認します。

--dscp-mark <dscp-mark>

DSCP mark: 値 は 0、8 - 56 の偶数を指定できます(42、44、50、52、および 54 を除く)。

--min-kbps <min-kbps>

確保される最小帯域幅(kbps単位)

--ingress

プロジェクト視点からの受信トラフィックの方向

--egress

プロジェクト視点からの送信トラフィックの方向

Expand
表54.177 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.178 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.179 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.180 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.47. network qos rule delete

ネットワーク QoS ルールを削除します。

使用方法

openstack network qos rule delete [-h] <qos-policy> <rule-id>

Expand
表54.181 位置引数
概要

<qos-policy>

ルールが含まれる QoS ポリシー(名前または id)

<rule-id>

削除するネットワーク qos ルール(id)

Expand
表54.182 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

54.48. network qos rule list

ネットワーク QoS ルールを一覧表示します。

使用方法

openstack network qos 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]
                                       <qos-policy>

Expand
表54.183 位置引数
概要

<qos-policy>

ルールが含まれる QoS ポリシー(名前または id)

Expand
表54.184 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.185 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表54.186 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表54.187 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.188 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.49. network qos rule set

ネットワーク QoS ルール属性を設定します。

使用方法

openstack network qos rule set [-h] [--max-kbps <max-kbps>]
                                      [--max-burst-kbits <max-burst-kbits>]
                                      [--dscp-mark <dscp-mark>]
                                      [--min-kbps <min-kbps>]
                                      [--ingress | --egress]
                                      <qos-policy> <rule-id>

Expand
表54.189 位置引数
概要

<qos-policy>

ルールが含まれる QoS ポリシー(名前または id)

<rule-id>

削除するネットワーク qos ルール(id)

Expand
表54.190 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--max-kbps <max-kbps>

最大帯域幅(kbps)

--max-burst-kbits <max-burst-kbits>

キロビット単位の最大バースト。0 または指定しない場合は帯域幅の制限の 80% で、通常の TCP トラフィックで機能します。詳細は、QoS ユーザーワークフローを確認します。

--dscp-mark <dscp-mark>

DSCP mark: 値 は 0、8 - 56 の偶数を指定できます(42、44、50、52、および 54 を除く)。

--min-kbps <min-kbps>

確保される最小帯域幅(kbps単位)

--ingress

プロジェクト視点からの受信トラフィックの方向

--egress

プロジェクト視点からの送信トラフィックの方向

54.50. network qos rule show

ネットワーク QoS ルールの詳細を表示します。

使用方法

openstack network qos rule show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <qos-policy> <rule-id>

Expand
表54.191 位置引数
概要

<qos-policy>

ルールが含まれる QoS ポリシー(名前または id)

<rule-id>

削除するネットワーク qos ルール(id)

Expand
表54.192 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.193 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.194 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.195 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.196 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.51. network qos rule type list

QoS ルール種別の一覧を表示します。

使用方法

openstack network qos rule type 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]

Expand
表54.197 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.198 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表54.199 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表54.200 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.201 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.52. network qos rule type show

サポート対象の QoS ルール種別の詳細を表示します。

使用方法

openstack network qos rule type show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <qos-rule-type-name>

Expand
表54.202 位置引数
概要

<qos-rule-type-name>

qos ルール種別の名前

Expand
表54.203 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.204 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.205 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.206 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.207 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.53. network rbac create

ネットワーク RBAC ポリシーを作成します。

使用方法

openstack network rbac create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty] --type
                                     <type> --action <action>
                                     (--target-project <target-project> | --target-all-projects)
                                     [--target-project-domain <target-project-domain>]
                                     [--project <project>]
                                     [--project-domain <project-domain>]
                                     <rbac-object>

Expand
表54.208 位置引数
概要

<rbac-object>

この rbac ポリシーが影響を及ぼすオブジェクト(名前または ID)

Expand
表54.209 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--type <type>

rbac ポリシーが影響を与えるオブジェクトのタイプ("qos_policy" または "network")

--action <action>

rbac ポリシーの動作("access_as_external" または "access_as_shared")

--target-project <target-project>

rbac ポリシーを適用するプロジェクト(名前または ID)

--target-all-projects

すべてのプロジェクトの rbac ポリシーの作成を許可します。

--target-project-domain <target-project-domain>

ターゲットプロジェクトが属するドメイン(名前または id)プロジェクト名の競合が発生した場合に、使用できます。

--project <project>

所有者プロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表54.210 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.211 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.212 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.213 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.54. network rbac delete

ネットワーク RBAC ポリシーを削除します。

使用方法

openstack network rbac delete [-h] <rbac-policy> [<rbac-policy> ...]

Expand
表54.214 位置引数
概要

<rbac-policy>

削除する RBAC ポリシー(id のみ)

Expand
表54.215 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

54.55. network rbac list

ネットワーク RBAC ポリシーを一覧表示します。

使用方法

openstack network rbac 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>]
                                   [--action <action>] [--long]

Expand
表54.216 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--type <type>

指定したオブジェクトタイプ(「qos_policy」または「network」)に応じてネットワーク rbac ポリシーを一覧表示します。

--action <action>

指定されたアクション("access_as_external" または "access_as_shared")に従って、ネットワーク rbac ポリシーを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

Expand
表54.217 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表54.218 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表54.219 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.220 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.56. network rbac set

ネットワーク RBAC ポリシー属性を設定します。

使用方法

openstack network rbac set [-h] [--target-project <target-project>]
                                  [--target-project-domain <target-project-domain>]
                                  <rbac-policy>

Expand
表54.221 位置引数
概要

<rbac-policy>

変更する RBAC ポリシー(id のみ)

Expand
表54.222 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--target-project <target-project>

rbac ポリシーを適用するプロジェクト(名前または ID)

--target-project-domain <target-project-domain>

ターゲットプロジェクトが属するドメイン(名前または id)プロジェクト名の競合が発生した場合に、使用できます。

54.57. network rbac show

ネットワーク RBAC ポリシーの詳細を表示します。

使用方法

openstack network rbac show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <rbac-policy>

Expand
表54.223 位置引数
概要

<rbac-policy>

RBAC ポリシー(id のみ)

Expand
表54.224 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表54.225 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.226 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.227 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.228 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.58. network segment create

新規ネットワークセグメントを作成します。

使用方法

openstack network segment create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--description <description>]
                                        [--physical-network <physical-network>]
                                        [--segment <segment>] --network
                                        <network> --network-type
                                        <network-type>
                                        <name>

Expand
表54.229 位置引数
概要

<name>

新しいネットワークセグメント名

Expand
表54.230 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ネットワークセグメントの説明

--physical-network <physical-network>

このネットワークセグメントの物理ネットワーク名

--segment <segment>

このネットワークセグメントのセグメント識別子。ネットワーク種別、vlan ネットワーク種別の VLAN ID、ならびにgeneve、gre、および vxlan ネットワーク種別のトンネル IDに基づきます。

--network <network>

このネットワークセグメントが属するネットワーク(名前または id)

--network-type <network-type>

このネットワークセグメントのネットワーク種別(flat、geneve、gre、local、vlan、または vxlan)

Expand
表54.231 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.232 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.233 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.234 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.59. network segment delete

ネットワークセグメントを削除します。

使用方法

openstack network segment delete [-h]
                                        <network-segment>
                                        [<network-segment> ...]

Expand
表54.235 位置引数
概要

<network-segment>

削除するネットワークセグメント(名前または ID)

Expand
表54.236 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

54.60. network segment list

ネットワークセグメントの一覧を表示します。

使用方法

openstack network segment 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]
                                      [--network <network>]

Expand
表54.237 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--network <network>

このネットワークに属するネットワークセグメントを一覧表示します(名前または ID)。

Expand
表54.238 出力形式の設定
概要

出力フォーマッター options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表54.239 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表54.240 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.241 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.61. network segment range create

新規ネットワークセグメントの範囲を作成します。

使用方法

openstack network segment range create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--private | --shared]
                                              [--project <project>]
                                              [--project-domain <project-domain>]
                                              --network-type <network-type>
                                              [--physical-network <physical-network-name>]
                                              --minimum
                                              <minimum-segmentation-id>
                                              --maximum
                                              <maximum-segmentation-id>
                                              <name>

Expand
表54.242 位置引数
概要

<name>

新規ネットワークセグメント範囲の名前

Expand
表54.243 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--private

ネットワークセグメント範囲は特定のプロジェクトに割り当てられます。

--shared

ネットワークセグメント範囲は他のプロジェクトと共有されます。

--project <project>

ネットワークセグメント範囲の所有者(名前または ID)。セグメント範囲が共有される場合は任意です。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--network-type <network-type>

このネットワークセグメント範囲のネットワーク種別(geneve、gre、vlan、または vxlan)

--physical-network <physical-network-name>

このネットワークセグメント範囲の物理ネットワーク名

--minimum <minimum-segmentation-id>

このネットワークセグメント範囲の最小セグメント識別子。ネットワーク種別、vlan ネットワーク種別の VLAN ID、ならびにgeneve、gre、および vxlan ネットワーク種別のトンネル IDに基づきます。

--maximum <maximum-segmentation-id>

このネットワークセグメント範囲の最大セグメント識別子。ネットワーク種別、vlan ネットワーク種別の VLAN ID、ならびにgeneve、gre、および vxlan ネットワーク種別のトンネル IDに基づきます。

Expand
表54.244 出力形式の設定
概要

出力フォーマッター options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表54.245 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表54.246 Shell フォーマッター
概要

UNIX シェルで解析できる形式(variable="value")--prefix PREFIX

すべての変数名にプレフィックスを追加します。

Expand
表54.247 表の書式設定
概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.62. network segment range delete