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

Red Hat OpenStack Platform 13

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

概要

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

はじめに

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

第1章 OpenStack クライアント

openstack クライアントは、一般的な OpenStack コマンドラインインターフェイス (CLI) です。本章では、openstack バージョン 3.14.3 の主なオプションについて説明します。: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-network-api-version <network-api-version>]
                 [--os-image-api-version <image-api-version>]
                 [--os-volume-api-version <volume-api-version>]
                 [--os-identity-api-version <identity-api-version>]
                 [--os-object-api-version <object-api-version>]
                 [--os-queues-api-version <queues-api-version>]
                 [--os-tripleoclient-api-version <tripleoclient-api-version>]
                 [--os-key-manager-api-version <key-manager-api-version>]
                 [--os-loadbalancer-api-version <loadbalancer-api-version>]
                 [--os-metrics-api-version <metrics-api-version>]
                 [--os-workflow-api-version <workflow-api-version>]
                 [--os-baremetal-api-version <baremetal-api-version>]
                 [--os-dns-api-version <dns-api-version>]
                 [--os-alarming-api-version <alarming-api-version>]
                 [--os-orchestration-api-version <orchestration-api-version>]
                 [--os-data-processing-api-version <data-processing-api-version>]
                 [--os-data-processing-url OS_DATA_PROCESSING_URL]
                 [--os-container-infra-api-version <container-infra-api-version>]
                 [--inspector-api-version INSPECTOR_API_VERSION]
                 [--inspector-url INSPECTOR_URL]
                 [--os-database-api-version <database-api-version>]
                 [--os-auth-type <auth-type>]
                 [--os-project-domain-id <auth-project-domain-id>]
                 [--os-protocol <auth-protocol>]
                 [--os-project-name <auth-project-name>]
                 [--os-trust-id <auth-trust-id>]
                 [--os-consumer-key <auth-consumer-key>]
                 [--os-domain-name <auth-domain-name>]
                 [--os-access-secret <auth-access-secret>]
                 [--os-user-domain-id <auth-user-domain-id>]
                 [--os-access-token-type <auth-access-token-type>]
                 [--os-code <auth-code>]
                 [--os-application-credential-name <auth-application-credential-name>]
                 [--os-identity-provider-url <auth-identity-provider-url>]
                 [--os-aodh-endpoint <auth-aodh-endpoint>]
                 [--os-service-provider-endpoint <auth-service-provider-endpoint>]
                 [--os-access-token <auth-access-token>]
                 [--os-domain-id <auth-domain-id>]
                 [--os-user-domain-name <auth-user-domain-name>]
                 [--os-openid-scope <auth-openid-scope>]
                 [--os-user-id <auth-user-id>]
                 [--os-application-credential-secret <auth-application-credential-secret>]
                 [--os-identity-provider <auth-identity-provider>]
                 [--os-username <auth-username>]
                 [--os-auth-url <auth-auth-url>]
                 [--os-client-secret <auth-client-secret>]
                 [--os-access-token-endpoint <auth-access-token-endpoint>]
                 [--os-default-domain-id <auth-default-domain-id>]
                 [--os-discovery-endpoint <auth-discovery-endpoint>]
                 [--os-client-id <auth-client-id>]
                 [--os-default-domain-name <auth-default-domain-name>]
                 [--os-project-domain-name <auth-project-domain-name>]
                 [--os-service-provider-entity-id <auth-service-provider-entity-id>]
                 [--os-access-key <auth-access-key>]
                 [--os-password <auth-password>]
                 [--os-redirect-uri <auth-redirect-uri>]
                 [--os-endpoint <auth-endpoint>] [--os-roles <auth-roles>]
                 [--os-url <auth-url>]
                 [--os-consumer-secret <auth-consumer-secret>]
                 [--os-token <auth-token>]
                 [--os-application-credential-id <auth-application-credential-id>]
                 [--os-passcode <auth-passcode>]
                 [--os-system-scope <auth-system-scope>]
                 [--os-project-id <auth-project-id>] [--os-user <auth-user>]

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

概要

--inspector-url INSPECTOR_URL

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

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

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

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

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

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

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

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

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

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

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

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

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

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

-h, --help

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

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

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

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

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

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

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

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

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

--verify

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

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

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

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

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

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

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

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

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

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

password: プロジェクトが含まれるドメイン名。v3adfspassword: プロジェクトが含まれるドメイン名。v3oidcclientcredentials: プロジェクトが含まれるドメイン名。v3samlpassword: プロジェクトが含まれるドメイン名。v3password: プロジェクトが含まれるドメイン名。v3oidcaccesstoken: プロジェクトが含まれるドメイン名。v3oidcpassword: プロジェクトが含まれるドメイン名。token: プロジェクトが含まれるドメイン名。v3tokenlessauth: プロジェクトが含まれるドメイン名。v3totp: プロジェクトが含まれるドメイン名。3applicationcredential: プロジェクトが含まれるドメイン名。v3oidcauthcode: プロジェクトが含まれるドメイン名。v3token: プロジェクトが含まれるドメイン名。v3multifactor: プロジェクトが含まれるドメイン名。(Env: OS_PROJECT_DOMAIN_NAME)

--os-endpoint <auth-endpoint>

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

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

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

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

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

--os-roles <auth-roles>

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

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

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

--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-data-processing-api-version <data-processing-api-version>

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

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

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

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

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

--os-beta-command

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

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

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

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

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

--timing

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

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

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

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

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

--os-protocol <auth-protocol>

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

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

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

--os-user <auth-user>

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

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

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

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

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

--insecure

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

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

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

--os-password <auth-password>

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

--os-cert <certificate-file>

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

--os-code <auth-code>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

--os-passcode <auth-passcode>

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

--os-profile hmac-key

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

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

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

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

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

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

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

-v、--verbose

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

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

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

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

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

--os-data-processing-url OS_DATA_PROCESSING_URL

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

--os-service-provider <service_provider>

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

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

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

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

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

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

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

--os-key <key-file>

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

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

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

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

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

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

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

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

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

OS_VOLUME_API_VERSION)--log-file LOG_FILE

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

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

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

--debug

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

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

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

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

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

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

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

-q, --quiet

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

--version

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

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

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

--os-interface <interface>

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

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

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

--os-token <auth-token>

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

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

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

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

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

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

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

--os-url <auth-url>

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

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

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

--os-username <auth-username>

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

第2章 acl

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

2.1. acl delete

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

使用方法

openstack acl delete [-h] URI

表2.1 位置引数

概要

URI

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

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

概要

-h, --help

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

2.2. acl get

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

使用方法

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

表2.3 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表2.4 位置引数

概要

URI

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

表2.5 CSV 書式設定

概要

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

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

表2.6 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表2.7 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

2.3. acl submit

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

使用方法

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

表2.9 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表2.10 位置引数

概要

URI

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

表2.11 CSV 書式設定

概要

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

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

表2.12 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表2.13 JSON 書式設定

概要

--noindent

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

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

概要

--project-access

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

-h, --help

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

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

ACL の keystone ユーザー ID。

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

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

--no-project-access

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

2.4. acl user add

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

使用方法

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

表2.15 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表2.16 位置引数

概要

URI

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

表2.17 CSV 書式設定

概要

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

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

表2.18 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表2.19 JSON 書式設定

概要

--noindent

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

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

概要

--project-access

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

-h, --help

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

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

ACL の keystone ユーザー ID。

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

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

--no-project-access

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

2.5. acl user remove

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

使用方法

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

表2.21 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表2.22 位置引数

概要

URI

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

表2.23 CSV 書式設定

概要

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

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

表2.24 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表2.25 JSON 書式設定

概要

--noindent

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

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

概要

--project-access

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

-h, --help

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

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

ACL の keystone ユーザー ID。

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

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

--no-project-access

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

第3章 action

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

3.1. action definition create

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

使用方法

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

表3.1 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表3.2 位置引数

概要

定義

アクション定義ファイル

表3.3 CSV 書式設定

概要

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

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

表3.4 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表3.5 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

--public

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

3.2. action definition definition show

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

使用方法

openstack action definition definition show [-h] name

表3.7 位置引数

概要

name

アクション名

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

概要

-h, --help

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

3.3. action definition delete

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

使用方法

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

表3.9 位置引数

概要

action

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

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

概要

-h, --help

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

3.4. action definition list

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

使用方法

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

表3.11 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表3.12 CSV 書式設定

概要

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

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

表3.13 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表3.14 JSON 書式設定

概要

--noindent

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

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

概要

--filter FILTERS

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

-h, --help

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

3.5. action definition show

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

使用方法

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

表3.16 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表3.17 位置引数

概要

action

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

表3.18 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表3.19 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

表3.21 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

3.6. action definition update

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

使用方法

openstack action definition update [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN]
                                          [--id ID] [--public]
                                          definition

表3.22 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表3.23 位置引数

概要

定義

アクション定義ファイル

表3.24 CSV 書式設定

概要

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

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

表3.25 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表3.26 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

--id ID

アクション ID。

--public

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

3.7. action execution delete

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

使用方法

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

表3.28 位置引数

概要

action_execution

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

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

概要

-h, --help

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

3.8. action execution input show

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

使用方法

openstack action execution input show [-h] id

表3.30 位置引数

概要

id

アクション実行 ID。

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

概要

-h, --help

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

3.9. action execution list

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

使用方法

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

表3.32 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表3.33 位置引数

概要

task_execution_id

タスクの実行 ID。

表3.34 CSV 書式設定

概要

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

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

表3.35 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表3.36 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

--limit [LIMIT]

単一の結果で返すアクション実行の最大数。制限はデフォルトで 100 に設定されます。--limit -1 を使用して完全な結果セットを取得します。

3.10. action execution output show

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

使用方法

openstack action execution output show [-h] id

表3.38 位置引数

概要

id

アクション実行 ID。

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

概要

-h, --help

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

3.11. action execution run

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

使用方法

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

表3.40 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表3.41 位置引数

概要

input

アクション入力。

name

実行するアクション名。

表3.42 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表3.43 JSON 書式設定

概要

--noindent

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

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

概要

-s, --save-result

結果を db に保存します。

-t TARGET, --target TARGET

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

-h, --help

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

--run-sync

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

表3.45 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

3.12. action execution show

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

使用方法

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

表3.46 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表3.47 位置引数

概要

action_execution

アクション実行 ID。

表3.48 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表3.49 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

表3.51 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

3.13. action execution update

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

使用方法

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

表3.52 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表3.53 位置引数

概要

id

アクション実行 ID。

表3.54 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表3.55 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

--output OUTPUT

アクション実行の出力

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

アクション実行の状態

表3.57 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

第4章 address

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

4.1. address scope create

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

使用方法

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

表4.1 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表4.2 位置引数

概要

<name>

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

表4.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表4.4 JSON 書式設定

概要

--noindent

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

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

概要

--share

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

--ip-version {4,6}

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

--project-domain <project-domain>

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

--no-share

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

-h, --help

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

--project <project>

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

表4.6 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

4.2. address scope delete

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

使用方法

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

表4.7 位置引数

概要

<address-scope>

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

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

概要

-h, --help

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

4.3. address scope list

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

使用方法

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

表4.9 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表4.10 CSV 書式設定

概要

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

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

表4.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表4.12 JSON 書式設定

概要

--noindent

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

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

概要

--share

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

--ip-version <ip-version>

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

--name <name>

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

--project <project>

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

--no-share

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

-h, --help

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

--project-domain <project-domain>

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

4.4. address scope set

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

使用方法

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

表4.14 位置引数

概要

<address-scope>

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

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

概要

--share

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

--name <name>

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

-h, --help

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

--no-share

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

4.5. address scope show

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

使用方法

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

表4.16 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表4.17 位置引数

概要

<address-scope>

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

表4.18 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表4.19 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

表4.21 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

第5章 aggregate

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

5.1. aggregate add host

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

使用方法

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

表5.1 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表5.2 位置引数

概要

<aggregate>

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

<host>

<aggregate> に追加するホスト

表5.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表5.4 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

表5.6 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

5.2. aggregate create

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

使用方法

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

表5.7 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表5.8 位置引数

概要

<name>

新しいアグリゲート名

表5.9 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表5.10 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

--zone <availability-zone>

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

--property <key=value>

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

表5.12 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

5.3. aggregate delete

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

使用方法

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

表5.13 位置引数

概要

<aggregate>

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

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

概要

-h, --help

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

5.4. aggregate list

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

使用方法

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

表5.15 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表5.16 CSV 書式設定

概要

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

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

表5.17 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表5.18 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

--long

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

5.5. aggregate remove host

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

使用方法

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

表5.20 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表5.21 位置引数

概要

<aggregate>

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

<host>

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

表5.22 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表5.23 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

表5.25 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

5.6. aggregate set

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

使用方法

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

表5.26 位置引数

概要

<aggregate>

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

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

概要

--name <name>

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

-h, --help

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

--zone <availability-zone>

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

--no-property

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

--property <key=value>

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

5.7. aggregate show

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

使用方法

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

表5.28 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表5.29 位置引数

概要

<aggregate>

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

表5.30 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表5.31 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

表5.33 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

5.8. aggregate unset

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

使用方法

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

表5.34 位置引数

概要

<aggregate>

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

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

概要

--property <key>

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

-h, --help

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

第6章 alarm

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

6.1. alarm create

アラームの作成

使用方法

openstack alarm create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] --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>] [--metric <METRIC>]
                              [--event-type <EVENT_TYPE>]
                              [--granularity <GRANULARITY>]
                              [--aggregation-method <AGGR_METHOD>]
                              [--resource-type <RESOURCE_TYPE>]
                              [--resource-id <RESOURCE_ID>]
                              [--metrics <METRICS>]
                              [--composite-rule <COMPOSITE_RULE>]

表6.1 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表6.2 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表6.3 common gnocchi alarm rules

概要

--aggregation-method <AGGR_METHOD>

しきい値と比較する aggregation_method

--granularity <GRANULARITY>

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

表6.4 event alarm

概要

--event-type <EVENT_TYPE>

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

表6.5 gnocchi resource threshold alarm

概要

--resource-id <RESOURCE_ID>

リソースの ID。

--resource-type <RESOURCE_TYPE>

リソースのタイプ。

表6.6 JSON 書式設定

概要

--noindent

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

表6.7 composite alarm

概要

--composite-rule <COMPOSITE_RULE>

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

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

概要

--ok-action <Webhook URL>

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

--user-id <USER_ID>

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

--name <NAME>

アラームの名前

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

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

--repeat-actions {True

False}

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

--state <STATE>

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

--time-constraint <Time Constraint>

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

--project-id <PROJECT_ID>

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

--insufficient-data-action <Webhook URL>

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

--severity <SEVERITY>

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

--alarm-action <Webhook URL>

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

-h, --help

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

--description <DESCRIPTION>

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

--enabled {True

False}

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

表6.9 common alarm rules

概要

--evaluation-periods <EVAL_PERIODS>

評価する期間の数

--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] のいずれか。

--metric <METRIC>

評価対象のメトリック。

--threshold <THRESHOLD>

評価するしきい値。

表6.10 メトリクスアラームによる Gnocchi の集計

概要

--metrics <METRICS>

メトリクス ID の一覧。

表6.11 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

6.2. alarm delete

アラームを削除します。

使用方法

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

表6.12 位置引数

概要

<ALARM ID または NAME>

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

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

概要

--name <NAME>

アラームの名前

-h, --help

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

6.4. alarm-history show

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

使用方法

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

表6.19 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表6.20 位置引数

概要

<alarm-id>

アラームの ID

表6.21 CSV 書式設定

概要

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

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

表6.22 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表6.23 JSON 書式設定

概要

--noindent

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

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

概要

--sort <SORT_KEY:SORT_DIR>

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

--limit <LIMIT>

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

-h, --help

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

--marker <MARKER>

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

6.5. alarm list

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

使用方法

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

表6.25 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表6.26 CSV 書式設定

概要

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

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

表6.27 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表6.28 JSON 書式設定

概要

--noindent

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

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

概要

--sort <SORT_KEY:SORT_DIR>

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

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

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

--query QUERY

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

--marker <MARKER>

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

--limit <LIMIT>

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

-h, --help

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

6.6. alarm show

アラームを表示します。

使用方法

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

表6.30 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表6.31 位置引数

概要

<ALARM ID または NAME>

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

表6.32 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表6.33 JSON 書式設定

概要

--noindent

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

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

概要

--name <NAME>

アラームの名前

-h, --help

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

表6.35 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

6.7. alarm state get

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

使用方法

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

表6.36 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表6.37 位置引数

概要

<ALARM ID または NAME>

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

表6.38 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表6.39 JSON 書式設定

概要

--noindent

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

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

概要

--name <NAME>

アラームの名前

-h, --help

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

表6.41 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

6.8. alarm state set

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

使用方法

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

表6.42 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表6.43 位置引数

概要

<ALARM ID または NAME>

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

表6.44 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表6.45 JSON 書式設定

概要

--noindent

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

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

概要

--name <NAME>

アラームの名前

-h, --help

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

--state <STATE>

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

表6.47 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

6.9. alarm update

アラームを更新します。

使用方法

openstack alarm update [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [--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>] [--metric <METRIC>]
                              [--event-type <EVENT_TYPE>]
                              [--granularity <GRANULARITY>]
                              [--aggregation-method <AGGR_METHOD>]
                              [--resource-type <RESOURCE_TYPE>]
                              [--resource-id <RESOURCE_ID>]
                              [--metrics <METRICS>]
                              [--composite-rule <COMPOSITE_RULE>]
                              [<ALARM ID or NAME>]

表6.48 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表6.49 位置引数

概要

<ALARM ID または NAME>

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

表6.50 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表6.51 common gnocchi alarm rules

概要

--aggregation-method <AGGR_METHOD>

しきい値と比較する aggregation_method

--granularity <GRANULARITY>

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

表6.52 event alarm

概要

--event-type <EVENT_TYPE>

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

表6.53 gnocchi resource threshold alarm

概要

--resource-id <RESOURCE_ID>

リソースの ID。

--resource-type <RESOURCE_TYPE>

リソースのタイプ。

表6.54 JSON 書式設定

概要

--noindent

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

表6.55 composite alarm

概要

--composite-rule <COMPOSITE_RULE>

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

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

概要

--ok-action <Webhook URL>

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

--user-id <USER_ID>

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

--name <NAME>

アラームの名前

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

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

--repeat-actions {True

False}

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

--state <STATE>

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

--time-constraint <Time Constraint>

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

--project-id <PROJECT_ID>

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

--insufficient-data-action <Webhook URL>

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

--severity <SEVERITY>

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

--alarm-action <Webhook URL>

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

-h, --help

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

--description <DESCRIPTION>

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

--enabled {True

False}

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

表6.57 common alarm rules

概要

--evaluation-periods <EVAL_PERIODS>

評価する期間の数

--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] のいずれか。

--metric <METRIC>

評価対象のメトリック。

--threshold <THRESHOLD>

評価するしきい値。

表6.58 メトリクスアラームによる Gnocchi の集計

概要

--metrics <METRICS>

メトリクス ID の一覧。

表6.59 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

第7章 アラーム

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

7.1. alarming capabilities list

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

使用方法

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

表7.1 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表7.2 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表7.3 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

表7.5 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

第8章 availability

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

8.1. availability zone list

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

使用方法

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

表8.1 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表8.2 CSV 書式設定

概要

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

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

表8.3 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表8.4 JSON 書式設定

概要

--noindent

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

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

概要

--compute

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

--volume

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

-h, --help

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

--network

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

--long

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

第9章 baremetal

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

9.1. baremetal chassis create

新しいシャーシを作成します。

使用方法

openstack baremetal chassis create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [--description <description>]
                                          [--extra <key=value>]
                                          [--uuid <uuid>]

表9.1 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表9.2 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表9.3 JSON 書式設定

概要

--noindent

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

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

概要

--uuid <uuid>

シャーシの一意の UUID

-h, --help

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

--description <description>

シャーシの説明

--extra <key=value>

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

表9.5 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

9.2. baremetal chassis delete

シャーシを削除します。

使用方法

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

表9.6 位置引数

概要

<chassis>

削除するシャーシの UUID

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

概要

-h, --help

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

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

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

使用方法

openstack baremetal chassis list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--fields <field> [<field> ...]]
                                        [--limit <limit>] [--long]
                                        [--marker <chassis>]
                                        [--sort <key>[:<direction>]]

表9.8 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表9.9 CSV 書式設定

概要

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

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

表9.10 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表9.11 JSON 書式設定

概要

--noindent

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

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

概要

--marker <chassis>

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

--long

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

--limit <limit>

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

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

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

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

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

-h, --help

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

9.4. baremetal chassis set

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

使用方法

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

表9.13 位置引数

概要

<chassis>

シャーシの UUID

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

概要

-h, --help

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

--description <description>

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

--extra <key=value>

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

9.5. baremetal chassis show

シャーシの詳細を表示します。

使用方法

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

表9.15 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表9.16 位置引数

概要

<chassis>

シャーシの UUID

表9.17 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表9.18 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

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

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

表9.20 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

9.6. baremetal chassis unset

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

使用方法

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

表9.21 位置引数

概要

<chassis>

シャーシの UUID

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

概要

-h, --help

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

--extra <key>

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

--description

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

9.7. baremetal create

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

使用方法

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

表9.23 位置引数

概要

<file>

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

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

概要

-h, --help

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

9.8. baremetal driver list

有効なドライバーを一覧表示します。

使用方法

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

表9.25 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表9.26 CSV 書式設定

概要

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

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

表9.27 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表9.28 JSON 書式設定

概要

--noindent

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

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

概要

--type <type>

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

-h, --help

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

--long

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

9.9. baremetal driver passthru call

ドライバーのベンダーパススルーメソッドを呼び出します。

使用方法

openstack baremetal driver passthru call [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                [--arg <key=value>]
                                                [--http-method <http-method>]
                                                <driver> <method>

表9.30 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表9.31 位置引数

概要

<method>

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

<driver>

ドライバーの名前。

表9.32 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表9.33 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

--http-method <http-method>

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

--arg <key=value>

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

表9.35 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

9.10. baremetal driver passthru list

ドライバーで利用可能なベンダーパススルー方法を一覧表示します。

使用方法

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

表9.36 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表9.37 位置引数

概要

<driver>

ドライバーの名前。

表9.38 CSV 書式設定

概要

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

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

表9.39 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表9.40 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

9.11. baremetal driver property list

ドライバープロパティーを一覧表示します。

使用方法

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

表9.42 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表9.43 位置引数

概要

<driver>

ドライバーの名前。

表9.44 CSV 書式設定

概要

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

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

表9.45 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表9.46 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

9.12. baremetal driver raid property list

ドライバーの RAID 論理ネットワークプロパティーを一覧表示します。

使用方法

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

表9.48 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表9.49 位置引数

概要

<driver>

ドライバーの名前。

表9.50 CSV 書式設定

概要

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

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

表9.51 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表9.52 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

9.13. baremetal driver show

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

使用方法

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

表9.54 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表9.55 位置引数

概要

<driver>

ドライバーの名前。

表9.56 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

表9.57 JSON 書式設定

概要

--noindent

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

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

概要

-h, --help

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

表9.59 Shell フォーマッター

概要

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

すべての変数名に接頭辞を追加します。

9.14. baremetal introspection abort

ノードのイントロスペクションの実行を中止します。

使用方法

openstack baremetal introspection abort [-h] node

表9.60 位置引数

概要

node

ベアメタルノードの uuid または名前

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

概要

-h, --help

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

9.15. baremetal introspection data save

未加工のイントロスペクションデータを保存または表示します。

使用方法

openstack baremetal introspection data save [-h] [--file <filename>]
                                                   node

表9.62 位置引数

概要

node

ベアメタルノードの uuid または名前

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

概要

-h, --help

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

--file <filename>

ダウンロードするイントロスペクションデータのファイル名 (デフォルト:stdout)

9.16. baremetal introspection interface list

接続されたスイッチポート情報を含むインターフェイスデータを一覧表示します。

使用方法

openstack baremetal introspection interface list [-h]
                                                        [-f {csv,json,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--noindent]
                                                        [--quote {all,minimal,none,nonnumeric}]
                                                        [--sort-column SORT_COLUMN]
                                                        [--vlan VLAN]
                                                        [--long | --fields <field> [<field> ...]]
                                                        node_ident

表9.64 表の書式設定

概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

表9.65 位置引数

概要

node_ident

ベアメタルノードの uuid または名前

表9.66 CSV 書式設定

概要

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

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

表9.67 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表9.68 JSON 書式設定

概要

--noindent

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

表9.69 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--vlan VLAN

この vlan ID 用に設定されたインターフェイスのみを一覧表示します。繰り返し使用できます。

--long

インターフェイスに関する詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のフィールドを表示します。-- long が指定されている場合は使用できません。

9.17. baremetal introspection interface show

接続されたスイッチポート情報が含まれるインターフェイスデータを表示します。

使用方法

openstack baremetal introspection interface show [-h]
                                                        [-f {json,shell,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--noindent]
                                                        [--prefix PREFIX]
                                                        [--fields <field> [<field> ...]]
                                                        node_ident interface

表9.70 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.71 位置引数

概要

interface

インターフェイス名

node_ident

ベアメタルノードの uuid または名前

表9.72 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.73 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.74 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のフィールドを表示します。

表9.75 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.18. baremetal introspection list

イントロスペクションのステータスを一覧表示します。

使用方法

openstack baremetal introspection list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]
                                              [--marker MARKER]
                                              [--limit LIMIT]

表9.76 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.77 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表9.78 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表9.79 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.80 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit LIMIT

返す項目数

--marker MARKER

前のページにある最後の項目の UUID

9.19. baremetal introspection reprocess

保存されたイントロスペクションデータを再処理します。

使用方法

openstack baremetal introspection reprocess [-h] node

表9.81 位置引数

概要

node

ベアメタルノードの uuid または名前

表9.82 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.20. baremetal introspection rule delete

イントロスペクションルールを削除します。

使用方法

openstack baremetal introspection rule delete [-h] uuid

表9.83 位置引数

概要

uuid

ルールの uuid

表9.84 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.21. baremetal introspection rule import

JSON/YAML ファイルから 1 つまたは複数のイントロスペクションルールをインポートします。

使用方法

openstack baremetal introspection rule import [-h]
                                                     [-f {csv,json,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--max-width <integer>]
                                                     [--fit-width]
                                                     [--print-empty]
                                                     [--noindent]
                                                     [--quote {all,minimal,none,nonnumeric}]
                                                     [--sort-column SORT_COLUMN]
                                                     file

表9.85 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.86 位置引数

概要

file

インポートする JSON ファイル。1 つまたは複数のルールを含めることができます。

表9.87 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表9.88 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表9.89 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.90 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.22. baremetal introspection rule list

全イントロスペクションルールを一覧表示します。

使用方法

openstack baremetal introspection rule list [-h]
                                                   [-f {csv,json,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--quote {all,minimal,none,nonnumeric}]
                                                   [--sort-column SORT_COLUMN]

表9.91 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.92 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表9.93 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表9.94 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.95 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.23. baremetal introspection rule purge

すべてのイントロスペクションルールを破棄します。

使用方法

openstack baremetal introspection rule purge [-h]

表9.96 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.24. baremetal introspection rule show

イントロスペクションルールを表示します。

使用方法

openstack baremetal introspection rule show [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX]
                                                   uuid

表9.97 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.98 位置引数

概要

uuid

ルールの uuid

表9.99 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.100 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.101 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表9.102 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.25. baremetal introspection start

イントロスペクションを開始します。

使用方法

openstack baremetal introspection start [-h]
                                               [-f {csv,json,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent]
                                               [--quote {all,minimal,none,nonnumeric}]
                                               [--sort-column SORT_COLUMN]
                                               [--wait]
                                               node [node ...]

表9.103 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.104 位置引数

概要

node

ベアメタルノードの uuid または名前

表9.105 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表9.106 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表9.107 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.108 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait

イントロスペクションが完了するまで待機します。結果は最後に表示されます。

9.26. baremetal introspection status

イントロスペクションのステータスを取得します。

使用方法

openstack baremetal introspection status [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                node

表9.109 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.110 位置引数

概要

node

ベアメタルノードの uuid または名前

表9.111 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.112 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.113 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表9.114 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.27. baremetal node abort

ベアメタルノードのプロビジョニング状態を abort に設定します。

使用方法

openstack baremetal node abort [-h] <node>

表9.115 位置引数

概要

<node>

ノードの名前または UUID。

表9.116 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.28. baremetal node add trait

ノードに特性を追加します。

使用方法

openstack baremetal node add trait [-h] <node> <trait> [<trait> ...]

表9.117 位置引数

概要

<node>

ノードの名前または UUID

<trait>

追加する特性

表9.118 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.29. baremetal node adopt

ベアメタルノードのプロビジョニング状態を adopt に設定します。

使用方法

openstack baremetal node adopt [-h] [--wait [<time-out>]] <node>

表9.119 位置引数

概要

<node>

ノードの名前または UUID。

表9.120 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。

9.30. baremetal node boot device set

ノードのブートデバイスを設定します。

使用方法

openstack baremetal node boot device set [-h] [--persistent]
                                                <node> <device>

表9.121 位置引数

概要

<node>

ノードの名前または UUID

<device>

Bios、cdrom、disk、pxe、safe、wanboot のいずれか

表9.122 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--persistent

今後の起動時にすべての変更を永続化します。

9.31. baremetal node boot device show

ノードのブートデバイス情報を表示します。

使用方法

openstack baremetal node boot device show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 [--supported]
                                                 <node>

表9.123 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.124 位置引数

概要

<node>

ノードの名前または UUID

表9.125 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.126 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.127 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--supported

サポート対象のブートデバイスを表示します。

表9.128 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.32. baremetal node clean

ベアメタルノードのプロビジョニング状態を clean に設定します。

使用方法

openstack baremetal node clean [-h] [--wait [<time-out>]] --clean-steps
                                      <clean-steps>
                                      <node>

表9.129 位置引数

概要

<node>

ノードの名前または UUID。

表9.130 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。

--clean-steps <clean-steps>

Json 形式の消去手順。消去手順が含まれるファイルへのパス、- (消去手順が標準入力から読み取る)、または文字列になります。値は clean-step ディクショナリーの一覧である必要があります。各ディクショナリーには、キーの interface および step、任意のキーの args が必要です。

9.33. baremetal node console disable

ノードのコンソールアクセスを無効化します。

使用方法

openstack baremetal node console disable [-h] <node>

表9.131 位置引数

概要

<node>

ノードの名前または UUID

表9.132 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.34. baremetal node console enable

ノードのコンソールアクセスを有効化します。

使用方法

openstack baremetal node console enable [-h] <node>

表9.133 位置引数

概要

<node>

ノードの名前または UUID

表9.134 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.35. baremetal node console show

ノードのコンソール情報を表示します。

使用方法

openstack baremetal node console show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             <node>

表9.135 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.136 位置引数

概要

<node>

ノードの名前または UUID

表9.137 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.138 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.139 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表9.140 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.36. baremetal node create

新規ノードを baremetal サービスに登録します。

使用方法

openstack baremetal node create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--chassis-uuid <chassis>] --driver
                                       <driver> [--driver-info <key=value>]
                                       [--property <key=value>]
                                       [--extra <key=value>] [--uuid <uuid>]
                                       [--name <name>]
                                       [--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>]
                                       [--storage-interface <storage_interface>]
                                       [--vendor-interface <vendor_interface>]
                                       [--resource-class <resource_class>]

表9.141 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.142 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.143 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.144 その他の引数 (オプション):

概要

--inspect-interface <inspect_interface>

ノードのドライバーで使用されるインスペクトインターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--boot-interface <boot_interface>

ノードのドライバーで使用される起動インターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--management-interface <management_interface>

ノードのドライバーで使用される管理インターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--driver <driver>

ノードの制御に使用されるドライバー [必須]。

--deploy-interface <deploy_interface>

ノードのドライバーで使用されるデプロイインターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--uuid <uuid>

ノードの一意の UUID。

--console-interface <console_interface>

ノードのドライバーで使用されるコンソールインターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--chassis-uuid <chassis>

このノードが属するシャーシの UUID。

--network-interface <network_interface>

クリーニング/プロビジョニングネットワークへのノードの切り替えに使用するネットワークインターフェイス

--property <key=value>

ノードの物理的な特性を記述するキー/値のペア。これは Nova にエクスポートされ、スケジューラーが使用します。複数回指定できます。

--vendor-interface <vendor_interface>

ノードのドライバーで使用されるベンダーインターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--resource-class <resource_class>

ノードを nova フレーバーにマッピングするためのリソースクラス

--raid-interface <raid_interface>

ノードのドライバーで使用される RAID インターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--storage-interface <storage_interface>

ノードのドライバーが使用するストレージインターフェイス。

--power-interface <power_interface>

ノードのドライバーで使用される電源インターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--name <name>

ノードの一意名。

--driver-info <key=value>

アウトバウンド管理認証情報など、ドライバーが使用するキー/値のペア。複数回指定できます。

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

-h, --help

ヘルプメッセージを表示して終了します。

表9.145 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.37. baremetal node delete

ベアメタルノードの登録を解除します。

使用方法

openstack baremetal node delete [-h] <node> [<node> ...]

表9.146 位置引数

概要

<node>

削除するノード (名前または uuid)

表9.147 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.38. baremetal node deploy

ベアメタルノードのプロビジョニングの状態を deploy に設定します。

使用方法

openstack baremetal node deploy [-h] [--wait [<time-out>]]
                                       [--config-drive <config-drive>]
                                       <node>

表9.148 位置引数

概要

<node>

ノードの名前または UUID。

表9.149 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。

--config-drive <config-drive>

gzipped, base64 でエンコードされたコンフィグドライブの文字列、またはコンフィグドライブファイルへのパス、またはコンフィグドライブファイルを含むディレクトリーへのパス。ディレクトリーの場合には、コンフィグドライブはそのディレクトリーで生成されます。

9.39. baremetal node inject nmi

NMI をベアメタルノードに注入します。

使用方法

openstack baremetal node inject nmi [-h] <node>

表9.150 位置引数

概要

<node>

ノードの名前または UUID。

表9.151 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.40. baremetal node inspect

ベアメタルノードのプロビジョニング状態を inspect に設定します。

使用方法

openstack baremetal node inspect [-h] [--wait [<time-out>]] <node>

表9.152 位置引数

概要

<node>

ノードの名前または UUID。

表9.153 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。

9.41. baremetal node list

ベアメタルノードを一覧表示します。

使用方法

openstack baremetal node list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--limit <limit>] [--marker <node>]
                                     [--sort <key>[:<direction>]]
                                     [--maintenance | --no-maintenance]
                                     [--associated | --unassociated]
                                     [--provision-state <provision state>]
                                     [--driver <driver>]
                                     [--resource-class <resource class>]
                                     [--chassis <chassis UUID>]
                                     [--long | --fields <field> [<field> ...]]

表9.154 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.155 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表9.156 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表9.157 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.158 その他の引数 (オプション):

概要

--sort <key>[:<direction>]

指定したノードフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--chassis <chassis UUID>

このシャーシのノードのみに一覧を制限します。

--resource-class <resource class>

リソースクラスが <resource class> のノードのみに一覧を制限します。

--marker <node>

ノードの uuid(例: 以前の要求リストにある最後のノード)。UUID の後にノードの一覧を返します。

--long

ノードの詳細情報を表示します。

--provision-state <provision state>

指定したプロビジョニング状態のノードを一覧表示します。

--limit <limit>

要求ごとに返すノードの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--fields <field> [<field> …​]

1 つ以上のノードフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

--maintenance

メンテナーンスモードのノードだけにリストを制限します。

--unassociated

インスタンスに関連付けられていないノードのみを一覧表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--associated

インスタンスに関連付けられているノードのみを一覧表示します。

--no-maintenance

メンテナーンスモード以外のノードだけにリストを制限します。

--driver <driver>

ドライバーが <driver> のノードのみに一覧を制限します。

9.42. baremetal node maintenance set

ベアメタルノードをメンテナーンスモードに設定します。

使用方法

openstack baremetal node maintenance set [-h] [--reason <reason>]
                                                <node>

表9.159 位置引数

概要

<node>

ノードの名前または UUID。

表9.160 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--reason <reason>

メンテナーンスモードを設定する理由。

9.43. baremetal node maintenance unset

メンテナーンスモードのベアメタルノードの設定を解除します。

使用方法

openstack baremetal node maintenance unset [-h] <node>

表9.161 位置引数

概要

<node>

ノードの名前または UUID。

表9.162 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.44. baremetal node manage

ベアメタルノードのプロビジョニングの状態を manage に設定します。

使用方法

openstack baremetal node manage [-h] [--wait [<time-out>]] <node>

表9.163 位置引数

概要

<node>

ノードの名前または UUID。

表9.164 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。

9.45. baremetal node passthru call

ノードのベンダーパススルーメソッドを呼び出します。

使用方法

openstack baremetal node passthru call [-h] [--arg <key=value>]
                                              [--http-method <http-method>]
                                              <node> <method>

表9.165 位置引数

概要

<node>

ノードの名前または UUID

<method>

実行するベンダーパススルーメソッド

表9.166 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--http-method <http-method>

パススルー要求で使用する http メソッド。DELETE、GET、PATCH、POST、PUT のいずれか。デフォルトは POST です。

--arg <key=value>

Passthru メソッドに渡す引数 (複数の引数を指定する場合は、オプションを繰り返し使用します)。

9.46. baremetal node passthru list

ノードのベンダーパススルー方法を一覧表示します。

使用方法

openstack baremetal node passthru list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]
                                              <node>

表9.167 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.168 位置引数

概要

<node>

ノードの名前または UUID

表9.169 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表9.170 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表9.171 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.172 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.47. baremetal node power off

ノードの電源をオフにします。

使用方法

openstack baremetal node power off [-h]
                                          [--power-timeout <power-timeout>]
                                          [--soft]
                                          <node>

表9.173 位置引数

概要

<node>

ノードの名前または UUID。

表9.174 その他の引数 (オプション):

概要

--soft

正常な電源オフを要求します。

-h, --help

ヘルプメッセージを表示して終了します。

--power-timeout <power-timeout>

エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間 (秒単位、正の整数)。

9.48. baremetal node power on

ノードの電源をオンにします。

使用方法

openstack baremetal node power on [-h]
                                         [--power-timeout <power-timeout>]
                                         <node>

表9.175 位置引数

概要

<node>

ノードの名前または UUID。

表9.176 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--power-timeout <power-timeout>

エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間 (秒単位、正の整数)。

9.49. baremetal node provide

ベアメタルノードのプロビジョニングの状態を provide に設定します。

使用方法

openstack baremetal node provide [-h] [--wait [<time-out>]] <node>

表9.177 位置引数

概要

<node>

ノードの名前または UUID。

表9.178 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (available) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。

9.50. baremetal node reboot

ベアメタルノードを再起動します。

使用方法

openstack baremetal node reboot [-h] [--soft]
                                       [--power-timeout <power-timeout>]
                                       <node>

表9.179 位置引数

概要

<node>

ノードの名前または UUID。

表9.180 その他の引数 (オプション):

概要

--soft

正常な再起動を要求します。

-h, --help

ヘルプメッセージを表示して終了します。

--power-timeout <power-timeout>

エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間 (秒単位、正の整数)。

9.51. baremetal node rebuild

ベアメタルノードのプロビジョニングの状態を rebuild に設定します。

使用方法

openstack baremetal node rebuild [-h] [--wait [<time-out>]]
                                        [--config-drive <config-drive>]
                                        <node>

表9.181 位置引数

概要

<node>

ノードの名前または UUID。

表9.182 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。

--config-drive <config-drive>

gzipped, base64 でエンコードされたコンフィグドライブの文字列、またはコンフィグドライブファイルへのパス、またはコンフィグドライブファイルを含むディレクトリーへのパス。ディレクトリーの場合には、コンフィグドライブはそのディレクトリーで生成されます。

9.52. baremetal node remove trait

ノードから特性を削除します。

使用方法

openstack baremetal node remove trait [-h] [--all]
                                             <node> [<trait> [<trait> ...]]

表9.183 位置引数

概要

<node>

ノードの名前または UUID

<trait>

削除する特性

表9.184 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all

すべての特性を削除します。

9.53. baremetal node set

ベアメタルのプロパティーを設定します。

使用方法

openstack baremetal node set [-h] [--instance-uuid <uuid>]
                                    [--name <name>]
                                    [--chassis-uuid <chassis UUID>]
                                    [--driver <driver>]
                                    [--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>]
                                    [--storage-interface <storage_interface>]
                                    [--vendor-interface <vendor_interface>]
                                    [--resource-class <resource_class>]
                                    [--target-raid-config <target_raid_config>]
                                    [--property <key=value>]
                                    [--extra <key=value>]
                                    [--driver-info <key=value>]
                                    [--instance-info <key=value>]
                                    <node>

表9.185 位置引数

概要

<node>

ノードの名前または UUID。

表9.186 その他の引数 (オプション):

概要

--instance-uuid <uuid>

ノードのインスタンスの uuid を <uuid> に設定します。

--inspect-interface <inspect_interface>

ノードの検査インターフェイスを設定します。

--boot-interface <boot_interface>

ノードの起動インターフェイスを設定します。

--management-interface <management_interface>

ノードの管理インターフェイスを設定します。

--driver <driver>

ノードのドライバーを設定します。

--extra <key=value>

このベアメタルノードに設定する追加項目 (複数のプロパティーを設定する場合はオプションを繰り返し使用します)

--deploy-interface <deploy_interface>

ノードのデプロイインターフェイスを設定します。

--name <name>

ノードの名前。

--console-interface <console_interface>

ノードのコンソールインターフェイスを設定します。

--power-interface <power_interface>

ノードの電源インターフェイスを設定します。

--network-interface <network_interface>

ノードのネットワークインターフェイスを設定します。

--property <key=value>

このベアメタルノードに設定するプロパティー (複数のプロパティーを設定する場合はオプションを繰り返し使用します)

--vendor-interface <vendor_interface>

ノードのベンダーインターフェイスを設定します。

--resource-class <resource_class>

ノードのリソースクラスを設定します。

--chassis-uuid <chassis UUID>

ノードのシャーシを設定します。

--raid-interface <raid_interface>

ノードの RAID インターフェイスを設定します。

--storage-interface <storage_interface>

ノードのストレージインターフェイスを設定します。

--instance-info <key=value>

このベアメタルノードに設定するインスタンス情報 (複数のインスタンス情報を設定する場合はオプションを繰り返し使用します)

--driver-info <key=value>

このベアメタルノードに設定するドライバー情報 (複数のドライバー情報を設定する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

--target-raid-config <target_raid_config>

ノードのターゲット RAID 設定 (json) を設定します。これには、以下のいずれかを使用できます。1. RAID 設定の JSON データを含むファイル、2. 標準入力からコンテンツを読み取る "-"、3、有効な JSON 文字列。

9.54. baremetal node show

ベアメタルノードの詳細を表示します。

使用方法

openstack baremetal node show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--instance]
                                     [--fields <field> [<field> ...]]
                                     <node>

表9.187 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.188 位置引数

概要

<node>

ノードの名前または uuid(または --instance が指定されている場合のインスタンスの uuid)

表9.189 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.190 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.191 その他の引数 (オプション):

概要

--instance

<node> はインスタンスの uuid です。

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のノードフィールド。これらのフィールドのみがサーバーから取得されます。

表9.192 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.55. baremetal node trait list

ノードの特性を一覧表示します。

使用方法

openstack baremetal node trait list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           <node>

表9.193 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.194 位置引数

概要

<node>

ノードの名前または UUID

表9.195 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表9.196 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表9.197 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.198 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.56. baremetal node undeploy

ベアメタルノードのプロビジョニングの状態を deleted に設定します。

使用方法

openstack baremetal node undeploy [-h] [--wait [<time-out>]] <node>

表9.199 位置引数

概要

<node>

ノードの名前または UUID。

表9.200 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (available) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。

9.57. 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]
                                      [--boot-interface] [--console-interface]
                                      [--deploy-interface]
                                      [--inspect-interface]
                                      [--management-interface]
                                      [--network-interface]
                                      [--power-interface] [--raid-interface]
                                      [--storage-interface]
                                      [--vendor-interface]
                                      <node>

表9.201 位置引数

概要

<node>

ノードの名前または UUID。

表9.202 その他の引数 (オプション):

概要

--property <key>

このベアメタルノードで設定を解除するプロパティー (複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します)

--storage-interface

このベアメタルノードでのストレージインターフェイスの設定を解除します。

--instance-uuid

このベアメタルノードでのインスタンスの uuid の設定を解除します。

--deploy-interface

このベアメタルノードでのデプロイインターフェイスの設定を解除します。

--vendor-interface

このベアメタルノードでのベンダーインターフェイスの設定を解除します。

--network-interface

このベアメタルノードでのネットワークインターフェイスの設定を解除します。

--instance-info <key>

このベアメタルノードでの設定を解除するインスタンス情報 (複数のインスタンス情報の設定を解除する場合はオプションを繰り返し使用します)

--driver-info <key>

このベアメタルノードでの設定を解除するドライバー情報 (複数のドライバー情報の設定を解除する場合はオプションを繰り返し使用します)

--extra <key>

このベアメタルノードの設定を追加で解除する項目 (複数のプロパティーを設定する場合はオプションを繰り返し使用します)

--resource-class

ノードのリソースクラスの設定を解除します。

--management-interface

このベアメタルノードでの管理インターフェイスの設定を解除します。

--boot-interface

このベアメタルノードでのブートインターフェイスの設定を解除します。

--raid-interface

このベアメタルノードでの RAID インターフェイスの設定を解除します。

--console-interface

このベアメタルノードでのコンソールインターフェイスの設定を解除します。

--target-raid-config

ノードのターゲット RAID 設定の設定を解除します。

--name

ノードの名前の設定を解除します。

-h, --help

ヘルプメッセージを表示して終了します。

--inspect-interface

このベアメタルノードでの検査インターフェイスの設定を解除します。

--chassis-uuid

このベアメタルノードでのシャーシ UUID の設定を解除します。

--power-interface

このベアメタルノードの電源インターフェイスの設定を解除します。

9.58. baremetal node validate

ノードのドライバーインターフェイスを検証します。

使用方法

openstack baremetal node validate [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         <node>

表9.203 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.204 位置引数

概要

<node>

ノードの名前または UUID

表9.205 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表9.206 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表9.207 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.208 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.59. baremetal node vif attach

VIF を指定ノードに接続します。

使用方法

openstack baremetal node vif attach [-h] [--vif-info <key=value>]
                                           <node> <vif-id>

表9.209 位置引数

概要

<node>

ノードの名前または UUID

<vif-id>

ノードに割り当てる vif の名前または UUID。

表9.210 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--vif-info <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。必須の id パラメーターはキーとして指定できません。

9.60. baremetal node vif detach

指定のノードから VIF を切断します。

使用方法

openstack baremetal node vif detach [-h] <node> <vif-id>

表9.211 位置引数

概要

<node>

ノードの名前または UUID

<vif-id>

ノードから切り離す vif の名前または UUID。

表9.212 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.61. baremetal node vif list

ノードに接続された VIF を表示します。

使用方法

openstack baremetal node vif list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         <node>

表9.213 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.214 位置引数

概要

<node>

ノードの名前または UUID

表9.215 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表9.216 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表9.217 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.218 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.62. baremetal port create

新規ポートの作成

使用方法

openstack baremetal port create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX] --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>]
                                       <address>

表9.219 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.220 位置引数

概要

<address>

このポートの MAC アドレス。

表9.221 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.222 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.223 その他の引数 (オプション):

概要

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--physical-network <physical network>

このポートを接続する物理ネットワークの名前。

--uuid <uuid>

ポートの UUID

--port-group <uuid>

このポートが属するポートグループの UUID。

--local-link-connection <key=value>

ローカルリンク接続情報を記述するキー/値のメタデータ。有効なキーは switch_infoswitch_id、および port_id です。switch_idport_id キーは必須です。複数回指定できます。

--pxe-enabled <boolean>

このノードの PXE の起動時にこのポートを使用するかどうかを指定します。

-l <key=value>

非推奨です。代わりに --local-link-connection を使用してください。ローカルリンク接続情報を記述するキー/値のメタデータ。有効なキーは switch_infoswitch_id、および port_id です。switch_idport_id キーは必須です。複数回指定できます。

-h, --help

ヘルプメッセージを表示して終了します。

--node <uuid>

このポートが属するノードの UUID。

表9.224 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.63. baremetal port delete

ポートを削除します。

使用方法

openstack baremetal port delete [-h] <port> [<port> ...]

表9.225 位置引数

概要

<port>

削除するポートの UUID

表9.226 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.64. baremetal port group create

新規ベアメタルポートグループを作成します。

使用方法

openstack baremetal port group create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             --node <uuid>
                                             [--address <mac-address>]
                                             [--name NAME] [--uuid UUID]
                                             [--extra <key=value>]
                                             [--mode MODE]
                                             [--property <key=value>]
                                             [--support-standalone-ports | --unsupport-standalone-ports]

表9.227 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.228 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.229 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.230 その他の引数 (オプション):

概要

--support-standalone-ports

このポートグループのメンバーであるポートはスタンドアロンのポートとして使用できます (デフォルト)。

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--address <mac-address>

このポートグループの MAC アドレス。

--unsupport-standalone-ports

このポートグループのメンバーであるポートは、スタンドアロンのポートとしては使用できません。

--property <key=value>

このポートグループの設定に関連するキー/値プロパティー。複数回指定できます。

--mode MODE

ポートグループのモード。使用できる値は https://www.kernel.org/doc/Documentation/networking/bo nding.txt を参照してください。

--name NAME

ポートグループの名前。

-h, --help

ヘルプメッセージを表示して終了します。

--uuid UUID

ポートグループの UUID

--node <uuid>

このポートグループが属するノードの UUID。

表9.231 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.65. baremetal port group delete

ベアメタルポートグループの登録を解除します。

使用方法

openstack baremetal port group delete [-h]
                                             <port group> [<port group> ...]

表9.232 位置引数

概要

<port group>

削除するポートグループ (名前または UUID)。

表9.233 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.66. baremetal port group list

ベアメタルポートグループを一覧表示します。

使用方法

openstack baremetal port group list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           [--limit <limit>]
                                           [--marker <port group>]
                                           [--sort <key>[:<direction>]]
                                           [--address <mac-address>]
                                           [--node <node>]
                                           [--long | --fields <field> [<field> ...]]

表9.234 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.235 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表9.236 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表9.237 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.238 その他の引数 (オプション):

概要

--node <node>

このノードのポートグループ (名前または UUID) のみを一覧表示します。

--address <mac-address>

この mac アドレスのポートグループに関する情報のみを表示します。

--long

ポートグループの詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のポートグループフィールド。これらのフィールドのみがサーバーから取得されます。-- long が指定されている場合は使用できません。

--limit <limit>

要求ごとに返すポートグループの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <port group>

ポートグループの uuid (以前の要求リストにある最後のポートグループなど)。この UUID の後にポートグループの一覧を返します。

--sort <key>[:<direction>]

指定したポートグループのフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

-h, --help

ヘルプメッセージを表示して終了します。

9.67. 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>

表9.239 位置引数

概要

<port group>

ポートグループの名前または UUID。

表9.240 その他の引数 (オプション):

概要

--support-standalone-ports

このポートグループのメンバーであるポートは、スタンドアロンのポートとして使用できます。

--extra <key=value>

このベアメタルポートグループに設定する追加項目 (複数の項目を設定する場合はオプションを繰り返し使用します)

--address <mac-address>

このポートグループの MAC アドレス。

--unsupport-standalone-ports

このポートグループのメンバーであるポートは、スタンドアロンのポートとしては使用できません。

--property <key=value>

このポートグループの設定に関連するキー/値プロパティー (複数のプロパティーを設定する場合は、オプションを繰り返し使用します)。

--mode MODE

ポートグループのモード。使用できる値は https://www.kernel.org/doc/Documentation/networking/bo nding.txt を参照してください。

--name <name>

ポートグループの名前。

-h, --help

ヘルプメッセージを表示して終了します。

--node <uuid>

このポートグループが属するノードの uuid を更新します。

9.68. baremetal port group show

ベアメタルポートグループの詳細を表示します。

使用方法

openstack baremetal port group show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--address]
                                           [--fields <field> [<field> ...]]
                                           <id>

表9.241 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.242 位置引数

概要

<id>

ポートグループの UUID または名前 (または --address が指定されている場合は mac アドレス)。

表9.243 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.244 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.245 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--address

<id> は、ポートグループの mac アドレス (uuid または name ではなく) です。

--fields <field> [<field> …​]

1 つ以上のポートグループフィールド。これらのフィールドのみがサーバーから取得されます。

表9.246 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.69. baremetal port group unset

ベアメタルポートグループプロパティーの設定を解除します。

使用方法

openstack baremetal port group unset [-h] [--name] [--address]
                                            [--extra <key>] [--property <key>]
                                            <port group>

表9.247 位置引数

概要

<port group>

ポートグループの名前または UUID。

表9.248 その他の引数 (オプション):

概要

--property <key>

このベアメタルポートグループで設定を解除するプロパティー (複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します)

--name

ポートグループの名前の設定を解除します。

-h, --help

ヘルプメッセージを表示して終了します。

--address

ポートグループのアドレスを解除します。

--extra <key>

このベアメタルポートグループで追加で設定を解除する項目 (複数の項目の設定を解除する場合はオプションを繰り返し使用します)

9.70. baremetal port list

ベアメタルポートを一覧表示します。

使用方法

openstack baremetal port list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--address <mac-address>] [--node <node>]
                                     [--port-group <port group>]
                                     [--limit <limit>] [--marker <port>]
                                     [--sort <key>[:<direction>]]
                                     [--long | --fields <field> [<field> ...]]

表9.249 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.250 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表9.251 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表9.252 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.253 その他の引数 (オプション):

概要

--node <node>

このノードのポート (名前または UUID) のみを一覧表示します。

--address <mac-address>

この mac アドレスのポートに関する情報のみを表示します。

--marker <port>

ポート uuid(以前の要求リストにある最後のポートなど)。この UUID の後にポートの一覧を返します。

--long

ポートの詳細情報を表示します。

--port-group <port group>

このポートグループのポートのみを一覧表示します (名前または UUID)。

--limit <limit>

要求ごとに返すポートの最大数。0 は制限なしです。デフォルトは、Ironic API サービスが使用する最大数です。

--fields <field> [<field> …​]

1 つ以上のポートフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

--sort <key>[:<direction>]

指定したポートフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

-h, --help

ヘルプメッセージを表示して終了します。

9.71. 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>]
                                    <port>

表9.254 位置引数

概要

<port>

ポートの UUID

表9.255 その他の引数 (オプション):

概要

--pxe-enabled

このノードの PXE の起動時にこのポートを使用するかどうかを指定します。

--extra <key=value>

このベアメタルポートグループに設定する追加項目 (複数の項目を設定する場合はオプションを繰り返し使用します)

--pxe-disabled

このノードの PXE の起動時にこのポートを使用しないように指定します。

--port-group <uuid>

このポートが属するポートグループの uuid を設定します。

--local-link-connection <key=value>

ローカルリンク接続情報を記述するキー/値のメタデータ。有効なキーは switch_infoswitch_id、および port_id です。switch_idport_id キーは必須です。複数回指定できます。

--physical-network <physical network>

このポートを接続する物理ネットワークの名前を設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--node <uuid>

このポートが属するノードの uuid を設定します。

--address <address>

このポートの mac アドレスを設定します。

9.72. baremetal port show

ベアメタルポートの詳細を表示します。

使用方法

openstack baremetal port show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--address]
                                     [--fields <field> [<field> ...]]
                                     <id>

表9.256 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.257 位置引数

概要

<id>

ポートの UUID(--address が指定されている場合は mac アドレス)。

表9.258 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.259 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.260 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--address

<id> はポートの (uuid ではなく)mac アドレスです。

--fields <field> [<field> …​]

1 つ以上のポートフィールド。これらのフィールドのみがサーバーから取得されます。

表9.261 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.73. baremetal port unset

ベアメタルポートのプロパティーの設定を解除します。

使用方法

openstack baremetal port unset [-h] [--extra <key>] [--port-group]
                                      [--physical-network]
                                      <port>

表9.262 位置引数

概要

<port>

ポートの UUID

表9.263 その他の引数 (オプション):

概要

--port-group

ポートグループからポートを削除します。

-h, --help

ヘルプメッセージを表示して終了します。

--extra <key>

このベアメタルポートの設定を追加で解除する項目 (複数のプロパティーを設定する場合はオプションを繰り返し使用します)

--physical-network

このベアメタルポートで物理ネットワークの設定を解除します。

9.74. baremetal volume connector create

新しいベアメタルのボリュームコネクターを作成します。

使用方法

openstack baremetal volume connector create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX] --node
                                                   <uuid> --type <type>
                                                   --connector-id <connector
                                                   id> [--uuid <uuid>]
                                                   [--extra <key=value>]

表9.264 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.265 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.266 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.267 その他の引数 (オプション):

概要

--node <uuid>

このボリュームコネクターが属するノードの UUID。

--uuid <uuid>

ボリュームコネクターの UUID。

--type <type>

ボリュームコネクターの種類。iqnipmacwwnnwwpnportportgroup

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

-h, --help

ヘルプメッセージを表示して終了します。

--connector-id <connector id>

指定のタイプのボリュームコネクター ID。たとえば、タイプが iqn の場合は、ノードの iSCSI イニシエーター IQN。

表9.268 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.75. baremetal volume connector delete

ベアメタルボリュームコネクターの登録を解除します。

使用方法

openstack baremetal volume connector delete [-h]
                                                   <volume connector>
                                                   [<volume connector> ...]

表9.269 位置引数

概要

<volume connector>

削除するボリュームコネクターの UUID

表9.270 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.76. baremetal volume connector list

ベアメタルボリュームコネクターを一覧表示します。

使用方法

openstack baremetal volume connector list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]
                                                 [--node <node>]
                                                 [--limit <limit>]
                                                 [--marker <volume connector>]
                                                 [--sort <key>[:<direction>]]
                                                 [--long | --fields <field> [<field> ...]]

表9.271 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.272 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表9.273 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表9.274 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.275 その他の引数 (オプション):

概要

--node <node>

このノードのボリュームコネクター (名前または UUID) のみを一覧表示します。

--long

ボリュームコネクターの詳細情報を表示します。

--limit <limit>

要求ごとに返すボリュームの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--fields <field> [<field> …​]

1 つ以上のボリュームコネクターフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

--sort <key>[:<direction>]

指定したボリュームコネクターのフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

-h, --help

ヘルプメッセージを表示して終了します。

--marker <volume connector>

ボリュームコネクター UUID(以前の要求リストにある最後のボリュームコネクターなど)。この UUID の後にボリュームコネクターの一覧を返します。

9.77. baremetal volume connector set

ベアメタルボリュームコネクタープロパティーを設定します。

使用方法

openstack baremetal volume connector set [-h] [--node <uuid>]
                                                [--type <type>]
                                                [--connector-id <connector id>]
                                                [--extra <key=value>]
                                                <volume connector>

表9.276 位置引数

概要

<volume connector>

ボリュームコネクターの UUID。

表9.277 その他の引数 (オプション):

概要

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--type <type>

ボリュームコネクターの種類。iqnipmacwwnnwwpnportportgroup

-h, --help

ヘルプメッセージを表示して終了します。

--node <uuid>

このボリュームコネクターが属するノードの UUID。

--connector-id <connector id>

指定したタイプのボリュームコネクターの ID。

9.78. baremetal volume connector show

ベアメタルボリュームコネクターの詳細を表示します。

使用方法

openstack baremetal volume connector show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 [--fields <field> [<field> ...]]
                                                 <id>

表9.278 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.279 位置引数

概要

<id>

ボリュームコネクターの UUID。

表9.280 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.281 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.282 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のボリュームコネクターフィールド。これらのフィールドのみがサーバーから取得されます。

表9.283 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.79. baremetal volume connector unset

ベアメタルボリュームコネクタープロパティーの設定を解除します。

使用方法

openstack baremetal volume connector unset [-h] [--extra <key>]
                                                  <volume connector>

表9.284 位置引数

概要

<volume connector>

ボリュームコネクターの UUID。

表9.285 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--extra <key>

設定を解除する追加項目 (複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。)

9.80. baremetal volume target create

新しいベアメタルのボリュームターゲットを作成します。

使用方法

openstack baremetal volume target create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                --node <uuid> --type <volume
                                                type> [--property <key=value>]
                                                --boot-index <boot index>
                                                --volume-id <volume id>
                                                [--uuid <uuid>]
                                                [--extra <key=value>]

表9.286 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.287 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.288 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.289 その他の引数 (オプション):

概要

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--uuid <uuid>

ボリュームターゲットの UUID

--property <key=value>

このボリュームターゲットのタイプに関連するキー/値プロパティー。複数回指定できます。

--boot-index <boot index>

ボリュームターゲットのブートインデックス。

--type <volume type>

ボリュームターゲットのタイプ (例:iscsifibre_channel )。

-h, --help

ヘルプメッセージを表示して終了します。

--volume-id <volume id>

このターゲットに関連付けられたボリュームの ID。

--node <uuid>

このボリュームターゲットが属するノードの UUID。

表9.290 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.81. baremetal volume target delete

ベアメタルボリュームのターゲットの登録を解除します。

使用方法

openstack baremetal volume target delete [-h]
                                                <volume target>
                                                [<volume target> ...]

表9.291 位置引数

概要

<volume target>

削除するボリュームターゲットの UUID。

表9.292 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

9.82. baremetal volume target list

ベアメタルボリュームターゲットを一覧表示します。

使用方法

openstack baremetal volume target list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]
                                              [--node <node>]
                                              [--limit <limit>]
                                              [--marker <volume target>]
                                              [--sort <key>[:<direction>]]
                                              [--long | --fields <field> [<field> ...]]

表9.293 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.294 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表9.295 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表9.296 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.297 その他の引数 (オプション):

概要

--node <node>

このノードのボリュームターゲット (名前または UUID) のみを一覧表示します。

--marker <volume target>

ボリュームターゲットの uuid(以前の要求リストにある最後のボリュームターゲットなど)。UUID の後にボリュームターゲットの一覧を返します。

--long

ボリュームターゲットの詳細情報を表示します。

--limit <limit>

要求ごとに返すボリュームターゲットの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--fields <field> [<field> …​]

1 つ以上のボリュームターゲットフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

--sort <key>[:<direction>]

指定したボリュームターゲットのフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

-h, --help

ヘルプメッセージを表示して終了します。

9.83. 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>

表9.298 位置引数

概要

<volume target>

ボリュームターゲットの UUID

表9.299 その他の引数 (オプション):

概要

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--property <key=value>

このボリュームターゲットのタイプに関連するキー/値プロパティー。複数回指定できます。

--boot-index <boot index>

ボリュームターゲットのブートインデックス。

--type <volume type>

ボリュームターゲットのタイプ (例:iscsifibre_channel )。

-h, --help

ヘルプメッセージを表示して終了します。

--volume-id <volume id>

このターゲットに関連付けられたボリュームの ID。

--node <uuid>

このボリュームターゲットが属するノードの UUID。

9.84. baremetal volume target show

ベアメタルボリュームのターゲットの詳細を表示します。

使用方法

openstack baremetal volume target show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--fields <field> [<field> ...]]
                                              <id>

表9.300 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表9.301 位置引数

概要

<id>

ボリュームターゲットの UUID

表9.302 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表9.303 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表9.304 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のボリュームターゲットフィールド。これらのフィールドのみがサーバーから取得されます。

表9.305 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

9.85. baremetal volume target unset

ベアメタルボリュームのターゲットプロパティーの設定を解除します。

使用方法

openstack baremetal volume target unset [-h] [--extra <key>]
                                               [--property <key>]
                                               <volume target>

表9.306 位置引数

概要

<volume target>

ボリュームターゲットの UUID

表9.307 その他の引数 (オプション):

概要

--property <key>

このベアメタルボリュームターゲットで設定を解除するプロパティー (複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

--extra <key>

設定を解除する追加項目 (複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。)

第10章 bgp

本章では、bgp コマンドに含まれるコマンドについて説明します。

10.1. bgp dragent add speaker

BGP スピーカーを動的ルーティングエージェントに追加します。

使用方法

openstack bgp dragent add speaker [-h] <agent-id> <bgp-speaker>

表10.1 位置引数

概要

<agent-id>

動的ルーティングエージェントの ID

<bgp-speaker>

bgp スピーカーの ID または名前

表10.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

10.2. bgp dragent remove speaker

動的ルーティングエージェントから BGP スピーカーを削除します。

使用方法

openstack bgp dragent remove speaker [-h] <agent-id> <bgp-speaker>

表10.3 位置引数

概要

<agent-id>

動的ルーティングエージェントの ID

<bgp-speaker>

bgp スピーカーの ID または名前

表10.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

10.3. bgp peer create

BGP ピアを作成します。

使用方法

openstack bgp peer create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX] --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>

表10.5 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表10.6 位置引数

概要

<name>

作成する bgp ピアの名前

表10.7 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表10.8 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表10.9 その他の引数 (オプション):

概要

--remote-as <peer-remote-as>

数字で表現したピア ([1, 65535] の整数を使用可能)

--auth-type <peer-auth-type>

認証アルゴリズム。サポートされるアルゴリズム:none(デフォルト)、md5

--peer-ip <peer-ip-address>

ピアの IP アドレス

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--password <auth-password>

認証パスワード

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト (名前または ID)

表10.10 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

10.4. bgp peer delete

BGP ピアを削除します。

使用方法

openstack bgp peer delete [-h] <bgp-peer>

表10.11 位置引数

概要

<bgp-peer>

削除する BGP ピア (名前または ID)

表10.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

10.5. bgp peer list

BGP ピアを一覧表示します。

使用方法

openstack bgp peer list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--sort-column SORT_COLUMN]

表10.13 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表10.14 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表10.15 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表10.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表10.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

10.6. bgp peer set

BGP ピアを更新します。

使用方法

openstack bgp peer set [-h] [--name NAME] [--password <auth-password>]
                              <bgp-peer>

表10.18 位置引数

概要

<bgp-peer>

更新する BGP ピア (名前または ID)

表10.19 その他の引数 (オプション):

概要

--password <auth-password>

更新する認証パスワード

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

更新する Bgp ピア名

10.7. bgp peer show

BGP ピアの情報を表示します。

使用方法

openstack bgp peer show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]
                               <bgp-peer>

表10.20 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表10.21 位置引数

概要

<bgp-peer>

表示する BGP ピア (名前または ID)

表10.22 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表10.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表10.24 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表10.25 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

10.8. bgp speaker add network

BGP スピーカーにネットワークを追加します。

使用方法

openstack bgp speaker add network [-h] <bgp-speaker> <network>

表10.26 位置引数

概要

<bgp-speaker>

BGP スピーカー (名前または ID)

<network>

追加するネットワーク (名前または ID)

表10.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

10.9. bgp speaker add peer

BGP スピーカーにピアを追加します。

使用方法

openstack bgp speaker add peer [-h] <bgp-speaker> <bgp-peer>

表10.28 位置引数

概要

<bgp-peer>

追加する BGP ピア (名前または ID)

<bgp-speaker>

BGP スピーカー (名前または ID)

表10.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

10.10. bgp speaker create

BGP スピーカーを作成します。

使用方法

openstack bgp speaker create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX] --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>

表10.30 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表10.31 位置引数

概要

<name>

作成する bgp スピーカーの名前

表10.32 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表10.33 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表10.34 その他の引数 (オプション):

概要

--no-advertise-floating-ip-host-routes

BGP スピーカーにより Floating IP ホストルートの広告を無効にします。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--no-advertise-tenant-networks

BGP スピーカーによりテナントネットワークルートの広告を無効にします。

--ip-version {4,6}

Bgp スピーカーの IP バージョン (デフォルトは 4)

--advertise-floating-ip-host-routes

BGP スピーカーにより Floating IP ホストルートの広告を有効にします (デフォルト)。

--local-as <local-as>

数字で表現したローカル ([1, 65535] の整数を使用可能)

--advertise-tenant-networks

BGP スピーカーによりテナントネットワークルートの広告を有効にします (デフォルト)。

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト (名前または ID)

表10.35 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

10.11. bgp speaker delete

BGP スピーカーを削除します。

使用方法

openstack bgp speaker delete [-h] <bgp-speaker>

表10.36 位置引数

概要

<bgp-speaker>

削除する BGP スピーカー (名前または ID)

表10.37 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

10.12. bgp speaker list advertised routes

広告されるルートを一覧表示します。

使用方法

openstack bgp speaker list advertised routes [-h]
                                                    [-f {csv,json,table,value,yaml}]
                                                    [-c COLUMN]
                                                    [--max-width <integer>]
                                                    [--fit-width]
                                                    [--print-empty]
                                                    [--noindent]
                                                    [--quote {all,minimal,none,nonnumeric}]
                                                    [--sort-column SORT_COLUMN]
                                                    <bgp-speaker>

表10.38 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表10.39 位置引数

概要

<bgp-speaker>

BGP スピーカー (名前または ID)

表10.40 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表10.41 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表10.42 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表10.43 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

10.13. bgp speaker list

BGP スピーカーを一覧表示します。

使用方法

openstack bgp speaker list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]
                                  [--agent <agent-id>]

表10.44 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表10.45 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表10.46 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表10.47 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表10.48 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--agent <agent-id>

エージェントがホストする bgp スピーカーの一覧を表示します (ID のみ)

10.14. bgp speaker remove network

BGP スピーカーからのネットワークを削除します。

使用方法

openstack bgp speaker remove network [-h] <bgp-speaker> <network>

表10.49 位置引数

概要

<bgp-speaker>

BGP スピーカー (名前または ID)

<network>

削除するネットワーク (名前または ID)

表10.50 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

10.15. bgp speaker remove peer

BGP スピーカーからのピアを削除します。

使用方法

openstack bgp speaker remove peer [-h] <bgp-speaker> <bgp-peer>

表10.51 位置引数

概要

<bgp-peer>

削除する BGP ピア (名前または ID)

<bgp-speaker>

BGP スピーカー (名前または ID)

表10.52 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

10.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>

表10.53 位置引数

概要

<bgp-speaker>

更新する BGP スピーカー (名前または ID)

表10.54 その他の引数 (オプション):

概要

--no-advertise-floating-ip-host-routes

BGP スピーカーにより Floating IP ホストルートの広告を無効にします。

--no-advertise-tenant-networks

BGP スピーカーによりテナントネットワークルートの広告を無効にします。

--advertise-floating-ip-host-routes

BGP スピーカーにより Floating IP ホストルートの広告を有効にします (デフォルト)。

--name NAME

更新する bgp スピーカー名

--advertise-tenant-networks

BGP スピーカーによりテナントネットワークルートの広告を有効にします (デフォルト)。

-h, --help

ヘルプメッセージを表示して終了します。

10.17. bgp speaker show dragents

BGP スピーカーをホストする動的ルーティングエージェントを一覧で表示します。

使用方法

openstack bgp speaker show dragents [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           <bgp-speaker>

表10.55 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表10.56 位置引数

概要

<bgp-speaker>

bgp スピーカーの ID または名前

表10.57 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表10.58 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表10.59 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表10.60 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

10.18. bgp speaker show

BGP スピーカーを表示します。

使用方法

openstack bgp speaker show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  <bgp-speaker>

表10.61 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表10.62 位置引数

概要

<bgp-speaker>

表示する BGP スピーカー (名前または ID)

表10.63 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表10.64 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表10.65 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表10.66 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第11章 bgpvpn

本章では、bgpvpn コマンドに含まれるコマンドについて説明します。

11.1. bgpvpn create

BGP VPN リソースを作成します。

使用方法

openstack bgpvpn create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] [--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] [--type {l2,l3}]

表11.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表11.2 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.4 その他の引数 (オプション):

概要

--name <name>

Bgp vpn の名前

--route-distinguisher <route-distinguisher>

Route Distinguisher を選択して VPN ルートを広告する一覧に Route Distinguisher を追加します (Route Distinguisher を複数指定するには、オプションを繰り返し使用します)。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--vni VNI

VXLAN カプセル化を使用する場合は、この bgpvpn に使用する VXLAN ネットワーク ID

--import-target <import-target>

インポートするルートターゲットを追加します (複数のルートターゲットを指定する場合はオプションを繰り返します)。

--route-target <route-target>

インポート/エクスポートリストにルートターゲットを追加します (複数のルートターゲットを指定する場合はオプションを繰り返します)

--type {l2,l3}

ip vpn (l3) と Ethernet VPN (l2) の間の Bgp vpn タイプの選択 (デフォルト: l3)

-h, --help

ヘルプメッセージを表示して終了します。

--export-target <export-target>

エクスポートリストにルートターゲットを追加します (複数のルートターゲットを指定する場合はオプションを繰り返します)

--project <project>

所有者のプロジェクト (名前または ID)

表11.5 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

11.2. bgpvpn delete

BGP VPN リソースを削除します。

使用方法

openstack bgpvpn delete [-h] <bgpvpn> [<bgpvpn> ...]

表11.6 位置引数

概要

<bgpvpn>

削除する BGP vpn (名前または ID)

表11.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.3. bgpvpn list

BGP VPN リソースを一覧表示します。

使用方法

openstack bgpvpn list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--project <project>]
                             [--project-domain <project-domain>] [--long]
                             [--property <key=value>]

表11.8 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表11.9 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.10 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.12 その他の引数 (オプション):

概要

--property <key=value>

返された bgp vpns に適用する filter プロパティー (複数のプロパティーで絞り込むには繰り返し指定します)

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト (名前または ID)

--long

出力の追加フィールドを一覧表示します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

11.4. bgpvpn network association create

BGP VPN ネットワークの関連付けを作成します。

使用方法

openstack bgpvpn network association create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX]
                                                   [--project <project>]
                                                   [--project-domain <project-domain>]
                                                   <bgpvpn> <network>

表11.13 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表11.14 位置引数

概要

<bgpvpn>

ネットワークの関連付け (名前または ID) を適用する BGP vpn

<network>

Bgp vpn(名前または ID) を関連付けるネットワーク

表11.15 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト (名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表11.18 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

11.5. bgpvpn network association delete

特定の BGP VPN の BGP VPN ネットワーク関連付けを削除します。

使用方法

openstack bgpvpn network association delete [-h]
                                                   <network association ID>
                                                   [<network association ID> ...]
                                                   <bgpvpn>

表11.19 位置引数

概要

<network association ID>

削除するネットワークの関連付け ID

<bgpvpn>

ネットワークの関連付けが所属する BGP vpn(名前または ID)

表11.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.6. bgpvpn network association list

特定の BGP VPN の BGP VPN ネットワーク関連付けを一覧で表示します。

使用方法

openstack bgpvpn network association list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]
                                                 [--long]
                                                 [--property <key=value>]
                                                 <bgpvpn>

表11.21 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表11.22 位置引数

概要

<bgpvpn>

記載の関連付けが (名前または ID) 所属する bgp vpn

表11.23 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.24 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key=value>

返された bgp vpns に適用する filter プロパティー (複数のプロパティーで絞り込むには繰り返し指定します)

--long

出力の追加フィールドを一覧表示します。

11.7. bgpvpn network association show

特定の BGP VPN ネットワーク関連付けの情報を表示します。

使用方法

openstack bgpvpn network association show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 <network association ID>
                                                 <bgpvpn>

表11.27 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表11.28 位置引数

概要

<network association ID>

検索するネットワークの関連付け ID

<bgpvpn>

この関連付けが所属する BGP vpn(名前または ID)

表11.29 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.30 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.31 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.32 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

11.8. bgpvpn port association create

BGP VPN ポートの関連付けを作成します。

使用方法

openstack bgpvpn port association create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                [--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>

表11.33 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表11.34 位置引数

概要

<bgpvpn>

ポートの関連付け (名前または ID) を適用する BGP vpn

<port>

Bgp vpn(名前または ID) を関連付けるポート

表11.35 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.36 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.37 その他の引数 (オプション):

概要

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

ルートリークの bgp vpn ルートを追加します。オプションで、広告されるルートの BGP LOCAL_PREF の値を制御できます (複数の BGP VPN ルートのオプション)。

--no-advertise-fixed-ips

ポートの固定 IP が BGP VPN に広告されません。

--prefix-route prefix=<cidr>[,local_pref=<integer>]

Cidr 表記で接頭辞ルートを追加します。オプションで、広告されるルートの BGP LOCAL_PREF の値を制御できます (複数の接頭辞ルートのオプション)。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--advertise-fixed-ips

ポートの固定 ip が bgp VPN に広告されます (デフォルト)。

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト (名前または ID)

表11.38 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

11.9. bgp shared port association delete

特定の BGP VPN の BGP VPN ポートの関連付けを削除します。

使用方法

openstack bgpvpn port association delete [-h]
                                                <port association ID>
                                                [<port association ID> ...]
                                                <bgpvpn>

表11.39 位置引数

概要

<bgpvpn>

ポートの関連付けが属する bgp vpn(名前または ID)

<port association ID>

削除するポート関連 ID

表11.40 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.10. bgpvpn port association list

特定の BGP VPN の BGP VPN ポートの関連付けを一覧で表示します。

使用方法

openstack bgpvpn port association list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]
                                              [--long]
                                              [--property <key=value>]
                                              <bgpvpn>

表11.41 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表11.42 位置引数

概要

<bgpvpn>

記載の関連付けが (名前または ID) 所属する bgp vpn

表11.43 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.44 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.45 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.46 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key=value>

返された bgp vpns に適用する filter プロパティー (複数のプロパティーで絞り込むには繰り返し指定します)

--long

出力の追加フィールドを一覧表示します。

11.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>

表11.47 位置引数

概要

<bgpvpn>

ポートの関連付けが属する bgp vpn(名前または ID)

<port association ID>

更新するポート関連付け ID

表11.48 その他の引数 (オプション):

概要

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

ルートリークの bgp vpn ルートを追加します。オプションで、広告されるルートの BGP LOCAL_PREF の値を制御できます (複数の BGP VPN ルートのオプション)。

--no-advertise-fixed-ips

ポートの固定 IP が BGP VPN に広告されません。

--prefix-route prefix=<cidr>[,local_pref=<integer>]

Cidr 表記で接頭辞ルートを追加します。オプションで、広告されるルートの BGP LOCAL_PREF の値を制御できます (複数の接頭辞ルートのオプション)。

--no-bgpvpn-route

Empty bgp vpn route list

--no-prefix-route

空のプリフィックスルート一覧

--advertise-fixed-ips

ポートの固定 ip が bgp VPN に広告されます。

-h, --help

ヘルプメッセージを表示して終了します。

11.12. bgp shared port association show

特定の BGP VPN ポートの関連付けの情報を表示します。

使用方法

openstack bgpvpn port association show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              <port association ID> <bgpvpn>

表11.49 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表11.50 位置引数

概要

<bgpvpn>

この関連付けが所属する BGP vpn(名前または ID)

<port association ID>

検索対象のポートの関連付け ID

表11.51 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.52 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.53 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.54 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

11.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>

表11.55 位置引数

概要

<bgpvpn>

ポートの関連付けが属する bgp vpn(名前または ID)

<port association ID>

更新するポート関連付け ID

表11.56 その他の引数 (オプション):

概要

--all-prefix-routes

空のプリフィックスルート一覧

--no-advertise-fixed-ips

ポートの固定 ip が bgp VPN に広告されます。

--prefix-route <cidr>

Cidr 表記の接頭辞ルートを削除します (複数の接頭辞ルートを指定するにはオプションを繰り返し使用します)。

--all-bgpvpn-routes

Empty bgp vpn route list

--advertise-fixed-ips

ポートの固定 IP が BGP VPN に広告されません。

-h, --help

ヘルプメッセージを表示して終了します。

--bgpvpn-route <BGP VPN ID or name>

Bgp vpn ルートを削除します (複数の bgp VPN ルートの場合はオプションを繰り返し使用します)。

11.14. bgpvpn router association create

BGP VPN ルーターの関連付けを作成します。

使用方法

openstack bgpvpn router association create [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--project <project>]
                                                  [--project-domain <project-domain>]
                                                  <bgpvpn> <router>

表11.57 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表11.58 位置引数

概要

<bgpvpn>

ルーターの関連付け (名前または ID) を適用する BGP vpn

<router>

Bgp vpn(名前または ID) を関連付けるルーター

表11.59 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.60 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.61 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト (名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表11.62 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

11.15. bgpvpn router association delete

特定の BGP VPN の BGP VPN ルーターの関連付けを削除します。

使用方法

openstack bgpvpn router association delete [-h]
                                                  <router association ID>
                                                  [<router association ID> ...]
                                                  <bgpvpn>

表11.63 位置引数

概要

<bgpvpn>

ルーターの関連付けが所属する bgp vpn(名前または ID)

<router association ID>

削除するルーターの関連付け ID

表11.64 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.16. bgpvpn router association list

特定の BGP VPN の BGP VPN ルーターの関連付けを一覧表示します。

使用方法

openstack bgpvpn router association list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--sort-column SORT_COLUMN]
                                                [--long]
                                                [--property <key=value>]
                                                <bgpvpn>

表11.65 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表11.66 位置引数

概要

<bgpvpn>

記載の関連付けが (名前または ID) 所属する bgp vpn

表11.67 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.68 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.69 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.70 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key=value>

返された bgp vpns に適用する filter プロパティー (複数のプロパティーで絞り込むには繰り返し指定します)

--long

出力の追加フィールドを一覧表示します。

11.17. bgpvpn router association show

特定の BGP VPN ルーターの関連付けの情報を表示します。

使用方法

openstack bgpvpn router association show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                <router association ID>
                                                <bgpvpn>

表11.71 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表11.72 位置引数

概要

<bgpvpn>

この関連付けが所属する BGP vpn(名前または ID)

<router association ID>

検索するルーターの関連付け ID

表11.73 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.74 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.75 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.76 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

11.18. 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]
                            <bgpvpn>

表11.77 位置引数

概要

<bgpvpn>

更新する BGP vpn(名前または ID)

表11.78 その他の引数 (オプション):

概要

--no-route-target

空のルートターゲット一覧

--name <name>

Bgp vpn の名前

--route-distinguisher <route-distinguisher>

Route Distinguisher を選択して VPN ルートを広告する一覧に Route Distinguisher を追加します (Route Distinguisher を複数指定するには、オプションを繰り返し使用します)。

--no-route-distinguisher

空の route distinguisher 一覧

--no-export-target

空のエクスポートルートターゲット一覧

--no-import-target

空のインポートルートターゲット一覧

--vni VNI

VXLAN カプセル化を使用する場合は、この bgpvpn に使用する VXLAN ネットワーク ID

--import-target <import-target>

インポートするルートターゲットを追加します (複数のルートターゲットを指定する場合はオプションを繰り返します)。

--route-target <route-target>

インポート/エクスポートリストにルートターゲットを追加します (複数のルートターゲットを指定する場合はオプションを繰り返します)

-h, --help

ヘルプメッセージを表示して終了します。

--export-target <export-target>

エクスポートリストにルートターゲットを追加します (複数のルートターゲットを指定する場合はオプションを繰り返します)

11.19. bgpvpn show

特定の BGP VPN の情報を表示します。

使用方法

openstack bgpvpn show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             <bgpvpn>

表11.79 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表11.80 位置引数

概要

<bgpvpn>

表示する BGP vpn(名前または ID)

表11.81 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.82 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.83 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.84 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

11.20. 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]
                              <bgpvpn>

表11.85 位置引数

概要

<bgpvpn>

更新する BGP vpn(名前または ID)

表11.86 その他の引数 (オプション):

概要

--all-route-target

空のルートターゲット一覧

--route-target <route-target>

インポート/エクスポートリストからルートターゲットを削除します (複数のルートターゲットを指定する場合はオプションを繰り返します)。

--route-distinguisher <route-distinguisher>

Route Distinguisher を選択して VPN ルートを広告する一覧から Route Distinguisher を削除します (Route Distinguisher を複数指定するには、オプションを繰り返し使用します)。

--all-export-target

空のエクスポートルートターゲット一覧

--all-import-target

空のインポートルートターゲット一覧

--vni VNI

VXLAN カプセル化を使用する場合は、この bgpvpn に使用する VXLAN ネットワーク ID

--import-target <import-target>

インポート一覧からルートターゲットを削除します (複数のルートターゲットを指定する場合はオプションを繰り返します)。

-h, --help

ヘルプメッセージを表示して終了します。

--export-target <export-target>

エクスポートリストからルートターゲットを削除します (複数のルートターゲットを指定する場合はオプションを繰り返します)。

--all-route-distinguisher

空の route distinguisher 一覧

第12章 ca

本章では、ca コマンドに含まれるコマンドについて説明します。

12.1. ca get

URI を指定して CA を取得します。

使用方法

openstack ca get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                        [--max-width <integer>] [--fit-width] [--print-empty]
                        [--noindent] [--prefix PREFIX]
                        URI

表12.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表12.2 位置引数

概要

URI

Ca の URI 参照。

表12.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表12.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表12.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表12.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

12.2. ca list

CA を一覧表示します。

使用方法

openstack ca list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                         [--max-width <integer>] [--fit-width] [--print-empty]
                         [--noindent] [--quote {all,minimal,none,nonnumeric}]
                         [--sort-column SORT_COLUMN] [--limit LIMIT]
                         [--offset OFFSET] [--name NAME]

表12.7 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表12.8 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表12.9 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表12.10 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表12.11 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit LIMIT, -l LIMIT

ページごとに表示する項目数に制限を指定します (デフォルト:10、最大: 100)。

--name NAME, -n NAME

Ca 名を指定します (デフォルト:none)。

--offset OFFSET, -o OFFSET

ページのオフセットを指定します (デフォルト:0)。

第13章 catalog

本章では、catalog コマンドに含まれるコマンドについて説明します。

13.1. catalog list

サービスカタログのサービスを一覧表示します。

使用方法

openstack catalog list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN]

表13.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表13.2 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表13.3 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表13.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表13.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

13.2. catalog show

サービスカタログの詳細を表示します。

使用方法

openstack catalog show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX]
                              <service>

表13.6 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表13.7 位置引数

概要

<service>

表示するサービス (タイプまたは名前)

表13.8 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表13.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表13.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表13.11 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第14章 coe

本章では、coe コマンドに含まれるコマンドについて説明します。

14.1. coe ca rotate

クラスターがアクセスを取り消すために CA 証明書をローテーションします。

使用方法

openstack coe ca rotate [-h] <cluster>

表14.1 位置引数

概要

<cluster>

クラスターの ID または名前

表14.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

14.2. coe ca show

クラスターの CA 証明書の詳細を表示します。

使用方法

openstack coe ca show [-h] <cluster>

表14.3 位置引数

概要

<cluster>

クラスターの ID または名前

表14.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

14.3. coe ca sign

クラスターの CA 証明書を生成します。

使用方法

openstack coe ca sign [-h] <cluster> <csr>

表14.5 位置引数

概要

<cluster>

クラスターの ID または名前

<csr>

署名を取得するために magnum に送信する csr ファイルのファイルパス。

表14.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

14.4. coe cluster config

クラスターの設定を取得します。

使用方法

openstack coe cluster config [-h] [--dir <dir>] [--force] <cluster>

表14.7 位置引数

概要

<cluster>

更新するクラスターの名前または UUID

表14.8 その他の引数 (オプション):

概要

--force

ファイルが存在する場合には、ファイルを上書きします。

-h, --help

ヘルプメッセージを表示して終了します。

--dir <dir>

証明書と設定ファイルを保存するディレクトリー。

14.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>

表14.9 位置引数

概要

<name>

作成するクラスターの名前。

表14.10 その他の引数 (オプション):

概要

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

クラスターテンプレートに関連付ける key=valuepairs 形式の任意のラベル。複数回の使用が可能です。

--discovery-url <discovery-url>

ノード検出用のカスタム配信 URL を指定します。

--cluster-template <cluster-template>

クラスターテンプレートの ID または名前

--master-flavor <master-flavor>

クラスターのマスターノードを起動する時に使用する nova フレーバーの名前または UUID。

--timeout <timeout>

クラスター作成時間のタイムアウト。デフォルトは 60 分です。

--flavor <flavor>

クラスターの起動時に使用する nova フレーバーの名前または UUID。

--master-count <master-count>

クラスターのマスターノードの数。

--keypair <keypair>

使用するキーペアの UUID または名前。

-h, --help

ヘルプメッセージを表示して終了します。

--docker-volume-size <docker-volume-size>

Docker ボリュームが使用するサイズ (gb 単位)。

--node-count <node-count>

クラスターノードの数。

14.6. coe cluster delete

クラスターを削除します。

使用方法

openstack coe cluster delete [-h] <cluster> [<cluster> ...]

表14.11 位置引数

概要

<cluster>

削除するクラスターの ID または名前。

表14.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

14.7. coe cluster list

クラスターを一覧表示します。

使用方法

openstack coe cluster list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]
                                  [--limit <limit>] [--sort-key <sort-key>]
                                  [--sort-dir <sort-dir>]

表14.13 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表14.14 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表14.15 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表14.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表14.17 その他の引数 (オプション):

概要

--limit <limit>

返すことのできるクラスターの最大数。

-h, --help

ヘルプメッセージを表示して終了します。

--sort-key <sort-key>

結果を並べ替えるコラム

--sort-dir <sort-dir>

ソートの方向。asc または desc。

14.8. coe cluster show

クラスターを表示します。

使用方法

openstack coe cluster show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  <cluster>

表14.18 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表14.19 位置引数

概要

<cluster>

表示するクラスターの ID または名前。

表14.20 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表14.21 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表14.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表14.23 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

14.9. coe cluster template create

クラスターテンプレートを作成します。

使用方法

openstack coe cluster template create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             --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>

表14.24 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表14.25 位置引数

概要

<name>

作成するクラスターテンプレートの名前。

表14.26 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表14.27 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表14.28 その他の引数 (オプション):

概要

--master-lb-enabled

作成したクラスターにマスターノードのロードバランサーがあるかどうかを指定します。

--fixed-subnet <fixed-subnet>

クラスターに接続するためのプライベート neutron サブネット名。

--fixed-network <fixed-network>

このクラスターモデルに接続するためのプライベート neutron ネットワーク名

--https-proxy <https-proxy>

クラスターのノードに使用する https_proxy アドレス。

--registry-enabled

クラスターでの docker レジストリーを有効化します。

--volume-driver <volume-driver>

コンテナーボリュームをインスタンス化するボリュームドライバー名。

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

クラスターテンプレートに関連付ける key=value ペアの形式の任意のラベル。複数回の使用が可能です。

--network-driver <network-driver>

コンテナーネットワークをインスタンス化するためのネットワークドライバー名。

--tls-disabled

クラスターの tls を無効にします。

--master-flavor <master-flavor>

クラスターのマスターノードを起動する時に使用する nova フレーバーの名前または UUID。

--floating-ip-enabled

作成したクラスターに Floating IP が必要であるかどうかを指定します。

-h, --help

ヘルプメッセージを表示して終了します。

--flavor <flavor>

クラスターの起動時に使用する nova フレーバーの名前または UUID。

--image <image>

クラスター用にカスタマイズするベースイメージの名前または UUID。

--external-network <external-network>

このクラスターテンプレートに接続するための外部 neutron ネットワーク名または uuid。

--coe <coe>

使用するコンテナーオーケストレーションエンジンを指定します。

--docker-storage-driver <docker-storage-driver>

Docker ストレージドライバーを選択します。サポートされているドライバー:devicemapper、overlay。デフォルト:devicemapper

--keypair <keypair>

クラスターノードに読み込む ssh キーペアの名前または UUID。

--public

クラスターテンプレートをパブリックにします。

--server-type <server-type>

Vm など、使用するサーバータイプを指定します。このリリースのデフォルトサーバータイプは vm です。

--http-proxy <http-proxy>

クラスターのノードに使用する http_proxy アドレス。

--no-proxy <no-proxy>

クラスターのノードに使用する no_proxy アドレス。

--docker-volume-size <docker-volume-size>

Docker ボリュームで使用するサイズを GB 単位で指定します。

--dns-nameserver <dns-nameserver>

このクラスターテンプレートに使用する dns ネームサーバー。

--floating-ip-disabled

新規クラスターでの Floating IP 作成を無効にします。

表14.29 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

14.10. coe cluster template delete

クラスターテンプレートを削除します。

使用方法

openstack coe cluster template delete [-h]
                                             <cluster-templates>
                                             [<cluster-templates> ...]

表14.30 位置引数

概要

<cluster-templates>

削除するクラスターテンプレートの ID または名前

表14.31 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

14.11. coe cluster template list

クラスターテンプレートを一覧表示します。

使用方法

openstack coe cluster template list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           [--limit <limit>]
                                           [--sort-key <sort-key>]
                                           [--sort-dir <sort-dir>]
                                           [--fields <fields>]

表14.32 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表14.33 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表14.34 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表14.35 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表14.36 その他の引数 (オプション):

概要

--fields <fields>

表示するフィールドのコンマ区切りリスト。uuid、name、coe、image_id、public、link、apiserver_port、server_type、tls_disabled、registry_enabled

--limit <limit>

返すことのできるクラスターテンプレートの最大数。

-h, --help

ヘルプメッセージを表示して終了します。

--sort-key <sort-key>

結果を並べ替えるコラム

--sort-dir <sort-dir>

ソートの方向。asc または desc。

14.12. coe cluster template show

クラスターテンプレートを表示します。

使用方法

openstack coe cluster template show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           <cluster-template>

表14.37 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表14.38 位置引数

概要

<cluster-template>

表示するクラスターテンプレートの ID または名前。

表14.39 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表14.40 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表14.41 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表14.42 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

14.13. coe cluster template update

クラスターテンプレートを更新します。

使用方法

openstack coe cluster template update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             <cluster-template> <op>
                                             <path=value> [<path=value> ...]

表14.43 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表14.44 位置引数

概要

<op>

操作:addreplace、または remove のいずれか

<cluster-template>

更新するクラスターテンプレートの名前または UUID

<path=value>

追加/置換または削除する属性 (削除時にパスのみが必要)

表14.45 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表14.46 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表14.47 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表14.48 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

14.14. coe cluster update

クラスターを更新します。

使用方法

openstack coe cluster update [-h] [--rollback]
                                    <cluster> <op> <path=value>
                                    [<path=value> ...]

表14.49 位置引数

概要

<cluster>

更新するクラスターの名前または UUID

<path=value>

追加/置換または削除する属性 (削除時にパスのみが必要)

<op>

操作:addreplace、または remove のいずれか

表14.50 その他の引数 (オプション):

概要

--rollback

更新の失敗時のクラスターをロールバックします。

-h, --help

ヘルプメッセージを表示して終了します。

14.15. coe quotas create

クォータを作成します。

使用方法

openstack coe quotas create [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

表14.51 その他の引数 (オプション):

概要

--project-id <project-id>

プロジェクト ID

-h, --help

ヘルプメッセージを表示して終了します。

--hard-limit <hard-limit>

最大リソース制限 (デフォルト:hard-limit=1)

--resource <resource>

リソース名。

14.16. coe quotas delete

指定のリソースクォータを削除します。

使用方法

openstack coe quotas delete [-h] --project-id <project-id> --resource
                                   <resource>

表14.52 その他の引数 (オプション):

概要

--project-id <project-id>

プロジェクト ID

-h, --help

ヘルプメッセージを表示して終了します。

--resource <resource>

リソース名。

14.17. coe quotas list

利用可能なクォータ一覧を出力します。

使用方法

openstack coe quotas list [-h] [--marker <marker>] [--limit <limit>]
                                 [--sort-key <sort-key>]
                                 [--sort-dir <sort-dir>] [--all-tenants]

表14.53 その他の引数 (オプション):

概要

--sort-key <sort-key>

結果を並べ替えるコラム。

--sort-dir <sort-dir>

ソートの方向。asc または desc。

--all-tenants

すべてのテナントクォータの一覧を表示するように指定するフラグ。

--limit <limit>

返すことのできるクォータの最大数。

-h, --help

ヘルプメッセージを表示して終了します。

--marker <marker>

直前のページにある最後のクォータ uuid。マーカーの後ろのクォータの一覧を表示します。

14.18. coe quotas show

指定のプロジェクトリソースのクォータの詳細を表示します。

使用方法

openstack coe quotas show [-h] --project-id <project-id> --resource
                                 <resource>

表14.54 その他の引数 (オプション):

概要

--project-id <project-id>

プロジェクト ID

-h, --help

ヘルプメッセージを表示して終了します。

--resource <resource>

リソース名。

14.19. coe quotas update

指定のプロジェクトリソースクォータの情報を更新します。

使用方法

openstack coe quotas update [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

表14.55 その他の引数 (オプション):

概要

--project-id <project-id>

プロジェクト ID

-h, --help

ヘルプメッセージを表示して終了します。

--hard-limit <hard-limit>

最大リソース制限 (デフォルト:hard-limit=1)

--resource <resource>

リソース名。

14.20. coe service list

Magnum サービスの一覧を出力します。

使用方法

openstack coe service list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]

表14.56 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表14.57 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表14.58 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表14.59 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表14.60 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

14.21. coe stats list

指定の project_id の統計を表示します。

使用方法

openstack coe stats list [-h] <project>

表14.61 位置引数

概要

<project>

プロジェクト ID

表14.62 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

第15章 command

本章では、command コマンドに含まれるコマンドについて説明します。

15.1. コマンドリスト

グループ別に認識されているコマンドを一覧表示します。

使用方法

openstack command list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN]
                              [--group <group-keyword>]

表15.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表15.2 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表15.3 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表15.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表15.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--group <group-keyword>

コマンドグループでフィルターされたコマンドを表示します (例:identity、volume、compute、image、network、およびその他のキーワード)。

第16章 complete.adoc

本章では、complete.adoc コマンドに含まれるコマンドについて説明します。

16.1. 完了

バッシュ補完コマンドを出力します。

使用方法

openstack complete [-h] [--name <command_name>] [--shell <shell>]

表16.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <command_name>

コマンド補完でサポートされるコマンド名

--shell <shell>

使用するシェル。データのみの場合には none を使用します (デフォルト:bash)。

第17章 compute

本章では、compute コマンドに含まれるコマンドについて説明します。

17.1. compute agent create

コンピュートエージェントを作成します。

使用方法

openstack compute agent create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      <os> <architecture> <version> <url>
                                      <md5hash> <hypervisor>

表17.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表17.2 位置引数

概要

<url>

Url

<architecture>

アーキテクチャーのタイプ

<version>

バージョン

<hypervisor>

ハイパーバイザーの種別

<os>

OS のタイプ

<md5hash>

Md5 ハッシュ

表17.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表17.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表17.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表17.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

17.2. Compute agent delete

コンピュートエージェントを削除します。

使用方法

openstack compute agent delete [-h] <id> [<id> ...]

表17.7 位置引数

概要

<id>

削除するエージェントの ID

表17.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

17.3. compute agent list

コンピュートエージェントを一覧表示します。

使用方法

openstack compute agent list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]
                                    [--hypervisor <hypervisor>]

表17.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表17.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表17.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表17.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表17.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--hypervisor <hypervisor>

ハイパーバイザーの種別

17.4. compute agent set

コンピュートエージェントのプロパティーを設定します。

使用方法

openstack compute agent set [-h] [--agent-version <version>]
                                   [--url <url>] [--md5hash <md5hash>]
                                   <id>

表17.14 位置引数

概要

<id>

エージェントの ID

表17.15 その他の引数 (オプション):

概要

--agent-version <version>

エージェントのバージョン

-h, --help

ヘルプメッセージを表示して終了します。

--md5hash <md5hash>

エージェントの Md5 ハッシュ

--url <url>

エージェントの URL

17.5. compute service delete

コンピュートサービスを削除します。

使用方法

openstack compute service delete [-h] <service> [<service> ...]

表17.16 位置引数

概要

<service>

削除する Compute サービス(id のみ)

表17.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

17.6. compute service list

コンピュートサービスを一覧表示します。

使用方法

openstack compute service list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--host <host>] [--service <service>]
                                      [--long]

表17.18 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表17.19 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表17.20 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表17.21 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表17.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--host <host>

指定したホストでサービスを一覧表示します (名前のみ)。

--long

出力の追加フィールドを一覧表示します。

--service <service>

指定されたサービスのみを一覧表示します (名前のみ)。

17.7. compute service set

コンピュートサービス属性を設定します。

使用方法

openstack compute service set [-h] [--enable | --disable]
                                     [--disable-reason <reason>]
                                     [--up | --down]
                                     <host> <service>

表17.23 位置引数

概要

<service>

サービスの名前 (バイナリー名)

<host>

ホスト名

表17.24 その他の引数 (オプション):

概要

--enable

サービスを有効化します。

--disable-reason <reason>

サービスを無効にする理由 (引用符で囲む)。--disable オプションと併用する必要があります。

--down

サービスの強制的な停止

--up

サービスを強制的に起動します。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

サービスを無効化します。

第18章 configuration

本章では、configuration コマンドに含まれるコマンドについて説明します。

18.1. configuration show

設定を詳細表示します。

使用方法

openstack configuration show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX] [--mask | --unmask]

表18.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表18.2 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表18.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表18.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--unmask

パスワードをクリアテキストで表示します。

--mask

パスワードのマスクを試行します (デフォルト)

表18.5 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第19章 一貫性

本章では、consistency コマンドに含まれるコマンドについて説明します。

19.1. consistency group add volume

整合性グループにボリュームを追加します。

使用方法

openstack consistency group add volume [-h]
                                              <consistency-group> <volume>
                                              [<volume> ...]

表19.1 位置引数

概要

<volume>

<consistency-group> (名前または id) に追加するボリューム (複数のボリュームを追加する場合はオプションを繰り返し使用します)

<consistency-group>

<volume> を含む整合性グループ (名前または id)

表19.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

19.2. consistency group create

新規整合性グループを作成します。

使用方法

openstack consistency group create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          (--volume-type <volume-type> | --consistency-group-source <consistency-group> | --consistency-group-snapshot <consistency-group-snapshot>)
                                          [--description <description>]
                                          [--availability-zone <availability-zone>]
                                          [<name>]

表19.3 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表19.4 位置引数

概要

<name>

新規整合性グループの名前 (デフォルトは none)

表19.5 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表19.6 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表19.7 その他の引数 (オプション):

概要

--availability-zone <availability-zone>

この整合性グループのアベイラビリティーゾーン (ソースから整合性グループを作成する場合は利用できません)

--consistency-group-snapshot <consistency-group-snapshot>

既存の整合性グループのスナップショット (名前または ID)

--consistency-group-source <consistency-group>

既存の整合性グループ (名前または ID)

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

この整合性グループの説明

--volume-type <volume-type>

この整合性グループのボリューム種別 (名前または ID)

表19.8 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

19.3. consistency group delete

整合性グループを削除します。

使用方法

openstack consistency group delete [-h] [--force]
                                          <consistency-group>
                                          [<consistency-group> ...]

表19.9 位置引数

概要

<consistency-group>

削除する整合性グループ (名前または ID)

表19.10 その他の引数 (オプション):

概要

--force

Error または available 以外の状態で削除を可能にします。

-h, --help

ヘルプメッセージを表示して終了します。

19.4. consistency group list

整合性グループを一覧表示します。

使用方法

openstack consistency group list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--all-projects] [--long]

表19.11 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表19.12 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表19.13 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表19.14 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表19.15 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの詳細を表示します。管理者のみ (デフォルトは False)

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

19.5. consistency group remove volume

整合性グループからボリュームを削除します。

使用方法

openstack consistency group remove volume [-h]
                                                 <consistency-group> <volume>
                                                 [<volume> ...]

表19.16 位置引数

概要

<volume>

<consistency-group> (名前または id) から削除するボリューム (複数のボリュームを削除する場合はオプションを繰り返し使用します)

<consistency-group>

<volume>(名前または ID) を含む整合性グループ

表19.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

19.6. consistency group set

整合性グループのプロパティーを設定します。

使用方法

openstack consistency group set [-h] [--name <name>]
                                       [--description <description>]
                                       <consistency-group>

表19.18 位置引数

概要

<consistency-group>

変更する整合性グループ (名前または ID)

表19.19 その他の引数 (オプション):

概要

--name <name>

整合性グループの新しい名前

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

整合性グループの新たな説明

19.7. consistency group show

整合性グループの詳細を表示します。

使用方法

openstack consistency group show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        <consistency-group>

表19.20 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表19.21 位置引数

概要

<consistency-group>

表示する整合性グループ (名前または ID)

表19.22 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表19.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表19.24 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表19.25 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

19.8. consistency group snapshot create

新規整合性グループのスナップショットを作成します。

使用方法

openstack consistency group snapshot create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX]
                                                   [--consistency-group <consistency-group>]
                                                   [--description <description>]
                                                   [<snapshot-name>]

表19.26 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表19.27 位置引数

概要

<snapshot-name>

新規整合性グループのスナップショット名 (デフォルトは None)

表19.28 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表19.29 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表19.30 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--consistency-group <consistency-group>

スナップショット (名前または ID) を作成する整合性グループ (デフォルトは <snapshot-name> と同じ)

--description <description>

この整合性グループのスナップショットの説明

表19.31 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

19.9. consistency group snapshot delete

<consistency-group-snapshot>
[<consistency-group-snapshot> ...]

整合性グループのスナップショットを削除します。

使用方法

openstack consistency group snapshot delete [-h]

表19.32 位置引数

概要

<consistency-group-snapshot>

削除する整合性グループのスナップショット (名前または ID)

表19.33 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

19.10. consistency group snapshot list

整合性グループのスナップショットを一覧表示します。

使用方法

openstack consistency group snapshot list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]
                                                 [--all-projects] [--long]
                                                 [--status <status>]
                                                 [--consistency-group <consistency-group>]

表19.34 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表19.35 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表19.36 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表19.37 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表19.38 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの詳細を表示します。管理者のみ (デフォルトは False)

--status <status>

ステータスで結果をフィルターします (available、error、deleting、deleting、または error_deleting)。

-h, --help

ヘルプメッセージを表示して終了します。

--consistency-group <consistency-group>

整合性グループ (名前または ID) で結果をフィルターします。

--long

出力の追加フィールドを一覧表示します。

19.11. consistency group snapshot show

整合性グループのスナップショットの詳細を表示します。

使用方法

openstack consistency group snapshot show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 <consistency-group-snapshot>

表19.39 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表19.40 位置引数

概要

<consistency-group-snapshot>

表示する整合性グループのスナップショット (名前または ID)

表19.41 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表19.42 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表19.43 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表19.44 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第20章 console

本章では、console コマンドに含まれるコマンドについて説明します。

20.1. console log show

サーバーのコンソール出力を表示します。

使用方法

openstack console log show [-h] [--lines <num-lines>] <server>

表20.1 位置引数

概要

<server>

コンソールログ (名前または ID) を表示するサーバー

表20.2 その他の引数 (オプション):

概要

--lines <num-lines>

ログの末尾から表示する行数 (デフォルト=all)。

-h, --help

ヘルプメッセージを表示して終了します。

20.2. console url show

サーバーのリモートコンソール URL を表示します。

使用方法

openstack console url show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  [--novnc | --xvpvnc | --spice | --rdp | --serial | --mks]
                                  <server>

表20.3 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表20.4 位置引数

概要

<server>

URL(名前または ID) を表示するサーバー

表20.5 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表20.6 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表20.7 その他の引数 (オプション):

概要

--mks

Webmks コンソールの URL を表示します。

--novnc

Novnc コンソール URL を表示します (デフォルト)

--xvpvnc

Xvpvnc コンソール URL を表示します。

--rdp

Rdp コンソールの URL を表示します。

--spice

Spice コンソールの URL を表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--serial

シリアルコンソールの URL を表示します。

表20.8 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第21章 container

本章では、container コマンドに含まれるコマンドについて説明します。

21.1. container create

新規コンテナーを作成します。

使用方法

openstack container create [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]
                                  <container-name> [<container-name> ...]

表21.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表21.2 位置引数

概要

<container-name>

新しいコンテナー名

表21.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表21.4 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表21.5 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表21.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

21.2. container delete

コンテナーを削除します。

使用方法

openstack container delete [-h] [--recursive]
                                  <container> [<container> ...]

表21.7 位置引数

概要

<container>

削除するコンテナー

表21.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--recursive, -r

オブジェクトおよびコンテナーを再帰的に削除します。

21.3. container list

コンテナーの一覧を表示します。

使用方法

openstack container list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--sort-column SORT_COLUMN]
                                [--prefix <prefix>] [--marker <marker>]
                                [--end-marker <end-marker>]
                                [--limit <num-containers>] [--long] [--all]

表21.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表21.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表21.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表21.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表21.13 その他の引数 (オプション):

概要

--limit <num-containers>

返されるコンテナーの数を制限します。

--marker <marker>

ページングのアンカー

--long

出力の追加フィールドを一覧表示します。

--end-marker <end-marker>

ページングの終了アンカー

-h, --help

ヘルプメッセージを表示して終了します。

--prefix <prefix>

<prefix> を使用して一覧をフィルターします。

--all

すべてのコンテナーを一覧表示します (デフォルトは 10000)。

21.4. container save

コンテナーのコンテンツをローカルで保存します。

使用方法

openstack container save [-h] <container>

表21.14 位置引数

概要

<container>

保存するコンテナー

表21.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

21.5. container set

コンテナープロパティーを設定します。

使用方法

openstack container set [-h] --property <key=value> <container>

表21.16 位置引数

概要

<container>

変更するコンテナー

表21.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key=value>

このコンテナーにプロパティーを設定します (複数のプロパティーを設定する場合はオプションを繰り返し使用します)

21.6. container show

コンテナーの詳細を表示します。

使用方法

openstack container show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                <container>

表21.18 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表21.19 位置引数

概要

<container>

表示するコンテナー

表21.20 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表21.21 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表21.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表21.23 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

21.7. container unset

コンテナーのプロパティーの設定を解除します。

使用方法

openstack container unset [-h] --property <key> <container>

表21.24 位置引数

概要

<container>

変更するコンテナー

表21.25 その他の引数 (オプション):

概要

--property <key>

コンテナーから削除するプロパティー (複数のプロパティーを削除する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

第22章 cron

本章では、cron コマンドに含まれるコマンドについて説明します。

22.1. cron trigger create

新規トリガーを作成します。

使用方法

openstack cron trigger create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--params PARAMS] [--pattern <* * * * *>]
                                     [--first-time <YYYY-MM-DD HH:MM>]
                                     [--count <integer>] [--utc]
                                     name workflow_identifier [workflow_input]

表22.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表22.2 位置引数

概要

workflow_input

ワークフロー入力

workflow_identifier

ワークフローの名前または ID

name

Cron trigger の名前

表22.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表22.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表22.5 その他の引数 (オプション):

概要

--count <integer>

任意の実行数

--first-time <YYYY-MM-DD HH:MM>

最初の実行日時。時間は、--utc も併せて指定されていない場合にローカル時間として処理されます。

--params PARAMS

ワークフローパラメーター

--utc

指定した時間はすべて utc として処理する必要があります。

-h, --help

ヘルプメッセージを表示して終了します。

--pattern <* * * * *>

Cron trigger のパターン

表22.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

22.2. cron trigger delete

トリガーを削除します。

使用方法

openstack cron trigger delete [-h] cron_trigger [cron_trigger ...]

表22.7 位置引数

概要

cron_trigger

Cron トリガーの名前。

表22.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

22.3. cron trigger list

すべての cron トリガーを一覧表示します。

使用方法

openstack cron trigger list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN]

表22.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表22.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表22.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表22.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表22.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

22.4. cron trigger show

特定の cron トリガーを表示します。

使用方法

openstack cron trigger show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   cron_trigger

表22.14 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表22.15 位置引数

概要

cron_trigger

Cron trigger の名前

表22.16 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表22.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表22.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表22.19 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第23章 datastore

本章では、datastore コマンドに含まれるコマンドについて説明します。

23.1. datastore list

利用可能なデータストアを一覧表示します。

使用方法

openstack datastore list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--sort-column SORT_COLUMN]

表23.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表23.2 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表23.3 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表23.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表23.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

23.2. datastore show

データストアの詳細を表示します。

使用方法

openstack datastore show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                <datastore>

表23.6 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表23.7 位置引数

概要

<datastore>

データストアの ID

表23.8 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表23.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表23.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表23.11 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

23.3. datastore version list

データストアで利用可能なバージョンを一覧表示します。

使用方法

openstack datastore version list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        <datastore>

表23.12 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表23.13 位置引数

概要

<datastore>

データストアの ID または名前

表23.14 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表23.15 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表23.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表23.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

23.4. datastore version show

データストアバージョンの詳細を表示します。

使用方法

openstack datastore version show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--datastore <datastore>]
                                        <datastore_version>

表23.18 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表23.19 位置引数

概要

<datastore_version>

データストアバージョンの ID または名前。

表23.20 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表23.21 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表23.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--datastore <datastore>

データストアの ID または名前。Datastore_version の ID が指定されている場合はオプションになります。

表23.23 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第24章 dns

本章では、dns コマンドに含まれるコマンドについて説明します。

24.1. dns quota list

クォータを一覧表示します。

使用方法

openstack dns quota list [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                [--project-id PROJECT_ID]

表24.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表24.2 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表24.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表24.4 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--project-id PROJECT_ID

プロジェクト ID のデフォルト: 現在のプロジェクト

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表24.5 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

24.2. dns quota reset

ブラックリストを削除します。

使用方法

openstack dns quota reset [-h] [--all-projects] [--edit-managed]
                                 [--sudo-project-id SUDO_PROJECT_ID]
                                 [--project-id PROJECT_ID]

表24.6 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--project-id PROJECT_ID

プロジェクト ID

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

24.3. dns quota set

ブラックリストの属性を設定します。

使用方法

openstack dns quota set [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] [--all-projects]
                               [--edit-managed]
                               [--sudo-project-id SUDO_PROJECT_ID]
                               [--project-id PROJECT_ID]
                               [--api-export-size <api-export-size>]
                               [--zones <zones>]
                               [--recordset-records <recordset-records>]
                               [--zone-records <zone-records>]
                               [--zone-recordsets <zone-recordsets>]

表24.7 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表24.8 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表24.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表24.10 その他の引数 (オプション):

概要

--project-id PROJECT_ID

プロジェクト ID

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--api-export-size <api-export-size>

Api-export-size クォータの新しい値

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--zone-recordsets <zone-recordsets>

Zone-recordsets クォータの新しい値

--zone-records <zone-records>

Zone-records クォータの新しい値

-h, --help

ヘルプメッセージを表示して終了します。

--recordset-records <recordset-records>

Recordset-records クォータの新しい値

--zones <zones>

ゾーンクォータの新しい値

表24.11 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

24.4. dns service list

サービスステータスを一覧表示します。

使用方法

openstack dns service list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]
                                  [--hostname HOSTNAME]
                                  [--service_name SERVICE_NAME]
                                  [--status STATUS] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]

表24.12 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表24.13 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表24.14 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表24.15 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表24.16 その他の引数 (オプション):

概要

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--service_name SERVICE_NAME

サービス名

--hostname HOSTNAME

Hostname

--status STATUS

Status

-h, --help

ヘルプメッセージを表示して終了します。

24.5. dns service show

サービスステータスの詳細を表示します。

使用方法

openstack dns service show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  id

表24.17 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表24.18 位置引数

概要

id

サービスのステータス ID

表24.19 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表24.20 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表24.21 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表24.22 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第25章 ec2

本章では、ec2 コマンドに含まれるコマンドについて説明します。

25.1. ec2 credentials create

EC2 認証情報を作成します。

使用方法

openstack ec2 credentials create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--project <project>] [--user <user>]

表25.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表25.2 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表25.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表25.4 その他の引数 (オプション):

概要

--user <user>

ユーザーの認証情報を作成します (名前または ID、デフォルト: 現在の認証ユーザー)。

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

プロジェクトで認証情報を作成します (名前または ID、デフォルト: 現在の認証プロジェクト)。

表25.5 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

25.2. ec2 credentials delete

EC2 認証情報を削除します。

使用方法

openstack ec2 credentials delete [-h] [--user <user>]
                                        <access-key> [<access-key> ...]

表25.6 位置引数

概要

<access-key>

認証情報アクセスキー

表25.7 その他の引数 (オプション):

概要

--user <user>

ユーザーの認証情報を削除します (名前または ID)。

-h, --help

ヘルプメッセージを表示して終了します。

25.3. ec2 credentials list

EC2 認証情報を一覧表示します。

使用方法

openstack ec2 credentials list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--user <user>]

表25.8 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表25.9 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表25.10 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表25.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表25.12 その他の引数 (オプション):

概要

--user <user>

ユーザー別にリストを絞り込みます (名前または ID)。

-h, --help

ヘルプメッセージを表示して終了します。

25.4. ec2 credentials show

EC2 認証情報の詳細を表示します。

使用方法

openstack ec2 credentials show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--user <user>]
                                      <access-key>

表25.13 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表25.14 位置引数

概要

<access-key>

認証情報アクセスキー

表25.15 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表25.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表25.17 その他の引数 (オプション):

概要

--user <user>

ユーザーの認証情報 (名前または ID) を表示します。

-h, --help

ヘルプメッセージを表示して終了します。

表25.18 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第26章 エンドポイント

本章では、endpoint コマンドに含まれるコマンドについて説明します。

26.1. endpoint create

新規エンドポイントを作成します。

使用方法

openstack endpoint create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX] --publicurl <url>
                                 [--adminurl <url>] [--internalurl <url>]
                                 [--region <region-id>]
                                 <service>

表26.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表26.2 位置引数

概要

<service>

新しいエンドポイント (名前または ID) に関連付けるサービス

表26.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表26.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表26.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--region <region-id>

新規エンドポイントのリージョン ID

--internalurl <url>

新規エンドポイントの内部 URL

--publicurl <url>

新規エンドポイントのパブリック URL (必須)

--adminurl <url>

新規エンドポイント管理 URL

表26.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

26.2. endpoint delete

エンドポイントを削除します。

使用方法

openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]

表26.7 位置引数

概要

<endpoint-id>

削除するエンドポイント (id のみ)

表26.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

26.3. endpoint list

エンドポイントを一覧表示します。

使用方法

openstack endpoint list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--sort-column SORT_COLUMN] [--long]

表26.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表26.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表26.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表26.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表26.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

26.4. endpoint show

エンドポイントの詳細を表示します。

使用方法

openstack endpoint show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]
                               <endpoint>

表26.14 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表26.15 位置引数

概要

<endpoint>

表示するエンドポイント (エンドポイント id、サービス ID、サービス名、サービスタイプ)

表26.16 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表26.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表26.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表26.19 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第27章 event

本章では、event コマンドに含まれるコマンドについて説明します。

27.1. event trigger create

新規トリガーを作成します。

使用方法

openstack event trigger create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--params PARAMS]
                                      name workflow_id exchange topic event
                                      [workflow_input]

表27.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表27.2 位置引数

概要

workflow_input

ワークフロー入力

name

イベントトリガー名

exchange

イベントトリガーの交換

topic

イベントトリガートピック

workflow_id

ワークフロー id

event

イベントトリガーイベント名

表27.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表27.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表27.5 その他の引数 (オプション):

概要

--params PARAMS

ワークフローパラメーター

-h, --help

ヘルプメッセージを表示して終了します。

表27.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

27.2. event trigger delete

トリガーを削除します。

使用方法

openstack event trigger delete [-h]
                                      event_trigger_id [event_trigger_id ...]

表27.7 位置引数

概要

event_trigger_id

イベントトリガーの ID。

表27.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

27.3. event trigger list

すべてのイベントトリガーを一覧表示します。

使用方法

openstack event trigger list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]

表27.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表27.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表27.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表27.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表27.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

27.4. event trigger show

特定のイベントトリガーを表示します。

使用方法

openstack event trigger show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    event_trigger

表27.14 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表27.15 位置引数

概要

event_trigger

イベントトリガー ID

表27.16 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表27.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表27.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表27.19 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第28章 extension

本章では、extension コマンドに含まれるコマンドについて説明します。

28.1. extension list

API 拡張を一覧表示します。

使用方法

openstack extension list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--sort-column SORT_COLUMN] [--compute]
                                [--identity] [--network] [--volume] [--long]

表28.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表28.2 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表28.3 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表28.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表28.5 その他の引数 (オプション):

概要

--compute

コンピュート api の拡張機能を一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--volume

ブロックストレージ api の拡張機能を一覧表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--network

ネットワーク api の拡張機能を一覧表示します。

--identity

アイデンティティー api の拡張機能を一覧表示します。

28.2. extension show

API 拡張機能を表示します。

使用方法

openstack extension show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                <extension>

表28.6 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表28.7 位置引数

概要

<extension>

表示する拡張機能。現在、ネットワーク拡張機能のみがサポートされます。(名前またはエイリアス)

表28.8 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表28.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表28.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表28.11 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第29章 firewall

本章では、firewall コマンドに含まれるコマンドについて説明します。

29.1. firewall group create

新しいファイアウォールグループの作成

使用方法

openstack firewall group create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--name NAME]
                                       [--description <description>]
                                       [--ingress-firewall-policy <ingress-firewall-policy> | --no-ingress-firewall-policy]
                                       [--egress-firewall-policy <egress-firewall-policy> | --no-egress-firewall-policy]
                                       [--public | --private | --share | --no-share]
                                       [--enable | --disable]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       [--port <port> | --no-port]

表29.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表29.2 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表29.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表29.4 その他の引数 (オプション):

概要

--share

すべてのプロジェクトで使用するファイアウォールグループを共有します(デフォルトでは、現在のプロジェクトによって使用されるよう制限されます)。

--no-port

ファイアウォールグループからすべてのポートを切断します。

--disable

ファイアウォールグループの無効化

--public

ファイアウォールグループをパブリックにして、すべてのプロジェクトで使用できるようにします(デフォルトとは、現在のプロジェクトに対する使用を制限するためです)。このオプションは非推奨であり、R リリースで削除されます。

--no-egress-firewall-policy

ファイアウォールグループからの egress ファイアウォールポリシーの割り当て解除

--enable

ファイアウォールグループの有効化

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--egress-firewall-policy <egress-firewall-policy>

Egress ファイアウォールポリシー(名前または ID)

--project <project>

所有者のプロジェクト (名前または ID)

--no-share

ファイアウォールグループの使用を現在のプロジェクトに制限する

--no-ingress-firewall-policy

ファイアウォールグループからの Ingress ファイアウォールポリシーの切断

--private

ファイアウォールグループの使用を現在のプロジェクトに制限します。このオプションは非推奨であり、R リリースで削除されます。

--port <port>

ファイアウォールグループを適用するポート(名前または ID)。このオプションを繰り返すことができます。

--name NAME

ファイアウォールグループの名前

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ファイアウォールグループの説明

--ingress-firewall-policy <ingress-firewall-policy>

Ingress ファイアウォールポリシー(名前または ID)

表29.5 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

29.2. firewall group delete

ファイアウォールグループを削除します。

使用方法

openstack firewall group delete [-h]
                                       <firewall-group> [<firewall-group> ...]

表29.6 位置引数

概要

<firewall-group>

削除するファイアウォールのグループ(名前または ID)

表29.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

29.3. firewall group list

ファイアウォールグループを一覧表示します。

使用方法

openstack firewall group list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN] [--long]

表29.8 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表29.9 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表29.10 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表29.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表29.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

29.4. firewall group policy add rule

特定のファイアウォールポリシーにルールを挿入します。

使用方法

openstack firewall group policy add rule [-h]
                                                [--insert-before <firewall-rule>]
                                                [--insert-after <firewall-rule>]
                                                <firewall-policy>
                                                <firewall-rule>

表29.13 位置引数

概要

<firewall-policy>

ルールを挿入するためのファイアウォールポリシー(名前または ID)

<firewall-rule>

挿入するファイアウォールルール(名前または ID)

表29.14 その他の引数 (オプション):

概要

--insert-after <firewall-rule>

既存のルールの後に新しいルールを挿入します(名前または ID)。

-h, --help

ヘルプメッセージを表示して終了します。

--insert-before <firewall-rule>

既存のルールの前に新しいルールを挿入します(名前または ID)。

29.5. firewall group policy create

新しいファイアウォールポリシーの作成

使用方法

openstack firewall group policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--description DESCRIPTION]
                                              [--audited | --no-audited]
                                              [--share | --public | --private | --no-share]
                                              [--project <project>]
                                              [--project-domain <project-domain>]
                                              [--firewall-rule <firewall-rule> | --no-firewall-rule]
                                              <name>

表29.15 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表29.16 位置引数

概要

<name>

ファイアウォールポリシーの名前

表29.17 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表29.18 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表29.19 その他の引数 (オプション):

概要

--share

すべてのプロジェクトで使用するファイアウォールポリシーを共有します(デフォルトでは、現在のプロジェクトによって使用されるよう制限されます)。

--public

ファイアウォールポリシーをパブリックにして、すべてのプロジェクトで使用できるようにします(デフォルトとは異なり、現在のプロジェクトへの使用を制限します)。 このオプションは非推奨であり、R リリースで削除されます。

--no-audited

ポリシーの監査を無効にします。

--no-firewall-rule

ファイアウォールポリシーからすべてのファイアウォールルールの設定を解除します。

監査対象

ポリシーの監査を有効にします。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--no-share

ファイアウォールポリシーの使用を現在のプロジェクトに制限する

--firewall-rule <firewall-rule>

適用するファイアウォールルール(名前または ID)

--private

ファイアウォールポリシーの使用を現在のプロジェクトに制限します。このオプションは非推奨となっており、R リリースで削除されます。

--description DESCRIPTION

ファイアウォールポリシーの説明

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト (名前または ID)

表29.20 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

29.6. ファイアウォールグループポリシーの削除

ファイアウォールポリシーを削除します。

使用方法

openstack firewall group policy delete [-h]
                                              <firewall-policy>
                                              [<firewall-policy> ...]

表29.21 位置引数

概要

<firewall-policy>

削除するファイアウォールポリシー(名前または ID)

表29.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

29.7. firewall group policy list

ファイアウォールポリシーを一覧表示します。

使用方法

openstack firewall group policy list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]
                                            [--long]

表29.23 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表29.24 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表29.25 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表29.26 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表29.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

29.8. firewall group policy remove rule

特定のファイアウォールポリシーからルールを削除します。

使用方法

openstack firewall group policy remove rule [-h]
                                                   <firewall-policy>
                                                   <firewall-rule>

表29.28 位置引数

概要

<firewall-policy>

ルールを削除するファイアウォールポリシー(名前または ID)

<firewall-rule>

ポリシーから削除するファイアウォールルール(名前または ID)

表29.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

29.9. firewall group policy set

ファイアウォールポリシーの属性を設定します。

使用方法

openstack firewall group policy set [-h] [--description DESCRIPTION]
                                           [--audited | --no-audited]
                                           [--share | --public | --private | --no-share]
                                           [--name <name>]
                                           [--firewall-rule <firewall-rule>]
                                           [--no-firewall-rule]
                                           <firewall-policy>

表29.30 位置引数

概要

<firewall-policy>

更新するファイアウォールポリシー(名前または ID)

表29.31 その他の引数 (オプション):

概要

--share

すべてのプロジェクトで使用するファイアウォールポリシーを共有します(デフォルトでは、現在のプロジェクトによって使用されるよう制限されます)。

--public

ファイアウォールポリシーをパブリックにして、すべてのプロジェクトで使用できるようにします(デフォルトとは異なり、現在のプロジェクトへの使用を制限します)。 このオプションは非推奨であり、R リリースで削除されます。

--no-audited

ポリシーの監査を無効にします。

--no-firewall-rule

ファイアウォールポリシーからすべてのファイアウォールルールを削除します。

監査対象

ポリシーの監査を有効にします。

--no-share

ファイアウォールポリシーの使用を現在のプロジェクトに制限する

--firewall-rule <firewall-rule>

適用するファイアウォールルール(名前または ID)

--private

ファイアウォールポリシーの使用を現在のプロジェクトに制限します。このオプションは非推奨となっており、R リリースで削除されます。

--description DESCRIPTION

ファイアウォールポリシーの説明

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ファイアウォールポリシーの名前

29.10. firewall group policy show

ファイアウォールポリシーの詳細を表示します。

使用方法

openstack firewall group policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            <firewall-policy>

表29.32 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表29.33 位置引数

概要

<firewall-policy>

表示するファイアウォールポリシー(名前または ID)

表29.34 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表29.35 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表29.36 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表29.37 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

29.11. firewall group policy unset

ファイアウォールポリシーのプロパティーの設定を解除します。

使用方法

openstack firewall group policy unset [-h]
                                             [--firewall-rule <firewall-rule> | --all-firewall-rule]
                                             [--audited] [--share] [--public]
                                             <firewall-policy>

表29.38 位置引数

概要

<firewall-policy>

設定を解除するファイアウォールポリシー(名前または ID)

表29.39 その他の引数 (オプション):

概要

--share

ファイアウォールポリシーの使用を現在のプロジェクトに制限する

--public

ファイアウォールポリシーの使用を現在のプロジェクトに制限します。このオプションは非推奨であり、R リリースで削除されます。

監査対象

ポリシーの監査を無効にします。

--all-firewall-rule

ファイアウォールポリシーからすべてのファイアウォールルールを削除します。

--firewall-rule <firewall-rule>

ファイアウォールポリシーからファイアウォールルールを削除します(名前または ID)。

-h, --help

ヘルプメッセージを表示して終了します。

29.12. firewall group rule create

新しいファイアウォールルールを作成します。

使用方法

openstack firewall group rule create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            [--name <name>]
                                            [--description <description>]
                                            [--protocol {tcp,udp,icmp,any}]
                                            [--action {allow,deny,reject}]
                                            [--ip-version <ip-version>]
                                            [--source-ip-address <source-ip-address> | --no-source-ip-address]
                                            [--destination-ip-address <destination-ip-address> | --no-destination-ip-address]
                                            [--source-port <source-port> | --no-source-port]
                                            [--destination-port <destination-port> | --no-destination-port]
                                            [--public | --private | --share | --no-share]
                                            [--enable-rule | --disable-rule]
                                            [--project <project>]
                                            [--project-domain <project-domain>]

表29.40 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表29.41 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表29.42 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表29.43 その他の引数 (オプション):

概要

--destination-port <destination-port>

宛先ポート番号または範囲([1, 65535] の整数、または 123:456 などの範囲)

--no-destination-ip-address

宛先 IP アドレスの割り当てを解除します。

--source-ip-address <source-ip-address>

ソース IP アドレスまたはサブネット

--share

すべてのプロジェクトで使用するファイアウォールルールを共有します(デフォルトでは、現在のプロジェクトによって使用されるよう制限されます)。

--no-source-ip-address

ソースの IP アドレスの割り当てを解除します。

--private

ファイアウォールルールの使用を現在のプロジェクトに制限します。このオプションは非推奨となっており、R リリースで削除されます。

--enable-rule

このルールを有効にします(デフォルトは有効です)。

--name <name>

ファイアウォールルールの名前

--no-source-port

ソースのポート番号または範囲の割り当てを解除します。

--destination-ip-address <destination-ip-address>

宛先 IP アドレスまたはサブネット

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ファイアウォールルールの説明

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--action {allow,deny,reject}

ファイアウォールルールの動作

--ip-version <ip-version>

ip バージョン 4 または 6 を設定します(デフォルトは 4)。

--source-port <source-port>

ソースポート番号または範囲([1, 65535] の整数、または 123:456 などの範囲)

--no-share

ファイアウォールルールの使用を現在のプロジェクトに制限する

--no-destination-port

宛先ポート番号または範囲の割り当てを解除します。

--project <project>

所有者のプロジェクト (名前または ID)

--disable-rule

このルールを無効にします。

--public

ファイアウォールポリシーをパブリックにして、すべてのプロジェクトで使用できるようにします(デフォルトとは、現在のプロジェクトに対する使用を制限するためです)。このオプションは非推奨となり、R リリースで削除されます。

--protocol {tcp,udp,icmp,any}

ファイアウォールルールのプロトコル

表29.44 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

29.13. firewall group rule delete

ファイアウォールルールを削除します。

使用方法

openstack firewall group rule delete [-h]
                                            <firewall-rule>
                                            [<firewall-rule> ...]

表29.45 位置引数

概要

<firewall-rule>

削除するファイアウォールルール(名前または ID)

表29.46 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

29.14. firewall group rule list

特定のテナントに属するファイアウォールルールを一覧表示します。

使用方法

openstack firewall group rule list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN] [--long]

表29.47 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表29.48 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表29.49 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表29.50 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表29.51 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

29.15. firewall group rule set

ファイアウォールルールの属性を設定します。

使用方法

openstack firewall group rule set [-h] [--name <name>]
                                         [--description <description>]
                                         [--protocol {tcp,udp,icmp,any}]
                                         [--action {allow,deny,reject}]
                                         [--ip-version <ip-version>]
                                         [--source-ip-address <source-ip-address> | --no-source-ip-address]
                                         [--destination-ip-address <destination-ip-address> | --no-destination-ip-address]
                                         [--source-port <source-port> | --no-source-port]
                                         [--destination-port <destination-port> | --no-destination-port]
                                         [--public | --private | --share | --no-share]
                                         [--enable-rule | --disable-rule]
                                         <firewall-rule>

表29.52 位置引数

概要

<firewall-rule>

設定するファイアウォールルール(名前または ID)

表29.53 その他の引数 (オプション):

概要

--share

すべてのプロジェクトで使用するファイアウォールルールを共有します(デフォルトでは、現在のプロジェクトによって使用されるよう制限されます)。

--no-source-ip-address

ソースの IP アドレスの割り当てを解除します。

--source-ip-address <source-ip-address>

ソース IP アドレスまたはサブネット

--ip-version <ip-version>

ip バージョン 4 または 6 を設定します(デフォルトは 4)。

--private

ファイアウォールルールの使用を現在のプロジェクトに制限します。このオプションは非推奨となっており、R リリースで削除されます。

--no-source-port

ソースのポート番号または範囲の割り当てを解除します。

--name <name>

ファイアウォールルールの名前

--enable-rule

このルールを有効にします(デフォルトは有効です)。

--destination-port <destination-port>

宛先ポート番号または範囲([1, 65535] の整数、または 123:456 などの範囲)

--source-port <source-port>

ソースポート番号または範囲([1, 65535] の整数、または 123:456 などの範囲)

--disable-rule

このルールを無効にします。

--no-share

ファイアウォールルールの使用を現在のプロジェクトに制限する

--no-destination-port

宛先ポート番号または範囲の割り当てを解除します。

--no-destination-ip-address

宛先 IP アドレスの割り当てを解除します。

--destination-ip-address <destination-ip-address>

宛先 IP アドレスまたはサブネット

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ファイアウォールルールの説明

--protocol {tcp,udp,icmp,any}

ファイアウォールルールのプロトコル

--action {allow,deny,reject}

ファイアウォールルールの動作

--public

ファイアウォールポリシーをパブリックにして、すべてのプロジェクトで使用できるようにします(デフォルトとは、現在のプロジェクトに対する使用を制限するためです)。このオプションは非推奨となり、R リリースで削除されます。

29.16. firewall group rule show

ファイアウォールルールの詳細を表示します。

使用方法

openstack firewall group rule show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          <firewall-rule>

表29.54 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表29.55 位置引数

概要

<firewall-rule>

表示するファイアウォールルール(名前または ID)

表29.56 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表29.57 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表29.58 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表29.59 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

29.17. firewall group rule unset

ファイアウォールルールプロパティーの設定を解除します。

使用方法

openstack firewall group rule unset [-h] [--source-ip-address]
                                           [--destination-ip-address]
                                           [--source-port]
                                           [--destination-port] [--share]
                                           [--public] [--enable-rule]
                                           <firewall-rule>

表29.60 位置引数

概要

<firewall-rule>

設定を解除するファイアウォールルール(名前または ID)

表29.61 その他の引数 (オプション):

概要

--share

ファイアウォールルールの使用を現在のプロジェクトに制限する

--public

ファイアウォールルールの使用を現在のプロジェクトに制限します。このオプションは非推奨であり、R リリースで削除されます。

--enable-rule

このルールを無効にします。

--destination-port

宛先ポート番号または範囲([1, 65535] の整数、または 123:456 などの範囲)

Source IP Address

ソース IP アドレスまたはサブネット

-h, --help

ヘルプメッセージを表示して終了します。

--destination-ip-address

宛先 IP アドレスまたはサブネット

source-port

ソースポート番号または範囲([1, 65535] の整数、または 123:456 などの範囲)

29.18. firewall group set

ファイアウォールグループの属性を設定します。

使用方法

openstack firewall group set [-h] [--name NAME]
                                    [--description <description>]
                                    [--ingress-firewall-policy <ingress-firewall-policy> | --no-ingress-firewall-policy]
                                    [--egress-firewall-policy <egress-firewall-policy> | --no-egress-firewall-policy]
                                    [--public | --private | --share | --no-share]
                                    [--enable | --disable] [--port <port>]
                                    [--no-port]
                                    <firewall-group>

表29.62 位置引数

概要

<firewall-group>

更新するファイアウォールグループ(名前または ID)

表29.63 その他の引数 (オプション):

概要

--share

すべてのプロジェクトで使用するファイアウォールグループを共有します(デフォルトでは、現在のプロジェクトによって使用されるよう制限されます)。

--no-port

ファイアウォールグループからすべてのポートを切断します。

--disable

ファイアウォールグループの無効化

--public

ファイアウォールグループをパブリックにして、すべてのプロジェクトで使用できるようにします(デフォルトとは、現在のプロジェクトに対する使用を制限するためです)。このオプションは非推奨であり、R リリースで削除されます。

--no-egress-firewall-policy

ファイアウォールグループからの egress ファイアウォールポリシーの割り当て解除

--enable

ファイアウォールグループの有効化

--egress-firewall-policy <egress-firewall-policy>

Egress ファイアウォールポリシー(名前または ID)

--no-share

ファイアウォールグループの使用を現在のプロジェクトに制限する

--no-ingress-firewall-policy

ファイアウォールグループからの Ingress ファイアウォールポリシーの切断

--private

ファイアウォールグループの使用を現在のプロジェクトに制限します。このオプションは非推奨であり、R リリースで削除されます。

--port <port>

ファイアウォールグループを適用するポート(名前または ID)。このオプションを繰り返すことができます。

--name NAME

ファイアウォールグループの名前

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ファイアウォールグループの説明

--ingress-firewall-policy <ingress-firewall-policy>

Ingress ファイアウォールポリシー(名前または ID)

29.19. firewall group show

ファイアウォールグループの詳細を表示します。

使用方法

openstack firewall group show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <firewall-group>

表29.64 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表29.65 位置引数

概要

<firewall-group>

表示するファイアウォールグループ(名前または ID)

表29.66 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表29.67 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表29.68 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表29.69 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

29.20. firewall group unset

ファイアウォールグループのプロパティーの設定を解除します。

使用方法

openstack firewall group unset [-h] [--port <port> | --all-port]
                                      [--ingress-firewall-policy]
                                      [--egress-firewall-policy]
                                      [--public | --share] [--enable]
                                      <firewall-group>

表29.70 位置引数

概要

<firewall-group>

設定を解除するファイアウォールグループ(名前または ID)

表29.71 その他の引数 (オプション):

概要

--share

ファイアウォールグループの使用を現在のプロジェクトに制限する

--all-port

このファイアウォールグループのポートをすべて削除します。

--public

ファイアウォールグループをパブリックにして、すべてのプロジェクトで使用できるようにします(デフォルトとは、現在のプロジェクトに対する使用を制限するためです)。このオプションは非推奨であり、R リリースで削除されます。

--enable

ファイアウォールグループの無効化

--ingress-firewall-policy

削除する Ingress ファイアウォールポリシー(名前または ID)

--egress-firewall-policy

削除する Egress ファイアウォールポリシー(名前または ID)

--port <port>

ファイアウォールグループを適用するポート(名前または ID)。このオプションを繰り返すことができます。

-h, --help

ヘルプメッセージを表示して終了します。

第30章 flavor

本章では、flavor コマンドに含まれるコマンドについて説明します。

30.1. flavor create

新規フレーバーを作成します。

使用方法

openstack flavor create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] [--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>]
                               [--project-domain <project-domain>]
                               <flavor-name>

表30.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表30.2 位置引数

概要

<flavor-name>

新規フレーバー名

表30.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表30.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表30.5 その他の引数 (オプション):

概要

--disk <size-gb>

GB 単位のディスクサイズ (デフォルトは 0g)

--ram <size-mb>

MB 単位のメモリーサイズ (デフォルトは 256m)

--id <id>

一意のフレーバー ID。uuid を自動生成します (デフォルト:auto)

--private

他のプロジェクトでフレーバーは利用できません。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--ephemeral <size-gb>

GB 単位の一時ディスクサイズ (デフォルトは 0g)

--property <key=value>

このフレーバーに追加する属性 (複数の属性を設定する場合はオプションを繰り返し使用します)

--vcpus <vcpus>

仮想 CPU の数 (デフォルトは 1)

--swap <size-mb>

MB 単位の追加のスワップ領域サイズ (デフォルト: 0m)

--rxtx-factor <factor>

Rx/tx ファクター (デフォルトは 1.0)

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

<project> がプライベートフレーバー (名前または ID) にアクセスできるようにします (--private オプションと併せて使用する必要があります)。

--public

他のプロジェクトでフレーバーが利用できます (デフォルト)

表30.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

30.2. flavor delete

フレーバーを削除します。

使用方法

openstack flavor delete [-h] <flavor> [<flavor> ...]

表30.7 位置引数

概要

<flavor>

削除するフレーバー (名前または ID)

表30.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

30.3. flavor list

フレーバーを一覧表示します。

使用方法

openstack flavor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN]
                             [--public | --private | --all] [--long]
                             [--marker <flavor-id>] [--limit <num-flavors>]

表30.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表30.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表30.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表30.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表30.13 その他の引数 (オプション):

概要

--public

パブリックフレーバーのみを一覧表示します (デフォルト)

--private

プライベートフレーバーのみを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--limit <num-flavors>

表示するフレーバーの最大数

-h, --help

ヘルプメッセージを表示して終了します。

--marker <flavor-id>

前のページにある最後のフレーバー ID

--all

パブリックまたはプライベートのすべてのフレーバーを一覧表示します。

30.4. flavor set

フレーバーのプロパティーを設定します。

使用方法

openstack flavor set [-h] [--no-property] [--property <key=value>]
                            [--project <project>]
                            [--project-domain <project-domain>]
                            <flavor>

表30.14 位置引数

概要

<flavor>

変更するフレーバー (名前または ID)

表30.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--property <key=value>

このフレーバーに追加または変更する属性 (複数の属性を設定する場合はオプションを繰り返し使用します)

--no-property

このフレーバーからすべてのプロパティーを削除します (新しいプロパティーを設定する前に現在のプロパティーを削除するには --no-property と --property の両方を指定)。

--project <project>

プロジェクト (名前または ID) へのフレーバーアクセスを設定します (管理者のみ)。

30.5. flavor show

フレーバーの詳細を表示します。

使用方法

openstack flavor show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             <flavor>

表30.16 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表30.17 位置引数

概要

<flavor>

表示するフレーバー (名前または ID)

表30.18 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表30.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表30.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表30.21 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

30.6. flavor unset

フレーバーのプロパティーを設定します。

使用方法

openstack flavor unset [-h] [--property <key>] [--project <project>]
                              [--project-domain <project-domain>]
                              <flavor>

表30.22 位置引数

概要

<flavor>

変更するフレーバー (名前または ID)

表30.23 その他の引数 (オプション):

概要

--property <key>

フレーバーから削除するプロパティー (複数プロパティーの設定を解除する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

プロジェクト (名前または ID) からフレーバーアクセスを削除します (管理者のみ)。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

第31章 floating

本章では、floating コマンドに含まれるコマンドについて説明します。

31.1. floating ip create

Floating IP を作成します。

使用方法

openstack floating ip create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX] [--subnet <subnet>]
                                    [--port <port>]
                                    [--floating-ip-address <ip-address>]
                                    [--fixed-ip-address <ip-address>]
                                    [--qos-policy <qos-policy>]
                                    [--description <description>]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    <network>

表31.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表31.2 位置引数

概要

<network>

Floating IP の割り当て元のネットワーク (名前または ID)

表31.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表31.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表31.5 その他の引数 (オプション):

概要

--fixed-ip-address <ip-address>

Floating IP にマッピングされた Fixed IP アドレス

--description <description>

Floating IP の説明を設定します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--project <project>

所有者のプロジェクト (名前または ID)

--port <port>

Floating IP(名前または ID) に関連付けるポート

--qos-policy <qos-policy>

Floating IP(名前または ID) に qos ポリシーを割り当てます。

-h, --help

ヘルプメッセージを表示して終了します。

--floating-ip-address <ip-address>

Floating IP アドレス

--subnet <subnet>

Floating IP(名前または ID) を作成するサブネット

表31.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

31.2. floating ip delete

Floating IP を削除します。

使用方法

openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]

表31.7 位置引数

概要

<floating-ip>

削除する Floating IP(IP アドレスまたは ID)

表31.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

31.3. floating ip list

Floating IP を一覧表示します。

使用方法

openstack floating ip list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]
                                  [--network <network>] [--port <port>]
                                  [--fixed-ip-address <ip-address>] [--long]
                                  [--status <status>] [--project <project>]
                                  [--project-domain <project-domain>]
                                  [--router <router>]

表31.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表31.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表31.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表31.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表31.13 その他の引数 (オプション):

概要

--fixed-ip-address <ip-address>

指定の Fixed IP アドレスに従って、Floating IP を一覧表示します。

--router <router>

指定のルーター (名前または ID) に従って Floating IP を一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--status <status>

指定されたステータス (ACTIVE, DOWN) に従って Floating IP を一覧表示します。

--network <network>

指定されたネットワーク (名前または ID) に従って Floating IP を一覧表示します。

--port <port>

指定ポート (名前または ID) に従って Floating IP を一覧表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

指定のプロジェクト (名前または ID) に従って Floating IP を一覧表示します。

31.4. floating ip pool list

Floating IP アドレスのプールを一覧表示します。

使用方法

openstack floating ip pool list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN]

表31.14 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表31.15 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表31.16 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表31.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表31.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

31.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]
                                 <floating-ip>

表31.19 位置引数

概要

<floating-ip>

変更する Floating IP(IP アドレスまたは ID)

表31.20 その他の引数 (オプション):

概要

--qos-policy <qos-policy>

Floating IP(名前または ID) に qos ポリシーを割り当てます。

-h, --help

ヘルプメッセージを表示して終了します。

--no-qos-policy

Floating IP に割り当てられた qos ポリシーを削除します。

--port <port>

Floating IP をポートに関連付けます (名前または ID)。

--fixed-ip-address <ip-address>

ポートの Fixed IP(ポートに複数の IP がある場合のみ必要)

31.6. floating ip show

Floating IP の詳細を表示します。

使用方法

openstack floating ip show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  <floating-ip>

表31.21 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表31.22 位置引数

概要

<floating-ip>

表示する Floating IP(IP アドレスまたは ID)

表31.23 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表31.24 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表31.25 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表31.26 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

31.7. floating ip unset

Floating IP 属性の設定を解除します。

使用方法

openstack floating ip unset [-h] [--port] [--qos-policy] <floating-ip>

表31.27 位置引数

概要

<floating-ip>

関連付けを解除する Floating IP(IP アドレスまたは ID)

表31.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--qos-policy

Floating IP に割り当てられた qos ポリシーを削除します。

--port

Floating IP に関連付けられたポートの関連付けを解除します。

第32章 help.adoc

本章では、help.adoc コマンドに含まれるコマンドについて説明します。

32.1. help

別のコマンドの詳細なヘルプを出力します。

使用方法

openstack help [-h] [cmd [cmd ...]]

表32.1 位置引数

概要

cmd

コマンドの名前

表32.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

第33章 host

本章では、host コマンドに含まれるコマンドについて説明します。

33.1. host list

ホストを一覧表示します。

使用方法

openstack host list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--sort-column SORT_COLUMN] [--zone <zone>]

表33.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表33.2 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表33.3 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表33.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表33.5 その他の引数 (オプション):

概要

--zone <zone>

アベイラビリティーゾーン内のホストのみを返します。

-h, --help

ヘルプメッセージを表示して終了します。

33.2. host set

ホスト属性を設定します。

使用方法

openstack host set [-h] [--enable | --disable]
                          [--enable-maintenance | --disable-maintenance]
                          <host>

表33.6 位置引数

概要

<host>

変更するホスト (名前のみ)

表33.7 その他の引数 (オプション):

概要

--enable-maintenance

ホストのメンテナーンスモードを有効にします。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

ホストを無効にします。

--disable-maintenance

ホストのメンテナーンスモードを無効にします。

--enable

ホストを有効にします。

33.3. host show

ホストの詳細を表示します。

使用方法

openstack host show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--sort-column SORT_COLUMN]
                           <host>

表33.8 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表33.9 位置引数

概要

<host>

ホスト名

表33.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表33.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表33.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表33.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

第34章 hypervisor

本章では、hypervisor コマンドに含まれるコマンドについて説明します。

34.1. hypervisor list

ハイパーバイザーを一覧表示します。

使用方法

openstack hypervisor list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN]
                                 [--matching <hostname>] [--long]

表34.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表34.2 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表34.3 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表34.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表34.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--matching <hostname>

<hostname> 部分文字列を使用してハイパーバイザーをフィルターします。

34.2. hypervisor show

ハイパーバイザーの詳細を表示します。

使用方法

openstack hypervisor show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX]
                                 <hypervisor>

表34.6 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表34.7 位置引数

概要

<hypervisor>

表示するハイパーバイザー (名前または ID)

表34.8 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表34.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表34.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表34.11 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

34.3. hypervisor stats show

ハイパーバイザーの統計情報を表示します。

使用方法

openstack hypervisor stats show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]

表34.12 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表34.13 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表34.14 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表34.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表34.16 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第35章 image

本章では、image コマンドに含まれるコマンドについて説明します。

35.1. image add project

プロジェクトをイメージに関連付けます。

使用方法

openstack image add project [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   [--project-domain <project-domain>]
                                   <image> <project>

表35.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表35.2 位置引数

概要

<image>

共有するイメージ (名前または ID)

<project>

イメージに関連付けるプロジェクト(名前または ID)

表35.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表35.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表35.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表35.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

35.2. image create

イメージを作成/アップロードします。

使用方法

openstack image create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [--id <id>]
                              [--container-format <container-format>]
                              [--disk-format <disk-format>]
                              [--min-disk <disk-gb>] [--min-ram <ram-mb>]
                              [--file <file> | --volume <volume>] [--force]
                              [--protected | --unprotected]
                              [--public | --private | --community | --shared]
                              [--property <key=value>] [--tag <tag>]
                              [--project <project>]
                              [--project-domain <project-domain>]
                              <image-name>

表35.7 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表35.8 位置引数

概要

<image-name>

新しいイメージ名

表35.9 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表35.10 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表35.11 その他の引数 (オプション):

概要

--volume <volume>

ボリュームからイメージを作成します。

--force

ボリュームが使用中の場合にイメージ作成を強制的に実行します (--volume と共に使用する場合にのみ意味があります)。

--community

イメージはコミュニティーに公開されます。

--id <id>

予約するイメージ ID

--private

イメージは一般に公開されません (デフォルト)。

--disk-format <disk-format>

イメージディスクの形式。サポートされるオプションは ami、ari、aki、vhd、vmdk、raw、qcow2、vhdx、vdi、iso、ploop です。デフォルトの形式は raw です。

--unprotected

イメージの削除を許可します (デフォルト)

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--property <key=value>

このイメージにプロパティーを設定します (複数のプロパティーを設定する場合はオプションを繰り返し使用します)。

--min-disk <disk-gb>

イメージのブートに必要な最小ディスクサイズ (ギガバイト単位)

--min-ram <ram-mb>

イメージのブートに必要な最小 RAM サイズ (メガバイト単位)

--shared

イメージを共有可能です。

--file <file>

ローカルファイルからイメージをアップロードします。

--container-format <container-format>

イメージコンテナーの形式。サポートされるオプションは ami、ari、aki、bare、docker、ova、ovf です。デフォルトの形式は bare です。

-h, --help

ヘルプメッセージを表示して終了します。

--tag <tag>

このイメージにタグを設定します (複数のタグを設定する場合はオプションを繰り返し使用します)。

--public

イメージは一般に公開されます。

--project <project>

このイメージの代替プロジェクトを設定します (名前または ID)。

--protected

イメージが削除されないようにします。

表35.12 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

35.3. image delete

イメージを削除します。

使用方法

openstack image delete [-h] <image> [<image> ...]

表35.13 位置引数

概要

<image>

削除するイメージ (名前または ID)

表35.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

35.4. image list

利用可能なイメージを一覧表示します。

使用方法

openstack image list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--sort-column SORT_COLUMN]
                            [--public | --private | --shared]
                            [--property <key=value>] [--name <name>]
                            [--status <status>] [--long]
                            [--sort <key>[:<direction>]]
                            [--limit <num-images>] [--marker <image>]

表35.15 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表35.16 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表35.17 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表35.18 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表35.19 その他の引数 (オプション):

概要

--public

パブリックイメージのみを一覧表示します。

--private

プライベートイメージのみを一覧表示します。

--name <name>

名前に基づいてイメージをフィルターします。

--property <key=value>

プロパティーに基づいて出力をフィルターします。

--status <status>

ステータスに基づいてイメージをフィルターリングします。

--limit <num-images>

表示するイメージの最大数。

--marker <image>

前のページにある最後のイメージ。マーカーの後にイメージの一覧を表示します。指定されていない場合には、すべてのイメージを表示します (名前または ID)。

--long

出力の追加フィールドを一覧表示します。

--sort <key>[:<direction>]

選択した鍵と方向 (asc または desc) で出力をソートします (デフォルト:name:asc)。複数のキーと方向をコンマで区切ることができます。

--shared

共有イメージのみを一覧表示します。

-h, --help

ヘルプメッセージを表示して終了します。

35.5. image remove project

イメージとプロジェクトの関連付けを解除します。

使用方法

openstack image remove project [-h] [--project-domain <project-domain>]
                                      <image> <project>

表35.20 位置引数

概要

<image>

共有を解除するイメージ (名前または ID)

<project>

イメージとの関連付けを解除するプロジェクト (名前または ID)

表35.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

35.6. image save

イメージをローカルに保存します。

使用方法

openstack image save [-h] [--file <filename>] <image>

表35.22 位置引数

概要

<image>

保存するイメージ (名前または ID)

表35.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--file <filename>

ダウンロードしたイメージを保存するファイル名 (デフォルト:stdout)

35.7. 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>

表35.24 位置引数

概要

<image>

変更するイメージ (名前または ID)

表35.25 その他の引数 (オプション):

概要

--instance-id <instance-id>

このイメージの作成に使用するサーバーインスタンスの ID

--unprotected

イメージの削除を許可します (デフォルト)

--activate

イメージをアクティベートします。

--accept

イメージメンバーシップを許可します。

--community

イメージはコミュニティーに公開されます。

--os-version <os-version>

オペレーティングシステムディストリビューションのバージョン

--private

イメージは一般に公開されません (デフォルト)。

--name <name>

新しいイメージ名

--project <project>

このイメージの代替プロジェクトを設定します (名前または ID)。

--min-ram <ram-mb>

イメージのブートに必要な最小 RAM サイズ (メガバイト単位)

--deactivate

イメージを非アクティブ化します。

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--protected

イメージが削除されないようにします。

--pending

イメージのメンバーシップを 保留中にリセットします。

--os-distro <os-distro>

オペレーティングシステムのディストリビューション名

--architecture <architecture>

オペレーティングシステムのアーキテクチャー

--property <key=value>

このイメージにプロパティーを設定します (複数のプロパティーを設定する場合はオプションを繰り返し使用します)。

--reject

イメージメンバーシップを拒否します。

--shared

イメージを共有可能です。

--min-disk <disk-gb>

イメージのブートに必要な最小ディスクサイズ (ギガバイト単位)

--ramdisk-id <ramdisk-id>

このディスクイメージのブートに使用する ramdisk イメージの ID

--tag <tag>

このイメージにタグを設定します (複数のタグを設定する場合はオプションを繰り返し使用します)。

--public

イメージは一般に公開されます。

--kernel-id <kernel-id>

このディスクイメージのブートに使用するカーネルイメージの ID

--disk-format <disk-format>

イメージディスクの形式。サポートされるオプションは ami、ari、aki、vhd、vmdk、raw、qcow2、vhdx、vdi、iso、ploop です。

--container-format <container-format>

イメージコンテナーの形式。サポートされるオプションは ami、ari、aki、bare、docker、ova、ovf です。

35.8. image show

イメージの詳細を表示します。

使用方法

openstack image show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent] [--prefix PREFIX]
                            [--human-readable]
                            <image>

表35.26 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表35.27 位置引数

概要

<image>

表示するイメージ (名前または ID)

表35.28 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表35.29 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表35.30 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--human-readable

人間が解読しやすい形式でイメージサイズを出力します。

表35.31 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

35.9. image unset

イメージタグおよび属性の設定を解除します。

使用方法

openstack image unset [-h] [--tag <tag>] [--property <property-key>]
                             <image>

表35.32 位置引数

概要

<image>

変更するイメージ (名前または ID)

表35.33 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <property-key>

このイメージのプロパティーの設定を解除します (複数のプロパティー設定を解除する場合はオプションを繰り返し使用します)。

--tag <tag>

このイメージのタグ設定を解除します (複数のタグの設定を解除する場合はオプションを繰り返し使用します)。

第36章 ip

本章では、ip コマンドに含まれるコマンドについて説明します。

36.1. ip availability list

ネットワークの IP の可用性を一覧表示します。

使用方法

openstack ip availability list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--ip-version <ip-version>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]

表36.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表36.2 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表36.3 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表36.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表36.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--ip-version <ip-version>

指定した ip バージョンのネットワーク (デフォルトは 4) の ip の可用性を一覧表示します。

--project <project>

指定されたプロジェクトの ip の可用性を一覧表示します (名前または ID)。

36.2. ip availability show

ネットワーク IP の可用性の詳細を表示します。

使用方法

openstack ip availability show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      <network>

表36.6 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表36.7 位置引数

概要

<network>

特定のネットワークの ip 可用性を表示します (名前または ID)。

表36.8 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表36.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表36.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表36.11 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第37章 keypair

本章では、keypair コマンドに含まれるコマンドについて説明します。

37.1. keypair create

サーバーの ssh アクセス用に新しい公開鍵または秘密鍵を作成します。

使用方法

openstack keypair create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                [--public-key <file> | --private-key <file>]
                                <name>

表37.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表37.2 位置引数

概要

<name>

新しい公開鍵または秘密鍵名

表37.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表37.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表37.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--public-key <file>

追加する公開鍵のファイル名。使用されていない場合は、秘密鍵を作成します。

--private-key <file>

保存する秘密鍵のファイル名。使用されていない場合は、秘密鍵をコンソールに出力します。

表37.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

37.2. keypair delete

公開鍵または秘密鍵を削除します。

使用方法

openstack keypair delete [-h] <key> [<key> ...]

表37.7 位置引数

概要

<key>

削除する鍵の名前 (名前のみ)

表37.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

37.3. keypair list

鍵のフィンガープリントを一覧表示します。

使用方法

openstack keypair list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN]

表37.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表37.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表37.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表37.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表37.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

37.4. keypair show

鍵の詳細を表示します。

使用方法

openstack keypair show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [--public-key]
                              <key>

表37.14 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表37.15 位置引数

概要

<key>

表示する公開鍵または秘密鍵 (名前のみ)

表37.16 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表37.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表37.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--public-key

生成された鍵とペアになったベア公開鍵のみを表示します。

表37.19 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第38章 limits

本章では、limits コマンドに含まれるコマンドについて説明します。

38.1. limits show

コンピュートおよびブロックストレージの制限を表示します。

使用方法

openstack limits show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] (--absolute | --rate)
                             [--reserved] [--project <project>]
                             [--domain <domain>]

表38.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表38.2 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表38.3 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表38.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表38.5 その他の引数 (オプション):

概要

--reserved

予約数を含めます [--absolute と共に使用する場合にのみ有効]。

--project <project>

特定のプロジェクト (名前または ID) の制限を表示します [--absolute と共に使用する場合にのみ有効]。

--rate

流量制御の表示

-h, --help

ヘルプメッセージを表示して終了します。

--absolute

絶対制限を表示します。

--domain <domain>

プロジェクトが属するドメイン (名前または ID)[--absolute と共に使用する場合にのみ有効]。

第39章 loadbalancer

本章では、loadbalancer コマンドに含まれるコマンドについて説明します。

39.1. loadbalancer amphora list

amphora を一覧表示します。

使用方法

openstack loadbalancer amphora list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           [--loadbalancer <loadbalancer>]
                                           [--compute-id <compute-id>]
                                           [--role {MASTER,BACKUP,STANDALONE}]
                                           [--status {PENDING_DELETE,DELETED,ERROR,PENDING_CREATE,BOOTING,READY,ALLOCATED}]

表39.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.2 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表39.3 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表39.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.5 その他の引数 (オプション):

概要

--role {MASTER,BACKUP,STANDALONE}

ロールでフィルターリングします。

--loadbalancer <loadbalancer>

ロードバランサーでフィルターリングします (名前または ID)。

-h, --help

ヘルプメッセージを表示して終了します。

--status {PENDING_DELETE,DELETED,ERROR,PENDING_CREATE,BOOTING,READY,ALLOCATED}, --provisioning-status {PENDING_DELETE,DELETED,ERROR,PENDING_CREATE,BOOTING,READY,ALLOCATED}

amphora のプロビジョニングステータスでフィルターリングします。

--compute-id <compute-id>

コンピュート ID でフィルターリングします。

39.2. loadbalancer amphora show

1 つの amphora の詳細を表示します。

使用方法

openstack loadbalancer amphora show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           <amphora-id>

表39.6 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.7 位置引数

概要

<amphora-id>

amphora の UUID

表39.8 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表39.11 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.3. loadbalancer create

ロードバランサーを作成します。

使用方法

openstack loadbalancer create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--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>]
                                     [--enable | --disable]

表39.12 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.13 VIP ネットワーク

概要

--vip-network-id <vip_network_id>

ロードバランサーにネットワークを設定します (名前または id)。

--vip-subnet-id <vip_subnet_id>

ロードバランサーにサブネットを設定します (名前または ID)。

少なくとも以下の引数のいずれかが必要です。--vip-port-id <vip_port_id>

ロードバランサーのポートを設定します (名前または id)。

表39.14 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.15 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.16 その他の引数 (オプション):

概要

--disable

ロードバランサーを無効にします。

--vip-qos-policy-id <vip_qos_policy_id>

vip port に qos policy id を設定します。設定を解除する場合は none にします。

--enable

ロードバランサーを有効にします (デフォルト)。

--name <name>

新しいロードバランサー名。

--vip-address <vip_address>

vip ip アドレスを設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ロードバランサーの説明を設定します。

--project <project>

ロードバランサーのプロジェクト (名前または id)。

表39.17 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.4. loadbalancer delete

ロードバランサーを削除します。

使用方法

openstack loadbalancer delete [-h] [--cascade] <load_balancer>

表39.18 位置引数

概要

<load_balancer>

削除するロードバランサー (名前または ID)

表39.19 その他の引数 (オプション):

概要

--cascade

削除をロードバランサーのすべての子要素に適用します。

-h, --help

ヘルプメッセージを表示して終了します。

39.5. loadbalancer failover

ロードバランサーのフェイルオーバーをトリガーします。

使用方法

openstack loadbalancer failover [-h] <load_balancer>

表39.20 位置引数

概要

<load_balancer>

ロードバランサーの名前または uuid

表39.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

39.6. loadbalancer healthmonitor create

ヘルスモニターを作成します。

使用方法

openstack loadbalancer healthmonitor create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX]
                                                   [--name <name>] --delay
                                                   <delay>
                                                   [--expected-codes <codes>]
                                                   [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
                                                   --timeout <timeout>
                                                   --max-retries <max_retries>
                                                   [--url-path <url_path>]
                                                   --type
                                                   {PING,HTTP,TCP,HTTPS,TLS-HELLO}
                                                   [--max-retries-down <max_retries_down>]
                                                   [--enable | --disable]
                                                   <pool>

表39.22 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.23 位置引数

概要

<pool>

ヘルスモニターのプールを設定します (名前または ID)。

表39.24 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.26 その他の引数 (オプション):

概要

--disable

ヘルスモニターを無効にします。

--timeout <timeout>

モニターが接続を待つ最大のタイムアウト時間を秒単位で設定します。この値は delay 値よりも小さくなければなりません。

--enable

ヘルスモニターを有効にします (デフォルト)。

--name <name>

ヘルスモニター名を設定します。

--max-retries <max_retries>

メンバーの稼働ステータスを ONLINE に変更するのに必要な正常なチェックの数。

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

ヘルスモニターがリクエストに使用する http メソッドを設定します。

--expected-codes <codes>

正常であることを宣言するためのメンバーからの応答で予想される http ステータスコードの一覧を設定します。

--type {PING,HTTP,TCP,HTTPS,TLS-HELLO}

ヘルスモニターのタイプを設定します。

--delay <delay>

プローブをメンバーに送信する間隔を秒単位で設定します。

--max-retries-down <max_retries_down>

メンバーのオペレーティングステータスを ERROR に変更する前に許容されるチェックの失敗数を設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--url-path <url_path>

バックエンドメンバーの健全性をテストするためにモニターによって送信されるリクエストの http url パスを設定します。

表39.27 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.7. loadbalancer healthmonitor delete

ヘルスモニターを削除します。

使用方法

openstack loadbalancer healthmonitor delete [-h] <health_monitor>

表39.28 位置引数

概要

<health_monitor>

削除するヘルスモニター (名前または ID)

表39.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

39.8. loadbalancer healthmonitor list

ヘルスモニターを一覧表示します。

使用方法

openstack loadbalancer healthmonitor list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]

表39.30 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.31 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表39.32 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表39.33 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.34 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

39.9. loadbalancer healthmonitor set

ヘルスモニターを更新します。

使用方法

openstack loadbalancer healthmonitor set [-h] [--name <name>]
                                                [--delay <delay>]
                                                [--expected-codes <codes>]
                                                [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
                                                [--timeout <timeout>]
                                                [--max-retries <max_retries>]
                                                [--max-retries-down <max_retries_down>]
                                                [--url-path <url_path>]
                                                [--enable | --disable]
                                                <health_monitor>

表39.35 位置引数

概要

<health_monitor>

更新するヘルスモニター (名前または ID)

表39.36 その他の引数 (オプション):

概要

--disable

ヘルスモニターを無効にします。

--timeout <timeout>

モニターが接続を待つ最大のタイムアウト時間を秒単位で設定します。この値は delay 値よりも小さくなければなりません。

--enable

ヘルスモニターを有効にします。

--name <name>

ヘルスモニター名を設定します。

--max-retries <max_retries>

メンバーの稼働ステータスを ONLINE に変更するのに必要な正常なチェックの数を設定します。

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

ヘルスモニターがリクエストに使用する http メソッドを設定します。

--expected-codes <codes>

正常であることを宣言するためのメンバーからの応答で予想される http ステータスコードの一覧を設定します。

--delay <delay>

プローブをメンバーに送信する間隔を秒単位で設定します。

--max-retries-down <max_retries_down>

メンバーのオペレーティングステータスを ERROR に変更する前に許容されるチェックの失敗数を設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--url-path <url_path>

バックエンドメンバーの健全性をテストするためにモニターによって送信されるリクエストの http url パスを設定します。

39.10. loadbalancer healthmonitor show

単一のヘルスモニターの詳細を表示します。

使用方法

openstack loadbalancer healthmonitor show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 <health_monitor>

表39.37 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.38 位置引数

概要

<health_monitor>

ヘルスモニターの名前または uuid。

表39.39 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.40 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.41 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表39.42 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.11. loadbalancer l7policy create

l7policy を作成します。

使用方法

openstack loadbalancer l7policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--name <name>]
                                              [--description <description>]
                                              --action
                                              {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT}
                                              [--redirect-pool <pool> | --redirect-url <url>]
                                              [--position <position>]
                                              [--enable | --disable]
                                              <listener>

表39.43 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.44 位置引数

概要

<listener>

l7policy をに追加するリスナー (名前または id)。

表39.45 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.46 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.47 その他の引数 (オプション):

概要

--position <position>

この l7 ポリシーのシーケンス番号。

--disable

l7policy を無効にします。

--enable

l7policy を有効にします (デフォルト)。

--name <name>

l7policy 名を設定します。

--redirect-pool <pool>

要求をリダイレクトするプールを設定します (名前または ID)。

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT}

ポリシーのアクションを設定します。

--redirect-url <url>

要求のリダイレクト先となる URL を設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

l7policy の説明を設定します。

表39.48 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.12. loadbalancer l7policy delete

l7policy を削除します。

使用方法

openstack loadbalancer l7policy delete [-h] <policy>

表39.49 位置引数

概要

<policy>

削除する L7policy(名前または ID)。

表39.50 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

39.13. loadbalancer l7policy list

l7policies を一覧表示します。

使用方法

openstack loadbalancer l7policy list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]

表39.51 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.52 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表39.53 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表39.54 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.55 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

39.14. loadbalancer l7policy set

l7policy を更新します。

使用方法

openstack loadbalancer l7policy set [-h] [--name <name>]
                                           [--description <description>]
                                           [--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT}]
                                           [--redirect-pool <pool> | --redirect-url <url>]
                                           [--position <position>]
                                           [--enable | --disable]
                                           <policy>

表39.56 位置引数

概要

<policy>

更新する L7policy(名前または ID)。

表39.57 その他の引数 (オプション):

概要

--position <position>

この l7 ポリシーのシーケンス番号を設定します。

--disable

l7policy を無効にします。

--enable

l7policy を有効にします。

--name <name>

l7policy 名を設定します。

--redirect-pool <pool>

要求をリダイレクトするプールを設定します (名前または ID)。

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT}

ポリシーのアクションを設定します。

--redirect-url <url>

要求のリダイレクト先となる URL を設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

l7policy の説明を設定します。

39.15. loadbalancer l7policy show

1 つの l7policy の詳細を表示します。

使用方法

openstack loadbalancer l7policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            <policy>

表39.58 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.59 位置引数

概要

<policy>

l7policy の名前または uuid

表39.60 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.61 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.62 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表39.63 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.16. loadbalancer l7rule create

l7rule を作成します。

使用方法

openstack loadbalancer l7rule create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            --compare-type
                                            {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}
                                            [--invert] --value <value>
                                            [--key <key>] --type
                                            {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER}
                                            [--enable | --disable]
                                            <l7policy>

表39.64 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.65 位置引数

概要

<l7policy>

l7rule を追加する L7policy(名前または ID)。

表39.66 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.67 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.68 その他の引数 (オプション):

概要

--value <value>

照合するルールの値を設定します。

--enable

l7rule を有効にします (デフォルト)。

--invert

l7rule を反転します。

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER}

l7rule のタイプを設定します。

--key <key>

照合する l7rule の値のキーを設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

l7rule を無効にします。

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

l7rule の比較タイプを設定します。

表39.69 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.17. loadbalancer l7rule delete

l7rule を削除します。

使用方法

openstack loadbalancer l7rule delete [-h] <l7policy> <rule_id>

表39.70 位置引数

概要

<l7policy>

ルールを削除する L7policy(名前または ID)

<rule_id>

削除する L7rule。

表39.71 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

39.18. loadbalancer l7rule list

l7policy の l7rules を一覧表示します。

使用方法

openstack loadbalancer l7rule list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN]
                                          <l7policy>

表39.72 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.73 位置引数

概要

<l7policy>

ルールを一覧表示する L7policy(名前または ID)

表39.74 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表39.75 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表39.76 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.77 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

39.19. 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}]
                                         [--enable | --disable]
                                         <l7policy> <l7rule_id>

表39.78 位置引数

概要

<l7policy>

l7rule を更新する l7policy(名前または id)

<l7rule_id>

更新する L7rule。

表39.79 その他の引数 (オプション):

概要

--value <value>

照合するルールの値を設定します。

--enable

l7rule を有効にします。

--invert

l7rule を反転します。

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER}

l7rule のタイプを設定します。

--key <key>

照合する l7rule の値のキーを設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

l7rule を無効にします。

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

l7rule の比較タイプを設定します。

39.20. loadbalancer l7rule show

1 つの l7rule の詳細を表示します。

使用方法

openstack loadbalancer l7rule show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          <l7policy> <l7rule_id>

表39.80 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.81 位置引数

概要

<l7policy>

ルールを表示する L7policy(名前または ID)。

<l7rule_id>

表示する L7rule。

表39.82 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.83 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.84 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表39.85 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.21. loadbalancer list

ロードバランサーを一覧表示します。

使用方法

openstack loadbalancer list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN] [--name <name>]
                                   [--enable | --disable]
                                   [--project <project-id>]

表39.86 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.87 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表39.88 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表39.89 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.90 その他の引数 (オプション):

概要

--name <name>

名前に従ってロードバランサーを一覧表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

無効にされたロードバランサーを一覧表示します。

--project <project-id>

プロジェクトに従ってロードバランサーを一覧表示します (名前または ID)。

--enable

有効なロードバランサーを一覧表示します。

39.22. loadbalancer listener create

リスナーを作成します。

使用方法

openstack loadbalancer listener create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--name <name>]
                                              [--description <description>]
                                              --protocol
                                              {TCP,HTTP,HTTPS,TERMINATED_HTTPS}
                                              [--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>
                                              [--enable | --disable]
                                              <loadbalancer>

表39.91 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.92 位置引数

概要

<loadbalancer>

リスナーのロードバランサー (名前または id)

表39.93 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.94 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.95 その他の引数 (オプション):

概要

--protocol-port <port>

リスナーのプロトコルポート番号を設定します。

--disable

リスナーを無効にします。

--connection-limit <limit>

このリスナーで許可される接続の最大数を設定します。

--name <name>

リスナー名を設定します。

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS}

リスナーのプロトコル。

--enable

リスナーを有効にします (デフォルト)。

--sni-container-refs [<container_ref> [<container_ref> …​]]

Server Name Indication を使用する TERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI の一覧。

--default-pool <pool>

L7 ポリシーが一致しない場合、リスナーによって使用されるプールの名前または ID を設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

このリスナーの説明を設定します。

--insert-headers <header=value,…​>

バックエンドメンバーに送信される前にリクエストに挿入するオプションヘッダーのディクショナリー。

--default-tls-container-ref <container_ref>

TERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI。

表39.96 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.23. loadbalancer listener delete

リスナーを削除します。

使用方法

openstack loadbalancer listener delete [-h] <listener>

表39.97 位置引数

概要

<listener>

削除するリスナー (名前または ID)

表39.98 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

39.24. loadbalancer listener list

リスナーの一覧を表示します。

使用方法

openstack loadbalancer listener list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]
                                            [--name <name>]
                                            [--loadbalancer <loadbalancer>]
                                            [--enable | --disable]
                                            [--project <project>]

表39.99 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.100 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表39.101 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表39.102 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.103 その他の引数 (オプション):

概要

--enable

有効なリスナーを一覧表示します。

--name <name>

リスナー名でリスナーを一覧表示します。

--loadbalancer <loadbalancer>

ロードバランサーでフィルターリングします (名前または ID)。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

無効なリスナーを一覧表示します。

--project <project>

プロジェクト ID でリスナーを一覧表示します。

39.25. 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>]
                                           [--enable | --disable]
                                           <listener>

表39.104 位置引数

概要

<listener>

変更するリスナー (名前または ID)。

表39.105 その他の引数 (オプション):

概要

--disable

リスナーを無効にします。

--connection-limit <limit>

このリスナーで許可される接続の最大数。デフォルト値は -1 で、無限接続を表します。

--default-pool <pool>

l7 ポリシーが一致していない場合、リスナーによって使用されるプールの ID。

--enable

リスナーを有効にします。

--insert-headers <header=value>

バックエンドメンバーに送信される前にリクエストに挿入するオプションヘッダーのディクショナリー。

--name <name>

リスナー名を設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

このリスナーの説明を設定します。

--default-tls-container-ref <container-ref>

TERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--sni-container-refs [<container-ref> [<container-ref> …​]]

Server Name Indication を使用する TERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI の一覧。

39.26. loadbalancer listener show

単一のリスナーの詳細を表示します。

使用方法

openstack loadbalancer listener show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            <listener>

表39.106 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.107 位置引数

概要

<listener>

リスナーの名前または uuid

表39.108 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.109 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.110 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表39.111 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.27. loadbalancer listener stats show

リスナーの現在の統計を表示します。

使用方法

openstack loadbalancer listener stats show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty] [--noindent]
                                                  [--prefix PREFIX]
                                                  <listener>

表39.112 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.113 位置引数

概要

<listener>

リスナーの名前または uuid

表39.114 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.115 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.116 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表39.117 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.28. loadbalancer member create

プールにメンバーを作成します。

使用方法

openstack loadbalancer member create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            [--name <name>]
                                            [--weight <weight>] --address
                                            <ip_address>
                                            [--subnet-id <subnet_id>]
                                            --protocol-port <protocol_port>
                                            [--monitor-port <monitor_port>]
                                            [--monitor-address <monitor_address>]
                                            [--enable | --disable]
                                            <pool>

表39.118 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.119 位置引数

概要

<pool>

メンバーを作成するプールの ID または名前。

表39.120 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.121 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.122 その他の引数 (オプション):

概要

--protocol-port <protocol_port>

バックエンドメンバーサーバーがリッスンするプロトコルポート番号。

--enable

メンバーを有効にします (デフォルト)。

--name <name>

メンバーの名前。

--monitor-port <monitor_port>

バックエンドメンバーの正常性モニターリングに使用する別のプロトコルポート。

--subnet-id <subnet_id>

メンバーサービスがアクセスできるサブネット ID。

--monitor-address <monitor_address>

バックエンドメンバーの正常性モニターリングに使用する別の IP アドレス。

--address <ip_address>

バックエンドメンバーサーバーの IP アドレス

-h, --help

ヘルプメッセージを表示して終了します。

--disable

メンバーを無効にします。

--weight <weight>

プールの他のメンバーと比較して、提供する要求または接続の部分を決定するメンバーの重み。

表39.123 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.29. loadbalancer member delete

プールからメンバーを削除します。

使用方法

openstack loadbalancer member delete [-h] <pool> <member>

表39.124 位置引数

概要

<member>

削除するメンバーの名前または ID。

<pool>

メンバーを削除するプール名または id。

表39.125 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

39.30. loadbalancer member list

プール内のメンバーを一覧表示します。

使用方法

openstack loadbalancer member list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN]
                                          <pool>

表39.126 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.127 位置引数

概要

<pool>

メンバーを一覧表示するプール名または id。

表39.128 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表39.129 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表39.130 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.131 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

39.31. loadbalancer member set

メンバーを更新します。

使用方法

openstack loadbalancer member set [-h] [--name <name>]
                                         [--weight <weight>]
                                         [--monitor-port <monitor_port>]
                                         [--monitor-address <monitor_address>]
                                         [--enable | --disable]
                                         <pool> <member>

表39.132 位置引数

概要

<member>

更新するメンバーの名前または ID

<pool>

更新するメンバーが属するプール (名前または ID)。

表39.133 その他の引数 (オプション):

概要

--enable

admin_state_up を true に設定します。

--name <name>

メンバーの名前を設定します。

--monitor-port <monitor_port>

バックエンドメンバーの正常性モニターリングに使用する別のプロトコルポート。

--monitor-address <monitor_address>

バックエンドメンバーの正常性モニターリングに使用する別の IP アドレス。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

admin_state_up を false に設定します。

--weight <weight>

プール内のメンバーの重みを設定します。

39.32. loadbalancer member show

1 つのメンバーの詳細を表示します。

使用方法

openstack loadbalancer member show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          <pool> <member>

表39.134 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.135 位置引数

概要

<member>

表示するメンバーの名前または ID。

<pool>

メンバーを表示するプール名または id。

表39.136 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.137 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.138 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表39.139 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.33. loadbalancer pool create

プールを作成します。

使用方法

openstack loadbalancer pool create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [--name <name>]
                                          [--description <description>]
                                          --protocol
                                          {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY}
                                          (--listener <listener> | --loadbalancer <load_balancer>)
                                          [--session-persistence <session persistence>]
                                          --lb-algorithm
                                          {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}
                                          [--enable | --disable]

表39.140 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.141 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.142 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.143 その他の引数 (オプション):

概要

--disable

プールを無効にします。

--enable

プールを有効にします (デフォルト)。

--name <name>

プール名を設定します。

--loadbalancer <load_balancer>

プールを追加するロードバランサー (名前または ID)

--session-persistence <session persistence>

リスナーのセッション永続性を設定します (key=value)。

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY}

プールプロトコルを設定します。

--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}

使用するロードバランシングアルゴリズム。

--listener <listener>

プールを追加するリスナー (名前または ID)。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

プールの説明を設定します。

表39.144 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.34. loadbalancer pool delete

プールを削除します。

使用方法

openstack loadbalancer pool delete [-h] <pool>

表39.145 位置引数

概要

<pool>

削除するプール (名前または ID)

表39.146 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

39.35. loadbalancer pool list

プールを一覧表示します。

使用方法

openstack loadbalancer pool list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--loadbalancer <loadbalancer>]

表39.147 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.148 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表39.149 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表39.150 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.151 その他の引数 (オプション):

概要

--loadbalancer <loadbalancer>

ロードバランサーでフィルターリングします (名前または ID)。

-h, --help

ヘルプメッセージを表示して終了します。

39.36. 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]
                                       <pool>

表39.152 位置引数

概要

<pool>

更新するプール (名前または ID)。

表39.153 その他の引数 (オプション):

概要

--disable

プールを無効にします。

--enable

プールを有効にします。

--name <name>

プールの名前を設定します。

--session-persistence <session_persistence>

リスナーのセッション永続性を設定します (key=value)。

--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}

使用するロードバランシングアルゴリズムを設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

プールの説明を設定します。

39.37. loadbalancer pool show

単一プールの詳細を表示します。

使用方法

openstack loadbalancer pool show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        <pool>

表39.154 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.155 位置引数

概要

<pool>

プールの名前または uuid。

表39.156 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.157 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.158 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表39.159 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.38. loadbalancer quota defaults show

クォータのデフォルトを表示します。

使用方法

openstack loadbalancer quota defaults show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty] [--noindent]
                                                  [--prefix PREFIX]

表39.160 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.161 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.162 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.163 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表39.164 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.39. loadbalancer quota list

クォータを一覧表示します。

使用方法

openstack loadbalancer quota list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         [--project <project-id>]

表39.165 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.166 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表39.167 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表39.168 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.169 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project-id>

プロジェクトの名前または uuid。

39.40. loadbalancer quota reset

クォータをデフォルトのクォータにリセットします。

使用方法

openstack loadbalancer quota reset [-h] <project>

表39.170 位置引数

概要

<project>

クォータをリセットするプロジェクト (名前または ID)

表39.171 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

39.41. loadbalancer quota set

クォータを更新します。

使用方法

openstack loadbalancer quota set [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--healthmonitor <health_monitor>]
                                        [--listener <listener>]
                                        [--loadbalancer <load_balancer>]
                                        [--member <member>] [--pool <pool>]
                                        <project>

表39.172 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.173 位置引数

概要

<project>

プロジェクトの名前または uuid。

表39.174 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.175 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.176 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表39.177 クォータの制限

概要

--member <member>

メンバークォータ制限の新しい値。値が -1 の場合は無制限を意味します。

以下の引数のいずれかが必要です。--healthmonitor <health_monitor>

ヘルスモニタークォータの新しい値。値が -1 の場合は無制限を意味します。

--loadbalancer <load_balancer>

ロードバランサークォータ制限の新しい値。値が -1 の場合は無制限を意味します。

--pool <pool>

プールクォータ制限の新しい値。値が -1 の場合は無制限を意味します。

--listener <listener>

リスナークォータの新しい値。値が -1 の場合は無制限を意味します。

表39.178 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.42. loadbalancer quota show

プロジェクトのクォータの詳細を表示します。

使用方法

openstack loadbalancer quota show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         <project>

表39.179 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.180 位置引数

概要

<project>

プロジェクトの名前または uuid。

表39.181 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.182 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.183 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表39.184 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.43. loadbalancer set

ロードバランサーを更新します。

使用方法

openstack loadbalancer set [-h] [--name <name>]
                                  [--description <description>]
                                  [--vip-qos-policy-id <vip_qos_policy_id>]
                                  [--enable | --disable]
                                  <load_balancer>

表39.185 位置引数

概要

<load_balancer>

更新するロードバランサーの名前または uuid

表39.186 その他の引数 (オプション):

概要

--description <description>

ロードバランサーの説明を設定します。

--vip-qos-policy-id <vip_qos_policy_id>

vip port に qos policy id を設定します。設定を解除する場合は none にします。

--enable

ロードバランサーを有効にします。

--name <name>

ロードバランサー名を設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

ロードバランサーを無効にします。

39.44. loadbalancer show

単一のロードバランサーの詳細を表示します。

使用方法

openstack loadbalancer show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   <load_balancer>

表39.187 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.188 位置引数

概要

<load_balancer>

ロードバランサーの名前または uuid

表39.189 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.190 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.191 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表39.192 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.45. loadbalancer stats show

ロードバランサーの現在の統計を表示します。

使用方法

openstack loadbalancer stats show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         <load_balancer>

表39.193 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表39.194 位置引数

概要

<load_balancer>

ロードバランサーの名前または uuid

表39.195 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表39.196 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.197 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表39.198 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第40章 messaging

本章では、messaging コマンドに含まれるコマンドについて説明します。

40.1. messaging claim create

要求を作成し、要求されたメッセージの一覧を返します。

使用方法

openstack messaging claim create [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--ttl <ttl>] [--grace <grace>]
                                        [--limit <limit>]
                                        <queue_name>

表40.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.2 位置引数

概要

<queue_name>

要求するキューの名前

表40.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表40.4 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表40.5 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.6 その他の引数 (オプション):

概要

--limit <limit>

制限まで、メッセージのセットを要求します。

-h, --help

ヘルプメッセージを表示して終了します。

--grace <grace>

メッセージの猶予期間 (秒単位)

--ttl <ttl>

要求の存続期間 (秒単位)

40.2. messaging claim query

要求の詳細を表示します。

使用方法

openstack messaging claim query [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN]
                                       <queue_name> <claim_id>

表40.7 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.8 位置引数

概要

<claim_id>

要求の ID

<queue_name>

要求されたキューの名前

表40.9 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表40.10 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表40.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

40.3. messaging claim release

要求を削除します。

使用方法

openstack messaging claim release [-h] <queue_name> <claim_id>

表40.13 位置引数

概要

<claim_id>

削除する要求 ID

<queue_name>

要求されたキューの名前

表40.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

40.4. messaging claim renew

要求を更新します。

使用方法

openstack messaging claim renew [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN]
                                       [--ttl <ttl>] [--grace <grace>]
                                       <queue_name> <claim_id>

表40.15 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.16 位置引数

概要

<claim_id>

要求 ID

<queue_name>

要求されたキューの名前

表40.17 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表40.18 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表40.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--grace <grace>

メッセージの猶予期間 (秒単位)

--ttl <ttl>

要求の存続期間 (秒単位)

40.5. messaging flavor create

プールのフレーバーを作成します。

使用方法

openstack messaging flavor create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         [--capabilities <capabilities>]
                                         <flavor_name> <pool_group>

表40.21 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.22 位置引数

概要

<pool_group>

フレーバーのプールグループ

<flavor_name>

フレーバーの名前

表40.23 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.24 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.25 その他の引数 (オプション):

概要

--capabilities <capabilities>

フレーバー固有の機能を記述します。このオプションはクライアント api バージョン が 2 より前の場合のみ利用可能です。

-h, --help

ヘルプメッセージを表示して終了します。

表40.26 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.6. messaging flavor delete

プールのフレーバーを削除します。

使用方法

openstack messaging flavor delete [-h] <flavor_name>

表40.27 位置引数

概要

<flavor_name>

フレーバーの名前

表40.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

40.7. messaging flavor list

利用可能なプールのフレーバーを一覧表示します。

使用方法

openstack messaging flavor list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN]
                                       [--marker <flavor_name>]
                                       [--limit <limit>] [--detailed]

表40.29 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.30 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表40.31 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表40.32 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.33 その他の引数 (オプション):

概要

--detailed

フレーバーの詳細な機能を表示する場合

--limit <limit>

ページサイズの制限

-h, --help

ヘルプメッセージを表示して終了します。

--marker <flavor_name>

フレーバーのページングマーカー

40.8. messaging flavor show

プールフレーバーの詳細を表示します。

使用方法

openstack messaging flavor show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       <flavor_name>

表40.34 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.35 位置引数

概要

<flavor_name>

表示するフレーバー (名前)

表40.36 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.37 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.38 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表40.39 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.9. messaging flavor update

フレーバーの属性を更新します。

使用方法

openstack messaging flavor update [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         [--pool_group <pool_group>]
                                         [--capabilities <capabilities>]
                                         <flavor_name>

表40.40 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.41 位置引数

概要

<flavor_name>

フレーバーの名前

表40.42 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.43 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.44 その他の引数 (オプション):

概要

--pool_group <pool_group>

フレーバーが存在するプールグループ

-h, --help

ヘルプメッセージを表示して終了します。

--capabilities <capabilities>

フレーバー固有の機能を説明します。

表40.45 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.10. messaging health

Zaqar サーバーの詳細なヘルスステータスを表示します。

使用方法

openstack messaging health [-h]

表40.46 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

40.11. messaging homedoc

Zaqar サーバーの詳細なリソースドキュメントを表示します。

使用方法

openstack messaging homedoc [-h]

表40.47 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

40.12. messaging message list

指定のキューのすべてのメッセージを一覧表示します。

使用方法

openstack messaging message list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--message-ids <message_ids>]
                                        [--limit <limit>] [--echo]
                                        [--include-claimed]
                                        [--include-delayed]
                                        [--client-id <client_id>]
                                        <queue_name>

表40.48 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.49 位置引数

概要

<queue_name>

キューの名前

表40.50 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表40.51 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表40.52 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.53 その他の引数 (オプション):

概要

--client-id <client_id>

各クライアントインスタンスの UUID。

--limit <limit>

取得するメッセージの最大数。

--echo

このクライアント自体のメッセージを受信するかどうか。

--message-ids <message_ids>

取得するメッセージの ID の一覧

-h, --help

ヘルプメッセージを表示して終了します。

--include-delayed

遅延メッセージを含めるかどうか。

--include-claimed

要求されたメッセージを含めるかどうか。

40.13. messaging message post

指定のキューのメッセージを投稿します。

使用方法

openstack messaging message post [-h] [--client-id <client_id>]
                                        <queue_name> <messages>

表40.54 位置引数

概要

<messages>

投稿されるメッセージ。

<queue_name>

キューの名前

表40.55 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--client-id <client_id>

各クライアントインスタンスの UUID。

40.14. messaging ping

Zaqar サーバーが稼働しているかどうかを確認します。

使用方法

openstack messaging ping [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]

表40.56 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.57 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.58 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.59 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表40.60 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.15. messaging pool create

プールを作成します。

使用方法

openstack messaging pool create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--pool_group <pool_group>]
                                       [--pool_options <pool_options>]
                                       <pool_name> <pool_uri> <pool_weight>

表40.61 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.62 位置引数

概要

<pool_weight>

プールの重み

<pool_name>

プールの名前

<pool_uri>

ストレージエンジン URI

表40.63 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.64 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.65 その他の引数 (オプション):

概要

--pool_group <pool_group>

プールのグループ

-h, --help

ヘルプメッセージを表示して終了します。

--pool_options <pool_options>

ストレージ固有のオプションに関連するオプションの要求コンポーネント

表40.66 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.16. messaging pool delete

プールを削除します。

使用方法

openstack messaging pool delete [-h] <pool_name>

表40.67 位置引数

概要

<pool_name>

プールの名前

表40.68 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

40.17. messaging pool list

利用可能なプールを一覧表示します。

使用方法

openstack messaging pool list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--marker <pool_name>] [--limit <limit>]
                                     [--detailed]

表40.69 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.70 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表40.71 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表40.72 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.73 その他の引数 (オプション):

概要

--detailed

詳細出力

--limit <limit>

ページサイズの制限

-h, --help

ヘルプメッセージを表示して終了します。

--marker <pool_name>

プールのページングマーカー

40.18. messaging pool show

プールの詳細を表示します。

使用方法

openstack messaging pool show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <pool_name>

表40.74 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.75 位置引数

概要

<pool_name>

表示するプール (名前)

表40.76 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.77 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.78 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表40.79 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.19. messaging pool update

プール属性を更新します。

使用方法

openstack messaging pool update [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--pool_uri <pool_uri>]
                                       [--pool_weight <pool_weight>]
                                       [--pool_group <pool_group>]
                                       [--pool_options <pool_options>]
                                       <pool_name>

表40.80 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.81 位置引数

概要

<pool_name>

プールの名前

表40.82 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.83 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.84 その他の引数 (オプション):

概要

--pool_group <pool_group>

プールのグループ

-h, --help

ヘルプメッセージを表示して終了します。

--pool_options <pool_options>

ストレージ固有のオプションに関連するオプションの要求コンポーネント

--pool_uri <pool_uri>

ストレージエンジン URI

--pool_weight <pool_weight>

プールの重み

表40.85 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.20. messaging queue create

キューを作成します。

使用方法

openstack messaging queue create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        <queue_name>

表40.86 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.87 位置引数

概要

<queue_name>

キューの名前

表40.88 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.89 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.90 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表40.91 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.21. messaging queue delete

キューを削除します。

使用方法

openstack messaging queue delete [-h] <queue_name>

表40.92 位置引数

概要

<queue_name>

キューの名前

表40.93 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

40.22. messaging queue get metadata

キューのメタデータを取得します。

使用方法

openstack messaging queue get metadata [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              <queue_name>

表40.94 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.95 位置引数

概要

<queue_name>

キューの名前

表40.96 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.97 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.98 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表40.99 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.23. messaging queue list

利用可能なキューを一覧表示します。

使用方法

openstack messaging queue list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--marker <queue_id>] [--limit <limit>]
                                      [--detailed]

表40.100 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.101 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表40.102 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表40.103 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.104 その他の引数 (オプション):

概要

--marker <queue_id>

キューのページングマーカー

--limit <limit>

ページサイズの制限

-h, --help

ヘルプメッセージを表示して終了します。

--detailed

キューの詳細情報を表示する場合

40.24. messaging queue purge

キューをパージします。

使用方法

openstack messaging queue purge [-h]
                                       [--resource_types <resource_types>]
                                       <queue_name>

表40.105 位置引数

概要

<queue_name>

キューの名前

表40.106 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource_types <resource_types>

パージするリソースタイプ。

40.25. messaging queue set metadata

キューのメタデータを設定します。

使用方法

openstack messaging queue set metadata [-h]
                                              <queue_name> <queue_metadata>

表40.107 位置引数

概要

<queue_name>

キューの名前

<queue_metadata>

キューメタデータ。キューのメタデータはすべて queue_metadata に置き換えられます。

表40.108 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

40.26. messaging queue signed url

事前に署名された URL を作成します。

使用方法

openstack messaging queue signed url [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            [--paths <paths>]
                                            [--ttl-seconds <ttl_seconds>]
                                            [--methods <methods>]
                                            <queue_name>

表40.109 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.110 位置引数

概要

<queue_name>

キューの名前

表40.111 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.112 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.113 その他の引数 (オプション):

概要

--ttl-seconds <ttl_seconds>

署名の有効期限が切れるまでの期間 (秒単位)

-h, --help

ヘルプメッセージを表示して終了します。

--paths <paths>

許可されるパスのコンマ区切りリスト。オプション:messages、subscriptions、claims

--methods <methods>

許可する HTTP メソッドのコンマ区切りリスト。オプション:GET、HEAD、OPTIONS、POST、PUT、DELETE

表40.114 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.27. messaging queue stats

キューの統計値を取得します。

使用方法

openstack messaging queue stats [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       <queue_name>

表40.115 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.116 位置引数

概要

<queue_name>

キューの名前

表40.117 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.118 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.119 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表40.120 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.28. messaging subscription create

キューのサブスクリプションを作成します。

使用方法

openstack messaging subscription create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent] [--prefix PREFIX]
                                               [--options <options>]
                                               <queue_name> <subscriber> <ttl>

表40.121 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.122 位置引数

概要

<subscriber>

通知されるサブスクライバー

<ttl>

サブスクリプションの存続期間 (秒単位)

<queue_name>

サブスクライブするキューの名前

表40.123 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.124 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.125 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--options <options>

json 形式のサブスクリプションのメタデータ

表40.126 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.29. messaging subscription delete

サブスクリプションを削除します。

使用方法

openstack messaging subscription delete [-h]
                                               <queue_name> <subscription_id>

表40.127 位置引数

概要

<subscription_id>

サブスクリプションの ID

<queue_name>

サブスクリプションのキューの名前

表40.128 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

40.30. messaging subscription list

利用可能なサブスクリプションを一覧表示します。

使用方法

openstack messaging subscription list [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--sort-column SORT_COLUMN]
                                             [--marker <subscription_id>]
                                             [--limit <limit>]
                                             <queue_name>

表40.129 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.130 位置引数

概要

<queue_name>

サブスクライブするキューの名前

表40.131 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表40.132 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表40.133 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.134 その他の引数 (オプション):

概要

--limit <limit>

ページサイズの制限。デフォルト値は 20 です。

-h, --help

ヘルプメッセージを表示して終了します。

--marker <subscription_id>

サブスクリプションのページングマーカー、前のページにある最後のサブスクリプションの ID

40.31. messaging subscription show

サブスクリプションの詳細を表示します。

使用方法

openstack messaging subscription show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             <queue_name> <subscription_id>

表40.135 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.136 位置引数

概要

<subscription_id>

サブスクリプションの ID

<queue_name>

サブスクライブするキューの名前

表40.137 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.138 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.139 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表40.140 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.32. messaging subscription update

サブスクリプションを更新します。

使用方法

openstack messaging subscription update [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent] [--prefix PREFIX]
                                               [--subscriber <subscriber>]
                                               [--ttl <ttl>]
                                               [--options <options>]
                                               <queue_name> <subscription_id>

表40.141 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表40.142 位置引数

概要

<subscription_id>

サブスクリプションの ID

<queue_name>

サブスクライブするキューの名前

表40.143 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.144 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.145 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--options <options>

json 形式のサブスクリプションのメタデータ

--subscriber <subscriber>

通知されるサブスクライバー

--ttl <ttl>

サブスクリプションの存続期間 (秒単位)

表40.146 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第41章 メトリクス

本章では、metric コマンドに含まれるコマンドについて説明します。

41.1. metric aggregates

集約されたメトリクスの計測値を取得します。

使用方法

openstack metric aggregates [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN]
                                   [--resource-type RESOURCE_TYPE]
                                   [--start START] [--stop STOP]
                                   [--granularity GRANULARITY]
                                   [--needed-overlap NEEDED_OVERLAP]
                                   [--groupby GROUPBY] [--fill FILL]
                                   operations [search]

表41.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.2 位置引数

概要

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 です。

表41.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表41.4 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表41.5 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.6 その他の引数 (オプション):

概要

--groupby GROUPBY

リソースをグループ化するために使用する属性

--fill FILL

シリーズのサブセットに値がない状態でタイムスタンプをバックフィルする際に使用する値。値は浮動小数点または null である必要があります。

--start START

期間の開始

--resource-type RESOURCE_TYPE

問い合わせるリソースタイプ

--stop STOP

期間の終了

--granularity GRANULARITY

取得する際の詳細度

-h, --help

ヘルプメッセージを表示して終了します。

--needed-overlap NEEDED_OVERLAP

データポイント間での重複の割合

41.2. metric archive-policy create

アーカイブポリシーを作成します。

使用方法

openstack metric archive-policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              -d <DEFINITION> [-b BACK_WINDOW]
                                              [-m AGGREGATION_METHODS]
                                              name

表41.7 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.8 位置引数

概要

name

アーカイブポリシーの名前

表41.9 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.10 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.11 その他の引数 (オプション):

概要

-D <DEFINITION>、--definition <DEFINITION>

名前と値を:で区切った、アーカイブポリシー定義の (,で区切られた)2 つの属性

-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS

アーカイブポリシーの集約メソッド

-h, --help

ヘルプメッセージを表示して終了します。

-b BACK_WINDOW, --back-window BACK_WINDOW

アーカイブポリシーのバックウィンドウ

表41.12 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.3. metric archive-policy delete

アーカイブポリシーを削除します。

使用方法

openstack metric archive-policy delete [-h] name

表41.13 位置引数

概要

name

アーカイブポリシーの名前

表41.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

41.4. metric archive-policy list

アーカイブポリシーを一覧表示します。

使用方法

openstack metric archive-policy list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]

表41.15 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.16 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表41.17 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表41.18 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

41.5. metric archive-policy-rule create

アーカイブポリシールールを作成します。

使用方法

openstack metric archive-policy-rule create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX] -a
                                                   ARCHIVE_POLICY_NAME -m
                                                   METRIC_PATTERN
                                                   name

表41.20 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.21 位置引数

概要

name

ルール名

表41.22 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.24 その他の引数 (オプション):

概要

-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME

アーカイブポリシー名

-h, --help

ヘルプメッセージを表示して終了します。

-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN

照合するメトリクス名のワイルドカード

表41.25 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.6. metric archive-policy-rule delete

アーカイブポリシールールを削除します。

使用方法

openstack metric archive-policy-rule delete [-h] name

表41.26 位置引数

概要

name

アーカイブポリシールールの名前

表41.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

41.7. metric archive-policy-rule list

アーカイブポリシールールを一覧表示します。

使用方法

openstack metric archive-policy-rule list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]

表41.28 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.29 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表41.30 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表41.31 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.32 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

41.8. metric archive-policy-rule show

アーカイブポリシールールを表示します。

使用方法

openstack metric archive-policy-rule show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 name

表41.33 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.34 位置引数

概要

name

アーカイブポリシールールの名前

表41.35 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.36 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.37 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表41.38 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.9. metric archive-policy show

アーカイブポリシーを表示します。

使用方法

openstack metric archive-policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            name

表41.39 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.40 位置引数

概要

name

アーカイブポリシーの名前

表41.41 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.42 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.43 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表41.44 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.10. metric archive-policy update

アーカイブポリシーを更新します。

使用方法

openstack metric archive-policy update [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              -d <DEFINITION>
                                              name

表41.45 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.46 位置引数

概要

name

アーカイブポリシーの名前

表41.47 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.48 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.49 その他の引数 (オプション):

概要

-D <DEFINITION>、--definition <DEFINITION>

名前と値を:で区切った、アーカイブポリシー定義の (,で区切られた)2 つの属性

-h, --help

ヘルプメッセージを表示して終了します。

表41.50 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.11. metric benchmark measures add

測定の追加のベンチマークテストを行います。

使用方法

openstack metric benchmark measures add [-h]
                                               [--resource-id RESOURCE_ID]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent] [--prefix PREFIX]
                                               [--workers WORKERS] --count
                                               COUNT [--batch BATCH]
                                               [--timestamp-start TIMESTAMP_START]
                                               [--timestamp-end TIMESTAMP_END]
                                               [--wait]
                                               metric

表41.51 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.52 位置引数

概要

metric

メトリクスの ID または名前

表41.53 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.54 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.55 その他の引数 (オプション):

概要

--wait

全計測が処理されるのを待ちます。

--count COUNT, -n COUNT

送信する合計計測値の数

--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START

使用する最初のタイムスタンプ

--workers WORKERS, -w WORKERS

使用するワーカー数

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--batch BATCH, -b BATCH

各バッチで送信する計測値の数

-h, --help

ヘルプメッセージを表示して終了します。

--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END

使用する最終タイムスタンプ

表41.56 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.12. metric benchmark measures show

measurements show のベンチマークテストを行います。

使用方法

openstack metric benchmark measures show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                [--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

表41.57 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.58 位置引数

概要

metric

メトリクスの ID または名前

表41.59 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表41.60 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.61 その他の引数 (オプション):

概要

--start START

期間の開始

--count COUNT, -n COUNT

送信する合計計測値の数

--aggregation AGGREGATION

取得する集約

--refresh

すべての既知の計測値を強制的に集計します。

--workers WORKERS, -w WORKERS

使用するワーカー数

--resample RESMYBACKUPDIRLE

時系列を再サンプリングする粒度 (秒単位)

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--stop STOP

期間の終了

--granularity GRANULARITY

取得する際の詳細度

--utc

タイムスタンプを utc として返します。

-h, --help

ヘルプメッセージを表示して終了します。

表41.62 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.13. metric benchmark metric create

メトリクス作成のベンチマークテストを行います。

使用方法

openstack metric benchmark metric create [-h]
                                                [--resource-id RESOURCE_ID]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                [--archive-policy-name ARCHIVE_POLICY_NAME]
                                                [--workers WORKERS] --count
                                                COUNT [--keep]

表41.63 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.64 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.65 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.66 その他の引数 (オプション):

概要

--count COUNT, -n COUNT

作成するメトリクスの数

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

アーカイブポリシーの名前

--keep, -k

作成されたメトリクスを保持します。

--workers WORKERS, -w WORKERS

使用するワーカー数

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

-h, --help

ヘルプメッセージを表示して終了します。

表41.67 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.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]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--workers WORKERS] --count
                                              COUNT
                                              metric [metric ...]

表41.68 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.69 位置引数

概要

metric

メトリクス ID または名前

表41.70 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.71 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.72 その他の引数 (オプション):

概要

--count COUNT, -n COUNT

取得するメトリクスの数

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--workers WORKERS, -w WORKERS

使用するワーカー数

表41.73 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.15. metric capabilities list

機能を一覧表示します。

使用方法

openstack metric capabilities list [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]

表41.74 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.75 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.76 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.77 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表41.78 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.16. metric create

メトリクスを作成します。

使用方法

openstack metric create [-h] [--resource-id RESOURCE_ID]
                               [-f {json,shell,table,value,yaml}] [-c COLUMN]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--noindent] [--prefix PREFIX]
                               [--archive-policy-name ARCHIVE_POLICY_NAME]
                               [--unit UNIT]
                               [METRIC_NAME]

表41.79 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.80 位置引数

概要

METRIC_NAME

メトリクスの名前

表41.81 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.82 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.83 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--unit UNIT, -u UNIT

メトリクスの単位

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

アーカイブポリシーの名前

表41.84 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.17. metric delete

メトリクスを削除します。

使用方法

openstack metric delete [-h] [--resource-id RESOURCE_ID]
                               metric [metric ...]

表41.85 位置引数

概要

metric

メトリクスの ID または名前

表41.86 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

41.18. metric list

メトリクスを一覧表示します。

使用方法

openstack metric list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--limit <LIMIT>]
                             [--marker <MARKER>] [--sort <SORT>]

表41.87 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.88 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表41.89 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表41.90 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.91 その他の引数 (オプション):

概要

--limit <LIMIT>

返すメトリクスの数 (デフォルトはサーバーのデフォルトです)

-h, --help

ヘルプメッセージを表示して終了します。

--marker <MARKER>

前の一覧の最後のアイテム。この値の後に来る結果を返します。

--sort <SORT>

メトリクス属性のソート (例:user_id:desc- nullslast)

41.19. metric measures add

計測値をメトリクスに追加します。

使用方法

openstack metric measures add [-h] [--resource-id RESOURCE_ID] -m
                                     MEASURE
                                     metric

表41.92 位置引数

概要

metric

メトリクスの ID または名前

表41.93 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

-m MEASURE、--measure MEASURE

@で区切った計測のタイムスタンプおよび値

41.20. metric measures aggregation

集約されたメトリクスの計測値を取得します。

使用方法

openstack metric measures aggregation [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--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]

表41.94 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.95 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表41.96 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表41.97 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.98 その他の引数 (オプション):

概要

--groupby GROUPBY

リソースをグループ化するために使用する属性

--start START

期間の開始

--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 です。

--fill FILL

シリーズのサブセットに値がない状態でタイムスタンプをバックフィルする際に使用する値。値は浮動小数点または null である必要があります。

--aggregation AGGREGATION

取得する粒度集約機能

-m METRIC [METRIC …​], --metric METRIC [METRIC …​]

メトリクス ID またはメトリクス名

--resource-type RESOURCE_TYPE

問い合わせるリソースタイプ

--refresh

すべての既知の計測値を強制的に集計します。

--reaggregation REAGGREGATION

取得する groupBy 集約機能

--stop STOP

期間の終了

--granularity GRANULARITY

取得する際の詳細度

--utc

タイムスタンプを utc として返します。

-h, --help

ヘルプメッセージを表示して終了します。

--resample RESMYBACKUPDIRLE

時系列を再サンプリングする粒度 (秒単位)

--needed-overlap NEEDED_OVERLAP

要求される各メトリクスのデータポイントの割合 (パーセント)

41.21. metric measures batch-metrics

使用方法

openstack metric measures batch-metrics [-h] file

表41.99 位置引数

概要

file

バッチ処理または stdin の測定値が含まれるファイル (形式は Gnocchi REST API のドキュメントを参照してください)。

表41.100 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

41.22. metric measures batch-resources-metrics

使用方法

openstack metric measures batch-resources-metrics [-h]
                                                         [--create-metrics]
                                                         file

表41.101 位置引数

概要

file

バッチ処理または stdin の測定値が含まれるファイル (形式は Gnocchi REST API のドキュメントを参照してください)。

表41.102 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--create-metrics

不明なメトリクスを作成します。

41.23. metric measures show

メトリクスの測定値を取得します。

使用方法

openstack metric measures show [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN] [--utc]
                                      [--resource-id RESOURCE_ID]
                                      [--aggregation AGGREGATION]
                                      [--start START] [--stop STOP]
                                      [--granularity GRANULARITY] [--refresh]
                                      [--resample RESAMPLE]
                                      metric

表41.103 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.104 位置引数

概要

metric

メトリクスの ID または名前

表41.105 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表41.106 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表41.107 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.108 その他の引数 (オプション):

概要

--start START

期間の開始

--aggregation AGGREGATION

取得する集約

--refresh

すべての既知の計測値を強制的に集計します。

--resample RESMYBACKUPDIRLE

時系列を再サンプリングする粒度 (秒単位)

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--stop STOP

期間の終了

--granularity GRANULARITY

取得する際の詳細度

--utc

タイムスタンプを utc として返します。

-h, --help

ヘルプメッセージを表示して終了します。

41.24. metric metric create

非推奨: メトリクスを作成します。

使用方法

openstack metric metric create [-h] [--resource-id RESOURCE_ID]
                                      [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--archive-policy-name ARCHIVE_POLICY_NAME]
                                      [--unit UNIT]
                                      [METRIC_NAME]

表41.109 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.110 位置引数

概要

METRIC_NAME

メトリクスの名前

表41.111 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.112 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.113 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--unit UNIT, -u UNIT

メトリクスの単位

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

アーカイブポリシーの名前

表41.114 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.25. metric metric delete

非推奨: メトリクスを削除します。

使用方法

openstack metric metric delete [-h] [--resource-id RESOURCE_ID]
                                      metric [metric ...]

表41.115 位置引数

概要

metric

メトリクスの ID または名前

表41.116 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

41.26. metric metric list

非推奨: メトリクスを一覧表示します。

使用方法

openstack metric metric list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]
                                    [--limit <LIMIT>] [--marker <MARKER>]
                                    [--sort <SORT>]

表41.117 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.118 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表41.119 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表41.120 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.121 その他の引数 (オプション):

概要

--limit <LIMIT>

返すメトリクスの数 (デフォルトはサーバーのデフォルトです)

-h, --help

ヘルプメッセージを表示して終了します。

--marker <MARKER>

前の一覧の最後のアイテム。この値の後に来る結果を返します。

--sort <SORT>

メトリクス属性のソート (例:user_id:desc- nullslast)

41.27. metric metric show

非推奨: メトリクスを表示します。

使用方法

openstack metric metric show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    [--resource-id RESOURCE_ID]
                                    metric

表41.122 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.123 位置引数

概要

metric

メトリクスの ID または名前

表41.124 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.125 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.126 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

表41.127 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.28. metric resource batch delete

属性値に基づいてリソースのバッチを削除します。

使用方法

openstack metric resource batch delete [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--type RESOURCE_TYPE]
                                              query

表41.128 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.129 位置引数

概要

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 です。

表41.130 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.131 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.132 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

表41.133 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.29. metric resource create

リソースを作成します。

使用方法

openstack metric resource create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--type RESOURCE_TYPE] [-a ATTRIBUTE]
                                        [-m ADD_METRIC] [-n CREATE_METRIC]
                                        resource_id

表41.134 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.135 位置引数

概要

resource_id

リソースの ID

表41.136 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.137 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.138 その他の引数 (オプション):

概要

-n CREATE_METRIC, --create-metric CREATE_METRIC

作成するメトリックの Name:archive_policy_name

-h, --help

ヘルプメッセージを表示して終了します。

-a MYBACKUPDIR、--attribute MYBACKUPDIR

:で区切った属性の名前および値

-m ADD_METRIC, --add-metric ADD_METRIC

追加するメトリクスの Name:id

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

表41.139 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.30. metric resource delete

リソースを削除します。

使用方法

openstack metric resource delete [-h] resource_id

表41.140 位置引数

概要

resource_id

リソースの ID

表41.141 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

41.31. metric resource history

リソースの履歴を表示します。

使用方法

openstack metric resource history [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         [--details] [--limit <LIMIT>]
                                         [--marker <MARKER>] [--sort <SORT>]
                                         [--type RESOURCE_TYPE]
                                         resource_id

表41.142 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.143 位置引数

概要

resource_id

リソースの ID

表41.144 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表41.145 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表41.146 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.147 その他の引数 (オプション):

概要

--details

汎用リソースの属性をすべて表示します。

--limit <LIMIT>

返すリソースの数 (デフォルトはサーバーのデフォルトです)。

--sort <SORT>

リソース属性のソート (例:user_id:desc- nullslast)

--marker <MARKER>

前の一覧の最後のアイテム。この値の後に来る結果を返します。

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

41.32. metric resource list

リソースを一覧表示します。

使用方法

openstack metric resource list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN] [--details]
                                      [--history] [--limit <LIMIT>]
                                      [--marker <MARKER>] [--sort <SORT>]
                                      [--type RESOURCE_TYPE]

表41.148 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.149 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表41.150 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表41.151 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.152 その他の引数 (オプション):

概要

--details

汎用リソースの属性をすべて表示します。

--limit <LIMIT>

返すリソースの数 (デフォルトはサーバーのデフォルトです)。

--history

リソースの履歴を表示します。

--sort <SORT>

リソース属性のソート (例:user_id:desc- nullslast)

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

--marker <MARKER>

前の一覧の最後のアイテム。この値の後に来る結果を返します。

41.34. metric resource show

リソースを表示します。

使用方法

openstack metric resource show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--type RESOURCE_TYPE]
                                      resource_id

表41.159 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.160 位置引数

概要

resource_id

リソースの ID

表41.161 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.162 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.163 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

表41.164 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.35. metric resource-type create

リソース種別を作成します。

使用方法

openstack metric resource-type create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             [-a ATTRIBUTE]
                                             name

表41.165 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.166 位置引数

概要

name

リソース種別の名前

表41.167 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.168 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.169 その他の引数 (オプション):

概要

-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

表41.170 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.36. metric resource-type delete

リソース種別を削除します。

使用方法

openstack metric resource-type delete [-h] name

表41.171 位置引数

概要

name

リソース種別の名前

表41.172 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

41.37. metric resource-type list

リソース種別を一覧表示します。

使用方法

openstack metric resource-type list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]

表41.173 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.174 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表41.175 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表41.176 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.177 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

41.38. metric resource-type show

リソース種別を表示します。

使用方法

openstack metric resource-type show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           name

表41.178 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.179 位置引数

概要

name

リソース種別の名前

表41.180 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.181 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.182 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表41.183 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.39. metric resource-type update

使用方法

openstack metric resource-type update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             [-a ATTRIBUTE]
                                             [-r REMOVE_ATTRIBUTE]
                                             name

表41.184 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.185 位置引数

概要

name

リソース種別の名前

表41.186 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.187 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.188 その他の引数 (オプション):

概要

-r REMOVE_ATTRIBUTE, --remove-attribute REMOVE_ATTRIBUTE

Attribute name

-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

表41.189 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.40. metric resource update

リソースを更新します。

使用方法

openstack metric resource update [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--type RESOURCE_TYPE] [-a ATTRIBUTE]
                                        [-m ADD_METRIC] [-n CREATE_METRIC]
                                        [-d DELETE_METRIC]
                                        resource_id

表41.190 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.191 位置引数

概要

resource_id

リソースの ID

表41.192 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.193 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.194 その他の引数 (オプション):

概要

-n CREATE_METRIC, --create-metric CREATE_METRIC

作成するメトリックの Name:archive_policy_name

-m ADD_METRIC, --add-metric ADD_METRIC

追加するメトリクスの Name:id

-d DELETE_METRIC, --delete-metric DELETE_METRIC

削除するメトリクスの名前

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

-a MYBACKUPDIR、--attribute MYBACKUPDIR

:で区切った属性の名前および値

表41.195 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.41. metric server version

Gnocchi サーバーのバージョンを表示します。

使用方法

openstack metric server version [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]

表41.196 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.197 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.198 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.199 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表41.200 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.42. metric show

メトリクスを表示します。

使用方法

openstack metric show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             [--resource-id RESOURCE_ID]
                             metric

表41.201 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.202 位置引数

概要

metric

メトリクスの ID または名前

表41.203 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.204 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.205 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

表41.206 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.43. metric status

測定値処理のステータスを表示します。

使用方法

openstack metric status [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]

表41.207 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表41.208 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.209 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.210 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表41.211 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第42章 module

本章では、module コマンドに含まれるコマンドについて説明します。

42.1. module list

モジュールのバージョンを一覧表示します。

使用方法

openstack module list [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             [--all]

表42.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表42.2 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表42.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表42.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all

バージョン情報を持つモジュールをすべて表示します。

表42.5 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第43章 network

本章では、network コマンドに含まれるコマンドについて説明します。

43.1. network agent add network

エージェントにネットワークを追加します。

使用方法

openstack network agent add network [-h] [--dhcp] <agent-id> <network>

表43.1 位置引数

概要

<agent-id>

ネットワークが追加されるエージェント (id のみ)

<network>

エージェントに追加されるネットワーク (名前または ID)

表43.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--dhcp

dhcp エージェントにネットワークを追加します。

43.2. network agent add router

エージェントにルーターを追加します。

使用方法

openstack network agent add router [-h] [--l3] <agent-id> <router>

表43.3 位置引数

概要

<agent-id>

ルーターが追加されるエージェント (id のみ)

<router>

エージェントに追加されるルーター (名前または ID)

表43.4 その他の引数 (オプション):

概要

--l3

ルーターを l3 エージェントに追加します。

-h, --help

ヘルプメッセージを表示して終了します。

43.3. network agent delete

ネットワークエージェントを削除します。

使用方法

openstack network agent delete [-h]
                                      <network-agent> [<network-agent> ...]

表43.5 位置引数

概要

<network-agent>

削除するネットワークエージェント (id のみ)

表43.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.4. network agent list

ネットワークエージェントの一覧を表示します。

使用方法

openstack network agent list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]
                                    [--agent-type <agent-type>]
                                    [--host <host>]
                                    [--network <network> | --router <router>]
                                    [--long]

表43.7 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.8 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.9 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.10 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.11 その他の引数 (オプション):

概要

--router <router>

このルーターをホストするエージェントを一覧表示します (名前または ID)。

--host <host>

指定されたホストで実行されているエージェントのみを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--network <network>

ネットワークをホストするエージェント (名前または ID) を一覧表示します。

--agent-type <agent-type>

指定したエージェントタイプのエージェントのみを一覧表示します。サポートされるエージェントタイプは、bgp、dhcp、open-vswitch、linux-bridge、ofa、l3、loadbalancer、metering、metadata、macvtap、nic です。

-h, --help

ヘルプメッセージを表示して終了します。

43.5. network agent remove network

エージェントからネットワークを削除します。

使用方法

openstack network agent remove network [-h] [--dhcp]
                                              <agent-id> <network>

表43.12 位置引数

概要

<agent-id>

ネットワークを削除するエージェント (id のみ)

<network>

エージェントから削除されるネットワーク (名前または ID)

表43.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--dhcp

dhcp エージェントからネットワークを削除します。

43.6. network agent remove router

エージェントからルーターを削除します。

使用方法

openstack network agent remove router [-h] [--l3] <agent-id> <router>

表43.14 位置引数

概要

<agent-id>

ルーターを削除するエージェント (id のみ)

<router>

エージェントから削除されるルーター (名前または ID)

表43.15 その他の引数 (オプション):

概要

--l3

l3 エージェントからルーターを削除します。

-h, --help

ヘルプメッセージを表示して終了します。

43.7. network agent set

ネットワークエージェントの属性を設定します。

使用方法

openstack network agent set [-h] [--description <description>]
                                   [--enable | --disable]
                                   <network-agent>

表43.16 位置引数

概要

<network-agent>

変更するネットワークエージェント (id のみ)

表43.17 その他の引数 (オプション):

概要

--disable

ネットワークエージェントを無効にします。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ネットワークエージェントの説明を設定します。

--enable

ネットワークエージェントを有効にします。

43.8. network agent show

ネットワークエージェントの詳細を表示します。

使用方法

openstack network agent show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    <network-agent>

表43.18 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.19 位置引数

概要

<network-agent>

表示するネットワークエージェント (id のみ)

表43.20 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.21 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表43.23 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.9. network auto allocated topology create

プロジェクトの自動割り当てトポロジーを作成します。

使用方法

openstack network auto allocated topology create [-h]
                                                        [-f {json,shell,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--noindent]
                                                        [--prefix PREFIX]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]
                                                        [--check-resources]
                                                        [--or-show]

表43.24 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.25 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.26 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--check-resources

自動割り当てトポロジーの要件を検証します。トポロジーを返しません。

--or-show

トポロジーが存在する場合は、トポロジーの情報を返します (デフォルト)。

--project <project>

指定されたプロジェクトに対して自動的に割り当てられたトポロジーを返します。デフォルトは現在のプロジェクトです。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表43.28 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.10. network auto allocated topology delete

プロジェクトの自動割り当てトポロジーを削除します。

使用方法

openstack network auto allocated topology delete [-h]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]

表43.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

特定のプロジェクトに対して自動的に割り当てられたトポロジーを削除します。デフォルトは現在のプロジェクトです。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

43.11. network create

新規ネットワークを作成します。

使用方法

openstack network create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX] [--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>]
                                [--tag <tag> | --no-tag]
                                <name>

表43.30 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.31 位置引数

概要

<name>

新しいネットワーク名

表43.32 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.33 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.34 その他の引数 (オプション):

概要

--availability-zone-hint <availability-zone>

このネットワークを作成するアベイラビリティーゾーン (Network Availability Zone 拡張機能が必要、複数のアベイラビリティーゾーンに設定するにはオプションを繰り返します)

--enable

ネットワークを有効にします (デフォルト)。

--internal

このネットワークを内部ネットワークとして設定します (デフォルト)。

--disable-port-security

このネットワークで作成されたポートで、デフォルトでポートセキュリティーを無効にします。

--transparent-vlan

ネットワーク vlan を透過的にします。

--share

プロジェクト間でネットワークを共有します。

--enable-port-security

このネットワークで作成されたポートで、デフォルトでポートセキュリティーを有効にします (デフォルト)。

--provider-segment <provider-segment>

vlan ネットワークの VLAN id、または GENEVE/GRE/VXLAN ネットワークのトンネル ID

--qos-policy <qos-policy>

このネットワークにアタッチする QoS ポリシー (名前または ID)

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ネットワークの説明を設定します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--mtu <mtu>

ネットワークの mtu を設定します。

--no-tag

ネットワークにタグを関連付けません。

--no-transparent-vlan

ネットワーク vlan を透過的にしません。

--no-share

プロジェクト間でネットワークを共有しません。

--external

このネットワークを外部ネットワークとして設定します (external-net 拡張機能が必要)

--provider-physical-network <provider-physical-network>

仮想ネットワークが実装される物理ネットワークの名前

--default

このネットワークをデフォルトの外部ネットワークとして使用するかどうかを指定します。

--provider-network-type <provider-network-type>

仮想ネットワークが実装される物理メカニズム。例:flat、geneve、gre、local、vlan、vxlan

--project <project>

所有者のプロジェクト (名前または ID)

--tag <tag>

ネットワークに追加するタグ (複数のタグを設定する場合はオプションを繰り返し使用します)

--disable

ネットワークを無効にします。

--no-default

ネットワークをデフォルトの外部ネットワークとして使用しません (デフォルト)。

表43.35 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.12. network delete

ネットワークを削除します。

使用方法

openstack network delete [-h] <network> [<network> ...]

表43.36 位置引数

概要

<network>

削除するネットワーク (名前または ID)

表43.37 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.13. network flavor add profile

サービスプロファイルをネットワークフレーバーに追加します。

使用方法

openstack network flavor add profile [-h] <flavor> <service-profile>

表43.38 位置引数

概要

<service-profile>

サービスプロファイル (id のみ)

<flavor>

ネットワークフレーバー (名前または ID)

表43.39 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.14. network flavor create

新規ネットワークフレーバーを作成します。

使用方法

openstack network flavor create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       --service-type <service-type>
                                       [--description DESCRIPTION]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       [--enable | --disable]
                                       <name>

表43.40 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.41 位置引数

概要

<name>

フレーバーの名前

表43.42 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.43 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.44 その他の引数 (オプション):

概要

--enable

フレーバーを有効にします (デフォルト)。

--project <project>

所有者のプロジェクト (名前または ID)

--service-type <service-type>

フレーバーを適用するサービス種別 (例:vpn)。ロードされた例は openstack network service provider list を参照してください。

--description DESCRIPTION

フレーバーの説明

-h, --help

ヘルプメッセージを表示して終了します。

--disable

フレーバーを無効にします。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表43.45 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.15. network flavor delete

ネットワークフレーバーを削除します。

使用方法

openstack network flavor delete [-h] <flavor> [<flavor> ...]

表43.46 位置引数

概要

<flavor>

削除するフレーバー (名前または ID)

表43.47 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.16. network flavor list

ネットワークフレーバーを一覧表示します。

使用方法

openstack network flavor list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]

表43.48 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.49 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.50 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.51 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.52 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.17. network flavor profile create

新規ネットワークフレーバープロファイルを作成します。

使用方法

openstack network flavor profile create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent] [--prefix PREFIX]
                                               [--project <project>]
                                               [--project-domain <project-domain>]
                                               [--description <description>]
                                               [--enable | --disable]
                                               [--driver DRIVER]
                                               [--metainfo METAINFO]

表43.53 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.54 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.55 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.56 その他の引数 (オプション):

概要

--description <description>

フレーバープロファイルの説明

--driver DRIVER

ドライバーへの Python モジュールパス。これは、--metainfo がない場合は必須です (逆の場合も同様)。

--enable

フレーバープロファイルを有効にします。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

フレーバープロファイルを無効にします。

--project <project>

所有者のプロジェクト (名前または ID)

--metainfo METAINFO

フレーバープロファイルの metainfo。これは、--driver がない場合は必須です (逆の場合も同様)。

表43.57 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.18. network flavor profile delete

ネットワークフレーバープロファイルを削除します。

使用方法

openstack network flavor profile delete [-h]
                                               <flavor-profile>
                                               [<flavor-profile> ...]

表43.58 位置引数

概要

<flavor-profile>

削除するフレーバープロファイル (id のみ)

表43.59 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.19. network flavor profile list

ネットワークフレーバープロファイルを一覧表示します。

使用方法

openstack network flavor profile list [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--sort-column SORT_COLUMN]

表43.60 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.61 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.62 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.63 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.64 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.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>

表43.65 位置引数

概要

<flavor-profile>

更新するフレーバープロファイル (id のみ)

表43.66 その他の引数 (オプション):

概要

--description <description>

フレーバープロファイルの説明

--driver DRIVER

ドライバーへの Python モジュールパス。これは、--metainfo がない場合は必須です (逆の場合も同様)。

--enable

フレーバープロファイルを有効にします。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

フレーバープロファイルを無効にします。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--metainfo METAINFO

フレーバープロファイルの metainfo。これは、--driver がない場合は必須です (逆の場合も同様)。

43.21. network flavor profile show

ネットワークフレーバープロファイルの詳細を表示します。

使用方法

openstack network flavor profile show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             <flavor-profile>

表43.67 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.68 位置引数

概要

<flavor-profile>

表示するフレーバープロファイル (id のみ)

表43.69 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.70 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.71 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表43.72 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.22. network flavor remove profile

ネットワークフレーバーからサービスプロファイルを削除します。

使用方法

openstack network flavor remove profile [-h] <flavor> <service-profile>

表43.73 位置引数

概要

<service-profile>

サービスプロファイル (id のみ)

<flavor>

ネットワークフレーバー (名前または ID)

表43.74 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.23. network flavor set

ネットワークフレーバー属性を設定します。

使用方法

openstack network flavor set [-h] [--description DESCRIPTION]
                                    [--disable | --enable] [--name <name>]
                                    <flavor>

表43.75 位置引数

概要

<flavor>

更新するフレーバー (名前または ID)

表43.76 その他の引数 (オプション):

概要

--enable

ネットワークフレーバーを有効にします。

--name <name>

フレーバー名を設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

ネットワークフレーバーを無効にします。

--description DESCRIPTION

ネットワークフレーバーの説明を設定します。

43.24. network flavor show

ネットワークフレーバーの詳細を表示します。

使用方法

openstack network flavor show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <flavor>

表43.77 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.78 位置引数

概要

<flavor>

表示するフレーバー (名前または ID)

表43.79 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.80 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.81 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表43.82 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.25. network list

ネットワークを一覧表示します。

使用方法

openstack network list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--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>,...]]

表43.83 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.84 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.85 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.86 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.87 その他の引数 (オプション):

概要

--share

プロジェクト間で共有されるネットワークを一覧表示します。

--agent <agent-id>

エージェントがホストするネットワークの一覧を表示します (id のみ)。

--tags <tag>[,<tag>,…​]

指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたネットワークを一覧表示します。

--enable

有効なネットワークの一覧を表示します。

--not-any-tags <tag>[,<tag>,…​]

指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたネットワークを除外します。

--name <name>

名前に従ってネットワークを一覧表示します。

--internal

内部ネットワークを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--any-tags <tag>[,<tag>,…​]

指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたネットワークを一覧表示します。

--status <status>

ステータス (activeBUILDDOWNERROR) に従ってネットワークを一覧表示します。

--provider-segment <provider-segment>

vlan ネットワークの vlan id か、GENEVE/GRE/VXLAN ネットワークの Tunnel ID に従ってネットワークを一覧表示します。

--no-share

プロジェクト間で共有されていないネットワークの一覧を表示します。

--external

外部ネットワークを一覧表示します。

--provider-physical-network <provider-physical-network>

物理ネットワークの名前に従ってネットワークを一覧表示します。

--provider-network-type <provider-network-type>

物理メカニズムに従ってネットワークを一覧表示します。サポートされているオプションは flat、geneve、gre、local、vlan、vxlan です。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

無効なネットワークの一覧を表示します。

--not-tags <tag>[,<tag>,…​]

指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたネットワークを除外します。

--project <project>

プロジェクトに従ってネットワークを一覧表示します (名前または ID)。

43.26. network log create

新規ネットワークログを作成指定します。

使用方法

openstack network log create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    [--description <description>]
                                    [--enable | --disable]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--event <event>] --resource-type
                                    <resource-type> [--resource <resource>]
                                    [--target <target>]
                                    <name>

表43.88 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.89 位置引数

概要

<name>

ネットワークログの名前

表43.90 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.91 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.92 その他の引数 (オプション):

概要

--description <description>

ネットワークログの説明

--enable

このログを有効にします (デフォルトは無効)。

--resource <resource>

ロギング用のセキュリティーグループ(名前または ID)。ロギングターゲットの組み合わせは --target オプションで制御できます。

--project <project>

所有者のプロジェクト (名前または ID)

--resource-type <resource-type>

ネットワークログのタイプ。サポートされる種別は、$ openstack network loggable resources list で確認することができます。

--event <event>

ログと共に保存するイベント

--target <target>

ロギング用のポート (名前または ID)。ロギングターゲットの組み合わせは、--resource オプションで制御できます。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

このログを無効にします。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表43.93 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.27. network log delete

ネットワークログを削除します。

使用方法

openstack network log delete [-h] <network-log> [<network-log> ...]

表43.94 位置引数

概要

<network-log>

削除するネットワークログ (名前または ID)

表43.95 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.28. network log list

ネットワークログを一覧表示します。

使用方法

openstack network log list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN] [--long]

表43.96 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.97 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.98 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.99 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.100 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

43.29. network log set

ネットワークログの属性を設定します。

使用方法

openstack network log set [-h] [--description <description>]
                                 [--enable | --disable] [--name <name>]
                                 <network-log>

表43.101 位置引数

概要

<network-log>

設定するネットワークログ (名前または ID)

表43.102 その他の引数 (オプション):

概要

--disable

このログを無効にします。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ネットワークログの説明

--name <name>

ネットワークログの名前

--enable

このログを有効にします (デフォルトは無効)。

43.30. network log show

ネットワークログの詳細を表示します。

使用方法

openstack network log show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  <network-log>

表43.103 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.104 位置引数

概要

<network-log>

表示するネットワークログ (名前または ID)

表43.105 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.106 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.107 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表43.108 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.31. network loggable resources list

サポートされるログ可能なリソースを一覧表示します。

使用方法

openstack network loggable resources list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]
                                                 [--long]

表43.109 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.110 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.111 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.112 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.113 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

43.32. network meter create

ネットワークメーターを作成します。

使用方法

openstack network meter create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--description <description>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--share | --no-share]
                                      <name>

表43.114 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.115 位置引数

概要

<name>

メーターの名前

表43.116 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.117 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.118 その他の引数 (オプション):

概要

--share

プロジェクト間でメーターを共有します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--no-share

プロジェクト間でメーターを共有しません。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

メーターの説明を作成します。

--project <project>

所有者のプロジェクト (名前または ID)

表43.119 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.33. network meter delete

ネットワークメーターを削除します。

使用方法

openstack network meter delete [-h] <meter> [<meter> ...]

表43.120 位置引数

概要

<meter>

削除するメーター (名前または ID)

表43.121 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.34. network meter list

ネットワークメーターを一覧表示します。

使用方法

openstack network meter list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]

表43.122 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.123 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.124 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.125 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.126 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.35. network meter rule create

新しいメータールールを作成します。

使用方法

openstack network meter rule create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--project <project>]
                                           [--project-domain <project-domain>]
                                           [--exclude | --include]
                                           [--ingress | --egress]
                                           --remote-ip-prefix
                                           <remote-ip-prefix>
                                           <meter>

表43.127 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.128 位置引数

概要

<meter>

このメータリングルールに関連付けるラベル (名前または ID)

表43.129 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.130 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.131 その他の引数 (オプション):

概要

--exclude

トラフィック数からリモート ip 接頭辞を除外します。

--include

トラフィック数にリモート ip 接頭辞を含めます (デフォルト)。

--remote-ip-prefix <remote-ip-prefix>

このルールに関連付けるリモート IP 接頭辞

--ingress

受信ネットワークトラフィックにルールを適用します (デフォルト)。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト (名前または ID)

--egress

発信ネットワークトラフィックにルールを適用します。

表43.132 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.36. network meter rule delete

メータールールを削除します。

使用方法

openstack network meter rule delete [-h]
                                           <meter-rule-id>
                                           [<meter-rule-id> ...]

表43.133 位置引数

概要

<meter-rule-id>

削除するメータールール (id のみ)

表43.134 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.37. network meter rule list

メータールールを一覧表示します。

使用方法

openstack network meter rule list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]

表43.135 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.136 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.137 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.138 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.139 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.38. network meter rule show

メータールールの詳細を表示削除します。

使用方法

openstack network meter rule show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         <meter-rule-id>

表43.140 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.141 位置引数

概要

<meter-rule-id>

メータールール (id のみ)

表43.142 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.143 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.144 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表43.145 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.39. network meter show

ネットワークメーターを表示します。

使用方法

openstack network meter show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    <meter>

表43.146 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.147 位置引数

概要

<meter>

表示するメーター (名前または ID)

表43.148 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.149 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.150 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表43.151 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.40. network qos policy create

QoS ポリシーを作成します。

使用方法

openstack network qos policy create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--description <description>]
                                           [--share | --no-share]
                                           [--project <project>]
                                           [--project-domain <project-domain>]
                                           [--default | --no-default]
                                           <name>

表43.152 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.153 位置引数

概要

<name>

作成する qos ポリシーの名前

表43.154 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.155 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.156 その他の引数 (オプション):

概要

--share

他のプロジェクトから qos ポリシーにアクセスできるようにします。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--no-share

他のプロジェクトから qos ポリシーにアクセスできないようにします (デフォルト)。

--no-default

これをデフォルト以外のネットワーク qos ポリシーとして設定します。

--default

これをデフォルトのネットワーク qos ポリシーとして設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

qos ポリシーの説明

--project <project>

所有者のプロジェクト (名前または ID)

表43.157 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.41. network qos policy delete

Qos ポリシーを削除します。

使用方法

openstack network qos policy delete [-h]
                                           <qos-policy> [<qos-policy> ...]

表43.158 位置引数

概要

<qos-policy>

削除する QoS ポリシー (名前または ID)

表43.159 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.42. network qos policy list

QoS ポリシーを一覧表示します。

使用方法

openstack network qos policy list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         [--project <project>]
                                         [--project-domain <project-domain>]
                                         [--share | --no-share]

表43.160 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.161 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.162 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.163 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.164 その他の引数 (オプション):

概要

--share

プロジェクト間で共有される QoS ポリシーを一覧表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--no-share

プロジェクト間で共有されない qos ポリシーを一覧表示します。

--project <project>

プロジェクトに従って qos ポリシーを一覧表示します (名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

43.43. network qos policy set

QoS ポリシー属性を設定します。

使用方法

openstack network qos policy set [-h] [--name <name>]
                                        [--description <description>]
                                        [--share | --no-share]
                                        [--default | --no-default]
                                        <qos-policy>

表43.165 位置引数

概要

<qos-policy>

変更する QoS ポリシー (名前または ID)

表43.166 その他の引数 (オプション):

概要

--share

他のプロジェクトから qos ポリシーにアクセスできるようにします。

--name <name>

qos ポリシー名を設定します。

--no-share

他のプロジェクトから qos ポリシーにアクセスできないようにします。

--no-default

これをデフォルト以外のネットワーク qos ポリシーとして設定します。

--default

これをデフォルトのネットワーク qos ポリシーとして設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

qos ポリシーの説明

43.44. network qos policy show

QoS ポリシーの詳細を表示します。

使用方法

openstack network qos policy show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         <qos-policy>

表43.167 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.168 位置引数

概要

<qos-policy>

表示する QoS ポリシー (名前または ID)

表43.169 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.170 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.171 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表43.172 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.45. network qos rule create

新規 Network QoS ルールを作成します。

使用方法

openstack network qos rule create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         [--type <type>]
                                         [--max-kbps <max-kbps>]
                                         [--max-burst-kbits <max-burst-kbits>]
                                         [--dscp-mark <dscp-mark>]
                                         [--min-kbps <min-kbps>]
                                         [--ingress | --egress]
                                         <qos-policy>

表43.173 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.174 位置引数

概要

<qos-policy>

ルールが含まれる QoS ポリシー (名前または id)

表43.175 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.176 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.177 その他の引数 (オプション):

概要

--min-kbps <min-kbps>

確保される最小帯域幅 (kbps 単位)

--dscp-mark <dscp-mark>

DSCP mark: 値 は 0、8 - 56 の偶数を指定できます (42、44、50、52、および 54 を除く)。

--max-kbps <max-kbps>

最大帯域幅 (kbps)

--ingress

プロジェクト視点からの受信トラフィックの方向

--type <type>

QoS ルールタイプ(dscp-marking、minimum-bandwidth、bandwidth-limit)

--max-burst-kbits <max-burst-kbits>

キロビット単位の最大バースト。0 は自動を意味します。

-h, --help

ヘルプメッセージを表示して終了します。

--egress

プロジェクト視点からの送信トラフィックの方向

表43.178 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.46. network qos rule delete

ネットワーク QoS ルールを削除します。

使用方法

openstack network qos rule delete [-h] <qos-policy> <rule-id>

表43.179 位置引数

概要

<qos-policy>

ルールが含まれる QoS ポリシー (名前または id)

<rule-id>

削除するネットワーク qos ルール (id)

表43.180 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.47. network qos rule list

ネットワーク QoS ルールを一覧表示します。

使用方法

openstack network qos rule list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN]
                                       <qos-policy>

表43.181 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.182 位置引数

概要

<qos-policy>

ルールが含まれる QoS ポリシー (名前または id)

表43.183 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.184 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.185 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.186 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.48. 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>

表43.187 位置引数

概要

<qos-policy>

ルールが含まれる QoS ポリシー (名前または id)

<rule-id>

削除するネットワーク qos ルール (id)

表43.188 その他の引数 (オプション):

概要

--min-kbps <min-kbps>

確保される最小帯域幅 (kbps 単位)

--dscp-mark <dscp-mark>

DSCP mark: 値 は 0、8 - 56 の偶数を指定できます (42、44、50、52、および 54 を除く)。

--max-kbps <max-kbps>

最大帯域幅 (kbps)

--ingress

プロジェクト視点からの受信トラフィックの方向

--max-burst-kbits <max-burst-kbits>

キロビット単位の最大バースト。0 は自動を意味します。

-h, --help

ヘルプメッセージを表示して終了します。

--egress

プロジェクト視点からの送信トラフィックの方向

43.49. network qos rule show

ネットワーク QoS ルールの詳細を表示します。

使用方法

openstack network qos rule show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       <qos-policy> <rule-id>

表43.189 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.190 位置引数

概要

<qos-policy>

ルールが含まれる QoS ポリシー (名前または id)

<rule-id>

削除するネットワーク qos ルール (id)

表43.191 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.192 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.193 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表43.194 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.50. network qos rule type list

QoS ルール種別の一覧を表示します。

使用方法

openstack network qos rule type list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]

表43.195 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.196 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.197 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.198 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.199 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.51. network qos rule type show

サポート対象の QoS ルール種別の詳細を表示します。

使用方法

openstack network qos rule type show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            <qos-rule-type-name>

表43.200 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.201 位置引数

概要

<qos-rule-type-name>

qos ルール種別の名前

表43.202 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.203 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.204 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表43.205 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.52. network rbac create

ネットワーク RBAC ポリシーを作成します。

使用方法

openstack network rbac create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX] --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>

表43.206 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.207 位置引数

概要

<rbac-object>

この rbac ポリシーが影響を及ぼすオブジェクト (名前または ID)

表43.208 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.209 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.210 その他の引数 (オプション):

概要

--target-project-domain <target-project-domain>

ターゲットプロジェクトが属するドメイン (名前または id)プロジェクト名の競合が発生した場合に、使用できます。

--target-project <target-project>

rbac ポリシーを適用するプロジェクト (名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--type <type>

rbac ポリシーが影響するオブジェクトのタイプ(qos_policy または network)

--action <action>

rbac ポリシーの動作 ("access_as_external" または "access_as_shared")

-h, --help

ヘルプメッセージを表示して終了します。

--target-all-projects

すべてのプロジェクトの rbac ポリシーの作成を許可します。

--project <project>

所有者プロジェクト (名前または ID)

表43.211 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.53. network rbac delete

ネットワーク RBAC ポリシーを削除します。

使用方法

openstack network rbac delete [-h] <rbac-policy> [<rbac-policy> ...]

表43.212 位置引数

概要

<rbac-policy>

削除する RBAC ポリシー (id のみ)

表43.213 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.54. network rbac list

ネットワーク RBAC ポリシーを一覧表示します。

使用方法

openstack network rbac list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN] [--type <type>]
                                   [--action <action>] [--long]

表43.214 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.215 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.216 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.217 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.218 その他の引数 (オプション):

概要

--type <type>

指定されたオブジェクトタイプ("qos_policy" または "network")に従ってネットワーク rbac ポリシーを一覧表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--action <action>

指定されたアクション ("access_as_external" または "access_as_shared") に従って、ネットワーク rbac ポリシーを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

43.55. network rbac set

ネットワーク RBAC ポリシー属性を設定します。

使用方法

openstack network rbac set [-h] [--target-project <target-project>]
                                  [--target-project-domain <target-project-domain>]
                                  <rbac-policy>

表43.219 位置引数

概要

<rbac-policy>

変更する RBAC ポリシー (id のみ)

表43.220 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--target-project-domain <target-project-domain>

ターゲットプロジェクトが属するドメイン (名前または id)プロジェクト名の競合が発生した場合に、使用できます。

--target-project <target-project>

rbac ポリシーを適用するプロジェクト (名前または ID)

43.56. network rbac show

ネットワーク RBAC ポリシーの詳細を表示します。

使用方法

openstack network rbac show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   <rbac-policy>

表43.221 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.222 位置引数

概要

<rbac-policy>

RBAC ポリシー (id のみ)

表43.223 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.224 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.225 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表43.226 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.57. network segment create

新規ネットワークセグメントを作成します。

使用方法

openstack network segment create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--description <description>]
                                        [--physical-network <physical-network>]
                                        [--segment <segment>] --network
                                        <network> --network-type
                                        <network-type>
                                        <name>

表43.227 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.228 位置引数

概要

<name>

新しいネットワークセグメント名

表43.229 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.230 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.231 その他の引数 (オプション):

概要

--network-type <network-type>

このネットワークセグメントのネットワーク種別 (flat、geneve、gre、local、vlan、または vxlan)

--segment <segment>

このネットワークセグメントのセグメント識別子。ネットワーク種別、vlan ネットワーク種別の VLAN ID、ならびに geneve、gre、および vxlan ネットワーク種別のトンネル ID に基づきます。

--network <network>

このネットワークセグメントが属するネットワーク (名前または id)

--physical-network <physical-network>

このネットワークセグメントの物理ネットワーク名

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ネットワークセグメントの説明

表43.232 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.58. network segment delete

ネットワークセグメントを削除します。

使用方法

openstack network segment delete [-h]
                                        <network-segment>
                                        [<network-segment> ...]

表43.233 位置引数

概要

<network-segment>

削除するネットワークセグメント (名前または ID)

表43.234 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.59. network segment list

ネットワークセグメントの一覧を表示します。

使用方法

openstack network segment list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN] [--long]
                                      [--network <network>]

表43.235 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.236 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.237 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.238 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.239 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--network <network>

このネットワークに属するネットワークセグメントを一覧表示します (名前または ID)。

--long

出力の追加フィールドを一覧表示します。

43.60. network segment set

ネットワークセグメントの属性を設定します。

使用方法

openstack network segment set [-h] [--description <description>]
                                     [--name <name>]
                                     <network-segment>

表43.240 位置引数

概要

<network-segment>

変更するネットワークセグメント (名前または ID)

表43.241 その他の引数 (オプション):

概要

--name <name>

ネットワークセグメント名を設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ネットワークセグメントの説明を設定します。

43.61. network segment show

ネットワークセグメントの詳細を表示します。

使用方法

openstack network segment show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      <network-segment>

表43.242 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.243 位置引数

概要

<network-segment>

表示するネットワークセグメント (名前または ID)

表43.244 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.245 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.246 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表43.247 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.62. network service provider list

サービスプロバイダーを一覧表示します。

使用方法

openstack network service provider list [-h]
                                               [-f {csv,json,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent]
                                               [--quote {all,minimal,none,nonnumeric}]
                                               [--sort-column SORT_COLUMN]

表43.248 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.249 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.250 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.251 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.252 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.63. network set

ネットワークの属性を設定します。

使用方法

openstack network set [-h] [--name <name>] [--enable | --disable]
                             [--share | --no-share]
                             [--description <description] [--mtu <mtu]
                             [--enable-port-security | --disable-port-security]
                             [--external | --internal]
                             [--default | --no-default]
                             [--qos-policy <qos-policy> | --no-qos-policy]
                             [--tag <tag>] [--no-tag]
                             [--provider-network-type <provider-network-type>]
                             [--provider-physical-network <provider-physical-network>]
                             [--provider-segment <provider-segment>]
                             <network>

表43.253 位置引数

概要

<network>

変更するネットワーク (名前または ID)

表43.254 その他の引数 (オプション):

概要

--share

プロジェクト間でネットワークを共有します。

--enable-port-security

このネットワークで作成されたポートで、デフォルトでポートセキュリティーを有効にします。

--enable

ネットワークを有効有効にします。

--no-tag

ネットワークに関連付けられたタグを消去します。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。

--name <name>

ネットワーク名を設定します。

--provider-physical-network <provider-physical-network>

仮想ネットワークが実装される物理ネットワークの名前

--internal

このネットワークを内部ネットワークとして設定します。

--mtu <mtu

ネットワークの mtu を設定します。

--description <description

ネットワークの説明を設定します。

--provider-network-type <provider-network-type>

仮想ネットワークが実装される物理メカニズム。例:flat、geneve、gre、local、vlan、vxlan

--no-share

プロジェクト間でネットワークを共有しません。

--no-qos-policy

このネットワークに割り当てられた qos ポリシーを削除します。

--external

このネットワークを外部ネットワークとして設定します (external-net 拡張機能が必要)

--disable-port-security

このネットワークで作成されたポートで、デフォルトでポートセキュリティーを無効にします。

--no-default

ネットワークをデフォルトの外部ネットワークとして使用しません。

--default

ネットワークをデフォルトの外部ネットワークとして設定します。

--qos-policy <qos-policy>

このネットワークにアタッチする QoS ポリシー (名前または ID)

-h, --help

ヘルプメッセージを表示して終了します。

--disable

ネットワークを無効にします。

--provider-segment <provider-segment>

vlan ネットワークの VLAN id、または GENEVE/GRE/VXLAN ネットワークのトンネル ID

--tag <tag>

ネットワークに追加するタグ (複数のタグを設定する場合はオプションを繰り返し使用します)

43.64. network show

ネットワーク情報を表示します。

使用方法

openstack network show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX]
                              <network>

表43.255 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.256 位置引数

概要

<network>

表示するネットワーク (名前または ID)

表43.257 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.258 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.259 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表43.260 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.65. network subport list

特定のネットワークトランクのすべてのサブポートを一覧表示します。

使用方法

openstack network subport list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN] --trunk
                                      <trunk>

表43.261 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.262 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.263 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.264 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.265 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--trunk <trunk>

このトランクに属するサブポートを一覧表示します (名前または id)。

43.66. network trunk create

特定プロジェクトのネットワークトランクを作成します。

使用方法

openstack network trunk create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--description <description>]
                                      --parent-port <parent-port>
                                      [--subport <port=,segmentation-type=,segmentation-id=>]
                                      [--enable | --disable]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      <name>

表43.266 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.267 位置引数

概要

<name>

作成するトランクの名前

表43.268 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.269 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.270 その他の引数 (オプション):

概要

--description <description>

トランクの説明

--enable

トランクを有効にします (デフォルト)。

--subport <port=,segmentation-type=,segmentation-id⇒

追加するサブポート。サブポートの形式は port=<name or ID>,segmentation-type=,segmentation-ID= で、(--subport) オプションは繰り返し使用できます。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--parent-port <parent-port>

このトランクに属する親ポート (名前または ID)

-h, --help

ヘルプメッセージを表示して終了します。

--disable

トランクを無効にします。

--project <project>

所有者のプロジェクト (名前または ID)

表43.271 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.67. network trunk delete

特定のネットワークトランクを削除します。

使用方法

openstack network trunk delete [-h] <trunk> [<trunk> ...]

表43.272 位置引数

概要

<trunk>

削除するトランク (名前または ID)

表43.273 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

43.68. network trunk list

すべてのネットワークトランクを一覧表示します。

使用方法

openstack network trunk list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN] [--long]

表43.274 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.275 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.276 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.277 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.278 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

43.69. network trunk set

ネットワークトランクの属性を設定します。

使用方法

openstack network trunk set [-h] [--name <name>]
                                   [--description <description>]
                                   [--subport <port=,segmentation-type=,segmentation-id=>]
                                   [--enable | --disable]
                                   <trunk>

表43.279 位置引数

概要

<trunk>

変更するトランク (名前または ID)

表43.280 その他の引数 (オプション):

概要

--description <description>

トランクの説明

--enable

トランクを有効にします。

--name <name>

トランク名を設定します。

--subport <port=,segmentation-type=,segmentation-id⇒

追加するサブポート。サブポートの形式は port=<name or ID>,segmentation-type=,segmentation-ID= で、(--subport) オプションは繰り返し使用できます。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

トランクを無効にします。

43.70. network trunk show

特定のネットワークトランクに関する情報を表示します。

使用方法

openstack network trunk show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    <trunk>

表43.281 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表43.282 位置引数

概要

<trunk>

表示するトランク (名前または ID)

表43.283 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.284 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.285 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表43.286 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.71. network trunk unset

特定のネットワークトランクからサブポートの設定を解除します。

使用方法

openstack network trunk unset [-h] --subport <subport> <trunk>

表43.287 位置引数

概要

<trunk>

このトランクからサブポートの設定を解除します (名前または id)。

表43.288 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--subport <subport>

削除するサブポート (ポートの名前または ID)。(--subport) はオプションは繰り返し使用できます。

43.72. network unset

ネットワーク属性の設定を解除します。

使用方法

openstack network unset [-h] [--tag <tag> | --all-tag] <network>

表43.289 位置引数

概要

<network>

変更するネットワーク (名前または ID)

表43.290 その他の引数 (オプション):

概要

--all-tag

ネットワークに関連付けられたすべてのタグを消去します。

-h, --help

ヘルプメッセージを表示して終了します。

--tag <tag>

ネットワークから削除するタグ (複数のタグを削除する場合はオプションを繰り返し使用します)

第44章 object

本章では、object コマンドに含まれるコマンドについて説明します。

44.1. object create

オブジェクトをコンテナーにアップロードします。

使用方法

openstack object create [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--sort-column SORT_COLUMN] [--name <name>]
                               <container> <filename> [<filename> ...]

表44.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表44.2 位置引数

概要

<filename>

アップロードするローカルファイル名

<container>

新規オブジェクトのコンテナー

表44.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表44.4 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表44.5 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表44.6 その他の引数 (オプション):

概要

--name <name>

ファイルをアップロードして名前を変更します。単一オブジェクトのアップロード時にのみ使用できます。

-h, --help

ヘルプメッセージを表示して終了します。

44.2. object delete

コンテナーからオブジェクトを削除します。

使用方法

openstack object delete [-h] <container> <object> [<object> ...]

表44.7 位置引数

概要

<object>

削除するオブジェクト

<container>

<container> からオブジェクトを削除します。

表44.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

44.3. object list

オブジェクトを一覧表示します。

使用方法

openstack object list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--prefix <prefix>]
                             [--delimiter <delimiter>] [--marker <marker>]
                             [--end-marker <end-marker>]
                             [--limit <num-objects>] [--long] [--all]
                             <container>

表44.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表44.10 位置引数

概要

<container>

一覧表示するコンテナー

表44.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表44.12 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表44.13 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表44.14 その他の引数 (オプション):

概要

--marker <marker>

ページングのアンカー

--long

出力の追加フィールドを一覧表示します。

--delimiter <delimiter>

<delimiter> でアイテムをロールアップします。

--limit <num-objects>

返されるオブジェクト数を制限します。

--end-marker <end-marker>

ページングの終了アンカー

-h, --help

ヘルプメッセージを表示して終了します。

--prefix <prefix>

<prefix> を使用して一覧をフィルターします。

--all

コンテナーのすべてのオブジェクトを一覧表示します (デフォルトは 10000)。

44.4. object save

ローカルにオブジェクトを保存します。

使用方法

openstack object save [-h] [--file <filename>] <container> <object>

表44.15 位置引数

概要

<object>

保存するオブジェクト

<container>

<container> から <object> をダウンロードします。

表44.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--file <filename>

保存先ファイル名 (デフォルトはオブジェクト名)。ファイル名に-を使用すると、ファイルを標準出力に出力します。

44.5. object set

オブジェクトの属性を設定します。

使用方法

openstack object set [-h] --property <key=value> <container> <object>

表44.17 位置引数

概要

<object>

変更するオブジェクト

<container>

<container> からの <object> を変更します。

表44.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key=value>

このオブジェクトに属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します)。

44.6. object show

オブジェクトの詳細を表示します。

使用方法

openstack object show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             <container> <object>

表44.19 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表44.20 位置引数

概要

<object>

表示するオブジェクト

<container>

<container> からの <object> を表示します。

表44.21 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表44.22 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表44.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表44.24 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

44.7. object store account set

アカウントの属性を設定します。

使用方法

openstack object store account set [-h] --property <key=value>

表44.25 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key=value>

このアカウントに属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します)。

44.8. object store account show

アカウントの詳細を表示します。

使用方法

openstack object store account show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]

表44.26 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表44.27 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表44.28 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表44.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表44.30 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

44.9. object store account unset

アカウント属性の設定を解除します。

使用方法

openstack object store account unset [-h] --property <key>

表44.31 その他の引数 (オプション):

概要

--property <key>

アカウントから削除する属性 (複数の属性を削除する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

44.10. object unset

オブジェクト属性の設定を解除します。

使用方法

openstack object unset [-h] --property <key> <container> <object>

表44.32 位置引数

概要

<object>

変更するオブジェクト

<container>

<container> からの <object> を変更します。

表44.33 その他の引数 (オプション):

概要

--property <key>

オブジェクトから削除する属性 (複数の属性を削除する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

第45章 orchestration

本章では、orchestration コマンドに含まれるコマンドについて説明します。

45.1. orchestration build info

ビルド情報を取得します。

使用方法

openstack orchestration build info [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]

表45.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表45.2 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表45.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表45.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表45.5 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

45.2. orchestration resource type list

リソース種別を一覧表示します。

使用方法

openstack orchestration resource type list [-h]
                                                  [-f {csv,json,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty] [--noindent]
                                                  [--quote {all,minimal,none,nonnumeric}]
                                                  [--sort-column SORT_COLUMN]
                                                  [--filter <key=value>]
                                                  [--long]

表45.6 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表45.7 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表45.8 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表45.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表45.10 その他の引数 (オプション):

概要

--filter <key=value>

返されたリソース種別に適用するフィルターパラメーターこれは複数回指定できます。name、version、または support_status のいずれかになります。

-h, --help

ヘルプメッセージを表示して終了します。

--long

対応する説明と共にリソース種別を表示します。

45.3. orchestration resource type show

リソース種別の詳細を表示し、オプションとしてテンプレートを生成します。

使用方法

openstack orchestration resource type show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--template-type <template-type>]
                                                  [--long]
                                                  <resource-type>

表45.11 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表45.12 位置引数

概要

<resource-type>

詳細を表示するリソース種別

表45.13 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表45.14 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表45.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--template-type <template-type>

オプションとして生成するテンプレートの種別 (hot または cfn)

--long

対応する説明と共にリソース種別を表示します。

表45.16 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

45.4. orchestration service list

Heat エンジンを一覧表示します。

使用方法

openstack orchestration service list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]

表45.17 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表45.18 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表45.19 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表45.20 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表45.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

45.5. orchestration template function list

利用可能な関数を一覧表示します。

使用方法

openstack orchestration template function list [-h]
                                                      [-f {csv,json,table,value,yaml}]
                                                      [-c COLUMN]
                                                      [--max-width <integer>]
                                                      [--fit-width]
                                                      [--print-empty]
                                                      [--noindent]
                                                      [--quote {all,minimal,none,nonnumeric}]
                                                      [--sort-column SORT_COLUMN]
                                                      [--with_conditions]
                                                      <template-version>

表45.22 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表45.23 位置引数

概要

<template-version>

関数を取得するテンプレートのバージョン

表45.24 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表45.25 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表45.26 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表45.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--with_conditions

テンプレートの条件関数を表示します。

45.6. orchestration template validate

テンプレートを検証します。

使用方法

openstack orchestration template validate [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 [-e <environment>]
                                                 [--show-nested]
                                                 [--parameter <key=value>]
                                                 [--ignore-errors <error1,error2,...>]
                                                 -t <template>

表45.28 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表45.29 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表45.30 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表45.31 その他の引数 (オプション):

概要

--ignore-errors <error1,error2,…​>

無視する heat エラーの一覧

-e <environment>, --environment <environment>

環境へのパス。複数回指定できます。

-t <template>, --template <template>

テンプレートへのパス

--parameter <key=value>

スタックの作成に使用するパラメーター値。これは複数回指定できます。

-h, --help

ヘルプメッセージを表示して終了します。

--show-nested

ネストされたテンプレートからのパラメーターも解決します。

表45.32 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

45.7. orchestration template version list

利用可能なテンプレートバージョンを一覧表示します。

使用方法

openstack orchestration template version list [-h]
                                                     [-f {csv,json,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--max-width <integer>]
                                                     [--fit-width]
                                                     [--print-empty]
                                                     [--noindent]
                                                     [--quote {all,minimal,none,nonnumeric}]
                                                     [--sort-column SORT_COLUMN]

表45.33 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表45.34 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表45.35 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表45.36 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表45.37 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

第46章 overcloud

本章では、overcloud コマンドに含まれるコマンドについて説明します。

46.1. overcloud ceph-upgrade run

Ceph のアップグレードを実行するには、オーバークラウドノードで heat スタックの更新を実行します。

使用方法

openstack overcloud ceph-upgrade run [--templates [TEMPLATES]]
                                            [--stack STACK]
                                            [--timeout <TIMEOUT>]
                                            [--control-scale CONTROL_SCALE]
                                            [--compute-scale COMPUTE_SCALE]
                                            [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                            [--block-storage-scale BLOCK_STORAGE_SCALE]
                                            [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                            [--control-flavor CONTROL_FLAVOR]
                                            [--compute-flavor COMPUTE_FLAVOR]
                                            [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                            [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                            [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                            [--libvirt-type {kvm,qemu}]
                                            [--ntp-server NTP_SERVER]
                                            [--no-proxy NO_PROXY]
                                            [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                            [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                            [--environment-file <HEAT ENVIRONMENT FILE>]
                                            [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                            [--roles-file ROLES_FILE]
                                            [--networks-file NETWORKS_FILE]
                                            [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                            [--no-cleanup]
                                            [--update-plan-only]
                                            [--validation-errors-nonfatal]
                                            [--validation-warnings-fatal]
                                            [--disable-validations]
                                            [--dry-run] [--run-validations]
                                            [--skip-postconfig]
                                            [--force-postconfig]
                                            [--skip-deploy-identifier]
                                            [--rhel-reg]
                                            [--reg-method {satellite,portal}]
                                            [--reg-org REG_ORG] [--reg-force]
                                            [--reg-sat-url REG_SAT_URL]
                                            [--reg-activation-key REG_ACTIVATION_KEY]
                                            [--answers-file ANSWERS_FILE]
                                            [--disable-password-generation]
                                            [--deployed-server]
                                            [--config-download]
                                            [--output-dir OUTPUT_DIR]
                                            [--ceph-ansible-playbook CEPH_ANSIBLE_PLAYBOOK]

表46.1 その他の引数 (オプション):

概要

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。これは、P リリース後に削除されます。)

--ceph-storage-scale CEPH_STORAGE_SCALE

新しい ceph ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。これは、P リリース後に削除されます。)

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。これは、P リリース後に削除されます。)

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、および image サービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--disable-validations

デプロイメント前の検証を完全に無効にします。これらの検証は、組み込みのデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--control-scale CONTROL_SCALE

新しいコントロールノード数 (非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。これは、P リリース後に削除されます。)

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--output-dir OUTPUT_DIR

config-download を使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値 (/var/lib/mistral/<execution id>) が使用されます。

--block-storage-scale BLOCK_STORAGE_SCALE

新しい cinder ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。これは、P リリース後に削除されます。)

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。これは、P リリース後に削除されます。)

--swift-storage-scale SWIFT_STORAGE_SCALE

新しい swift ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。これは、P リリース後に削除されます。)

--config-download

config-download のメカニズムを使用してデプロイメントを実行する

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--ceph-ansible-playbook CEPH_ANSIBLE_PLAYBOOK

更新に使用する ceph-ansible Playbook を切り替えるパス。

--disable-password-generation

パスワードの生成を無効にします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記: 今後のリリースでは、別のコマンドに移行します。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--stack STACK

作成または更新するスタック名

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数 (非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。これは、P リリース後に削除されます。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。これは、P リリース後に削除されます。)

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。これは、P リリース後に削除されます。)

--dry-run

検証のみを実行しますが、変更は適用されません。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

表46.2 登録パラメーター

概要

--reg-method {satellite,portal}

オーバークラウドノードに使用する登録方法。

--reg-sat-url REG_SAT_URL

オーバークラウドノードを登録する Satellite サーバー

--reg-force

すでに登録済みでもシステムを登録します。

--reg-activation-key REG_ACTIVATION_KEY

登録に使用するアクティベーションキー

--rhel-reg

カスタマーポータルまたは Satellite 6 にオーバークラウドノードを登録します。

--reg-org REG_ORG

登録に使用する組織キー。

46.2. overcloud config download

オーバークラウドの設定をダウンロードします。

使用方法

openstack overcloud config download [-h] [--name NAME]
                                           [--config-dir CONFIG_DIR]
                                           [--config-type CONFIG_TYPE]

表46.3 その他の引数 (オプション):

概要

--config-type CONFIG_TYPE

デプロイメントから抽出されるオブジェクト設定の種別。デフォルトはすべてのキーです。

-h, --help

ヘルプメッセージを表示して終了します。

--config-dir CONFIG_DIR

設定ファイルがプッシュされるディレクトリー

--name NAME

プランの名前 (オブジェクトストレージコンテナー、ワークフロー環境、およびオーケストレーションスタック名に使用されます)。

46.3. overcloud container image build

kolla-build を使用してオーバークラウドのコンテナーイメージをビルドします。

使用方法

openstack overcloud container image build [-h] --config-file <yaml
                                                 config file>
                                                 --kolla-config-file <config
                                                 file> [--list-images]
                                                 [--list-dependencies]

表46.4 その他の引数 (オプション):

概要

--kolla-config-file <config file>

使用する kolla 設定ファイルへのパス。複数の設定ファイルを指定できますが、後のファイルの値が優先されます。デフォルトでは、tripleo kolla 設定ファイル /usr/share/tripleo-common/container- images/tripleo_kolla_config_overrides.conf が追加されます。

--list-images

ビルドするのではなくビルドされるイメージを表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--list-dependencies

イメージをビルドするのではなく、イメージビルドの依存関係を表示します。

--config-file <yaml config file>

ビルドするイメージを指定する yaml 設定ファイル。複数回指定できます。順序は保持され、後のファイルは以前のファイルにある一部のオプションを上書きします。他のオプションは追加されます。

46.4. overcloud container image prepare

イメージ、タグ、およびレジストリーを定義するファイルを生成します。

使用方法

openstack overcloud container image prepare [-h]
                                                   [--template-file <yaml template file>]
                                                   [--pull-source <location>]
                                                   [--push-destination <location>]
                                                   [--tag <tag>]
                                                   [--tag-from-label <image label>]
                                                   [--namespace <namespace>]
                                                   [--prefix <prefix>]
                                                   [--suffix <suffix>]
                                                   [--set <variable=value>]
                                                   [--exclude <regex>]
                                                   [--images-file <file path>]
                                                   [--output-images-file <file path>]
                                                   [--service-environment-file <file path>]
                                                   [--environment-file <file path>]
                                                   [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                                   [--env-file <file path>]
                                                   [--output-env-file <file path>]
                                                   [--roles-file ROLES_FILE]

表46.5 その他の引数 (オプション):

概要

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

update コマンドに自動的に追加される環境ファイルディレクトリー。エントリーは、コンテナー化されるサービスで使用されるイメージのみを含むようにフィルターされます。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--pull-source <location>

イメージのプルに使用するイメージレジストリーの場所。(非推奨。--namespace にレジストリーを含めます。

--env-file <file path>

すべてのイメージパラメーターを指定する heat 環境ファイルを書き込むファイル。既存のファイルは上書きされます(非推奨)。代わりに --output-env-file を使用してください)

--output-images-file <file path>

stdout に加えて、結果のイメージエントリーを書き込むファイル。既存のファイルは上書きされます。

--suffix <suffix>

デフォルトの名前接尾辞の置換を上書きします。デフォルト:

--set <variable=value>

--suffix などの専用の引数がない場合でも、テンプレートに変数の値を設定します。

--prefix <prefix>

デフォルトの名前接頭辞の置換を上書きします。デフォルト:openstack-

--tag-from-label <image label>

指定されたラベルの値を使用して、バージョンタグを検出します。

--push-destination <location>

イメージのプッシュ先となるイメージレジストリーの場所。指定した場合、push_destination がすべてのイメージエントリーごとに設定されます。

--exclude <regex>

結果のイメージ名のエントリーに対して照合して最終的な出力から除外するパターン。複数回指定できます。

--images-file <file path>

stdout に加えて、結果のイメージエントリーを書き込むファイル。既存のファイルは上書きされます(非推奨)。代わりに --output-images-file を使用してください)

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。デフォルトの roles_data.yaml を上書きします。

--template-file <yaml template file>

イメージ設定ファイルがビルドされる yaml テンプレートファイル。デフォルト: /usr/share/tripleo-common/container- images/overcloud_containers.yaml.j2

--output-env-file <file path>

すべてのイメージパラメーターを指定する heat 環境ファイルを書き込むファイル。既存のファイルは上書きされます。

-h, --help

ヘルプメッセージを表示して終了します。

--service-environment-file <file path>

コンテナー化されるサービスを指定する環境ファイル。エントリーは、コンテナー化されるサービスで使用されるイメージのみを含むようにフィルターされます。(複数回指定可能)(非推奨。)代わりに --environment-file を使用してください)

--environment-file <file path>, -e <file path>

コンテナー化されるサービスを指定する環境ファイル。エントリーは、コンテナー化されるサービスで使用されるイメージのみを含むようにフィルターされます。(複数回指定することが可能です。)

--namespace <namespace>

デフォルトの名前空間の置換を上書きします。デフォルト:registry.access.redhat.com/rhosp13

--tag <tag>

デフォルトのタグの置換を上書きします。--tag-from-label が指定されている場合には、このタグを使用して検出を開始します。デフォルト: latest。

46.5. overcloud container image tag discover

イメージのバージョンタグを検出します。

使用方法

openstack overcloud container image tag discover [-h] --image
                                                        <container image>
                                                        [--tag-from-label <image label>]

表46.6 その他の引数 (オプション):

概要

--tag-from-label <image label>

指定されたラベルの値を使用してタグを検出します。

-h, --help

ヘルプメッセージを表示して終了します。

--image <container image>

タグを検出するイメージの完全修飾名 (レジストリーおよび安定したタグを含む)。

46.6. overcloud container image upload

オーバークラウドのコンテナーイメージをレジストリーにプッシュします。

使用方法

openstack overcloud container image upload [-h] --config-file <yaml
                                                  config file>

表46.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--config-file <yaml config file>

イメージビルドを指定する yaml 設定ファイル。複数回指定できます。順序は保持され、後のファイルは以前のファイルにある一部のオプションを上書きします。他のオプションは追加されます。

46.7. overcloud credentials

overcloudrc ファイルを作成します。

使用方法

openstack overcloud credentials [-h] [--directory [DIRECTORY]] plan

表46.8 位置引数

概要

plan

rc ファイルを作成するプランの名前。

表46.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--directory [DIRECTORY]

rc ファイルを作成するディレクトリー。デフォルトは現在のディレクトリーです。

46.8. overcloud delete

オーバークラウドスタックおよびプランを削除します。

使用方法

openstack overcloud delete [-h] [-y] [stack]

表46.10 位置引数

Summary

stack

削除する heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME)

表46.11 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-y, --yes

yes/no プロンプトを省略します (yes と仮定)。

46.9. overcloud deploy

オーバークラウドをデプロイします。

使用方法

openstack overcloud deploy [--templates [TEMPLATES]] [--stack STACK]
                                  [--timeout <TIMEOUT>]
                                  [--control-scale CONTROL_SCALE]
                                  [--compute-scale COMPUTE_SCALE]
                                  [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                  [--block-storage-scale BLOCK_STORAGE_SCALE]
                                  [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                  [--control-flavor CONTROL_FLAVOR]
                                  [--compute-flavor COMPUTE_FLAVOR]
                                  [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                  [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                  [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                  [--libvirt-type {kvm,qemu}]
                                  [--ntp-server NTP_SERVER]
                                  [--no-proxy NO_PROXY]
                                  [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                  [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                  [--environment-file <HEAT ENVIRONMENT FILE>]
                                  [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                  [--roles-file ROLES_FILE]
                                  [--networks-file NETWORKS_FILE]
                                  [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                  [--no-cleanup] [--update-plan-only]
                                  [--validation-errors-nonfatal]
                                  [--validation-warnings-fatal]
                                  [--disable-validations] [--dry-run]
                                  [--run-validations] [--skip-postconfig]
                                  [--force-postconfig]
                                  [--skip-deploy-identifier] [--rhel-reg]
                                  [--reg-method {satellite,portal}]
                                  [--reg-org REG_ORG] [--reg-force]
                                  [--reg-sat-url REG_SAT_URL]
                                  [--reg-activation-key REG_ACTIVATION_KEY]
                                  [--answers-file ANSWERS_FILE]
                                  [--disable-password-generation]
                                  [--deployed-server] [--config-download]
                                  [--output-dir OUTPUT_DIR]

表46.12 その他の引数 (オプション):

概要

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。これは、P リリース後に削除されます。)

--ceph-storage-scale CEPH_STORAGE_SCALE

新しい ceph ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。これは、P リリース後に削除されます。)

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。これは、P リリース後に削除されます。)

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、および image サービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--disable-validations

デプロイメント前の検証を完全に無効にします。これらの検証は、組み込みのデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--control-scale CONTROL_SCALE

新しいコントロールノード数 (非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。これは、P リリース後に削除されます。)

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--output-dir OUTPUT_DIR

config-download を使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値 (/var/lib/mistral/<execution id>) が使用されます。

--block-storage-scale BLOCK_STORAGE_SCALE

新しい cinder ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。これは、P リリース後に削除されます。)

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。これは、P リリース後に削除されます。)

--swift-storage-scale SWIFT_STORAGE_SCALE

新しい swift ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。これは、P リリース後に削除されます。)

--config-download

config-download のメカニズムを使用してデプロイメントを実行する

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--disable-password-generation

パスワードの生成を無効にします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記: 今後のリリースでは、別のコマンドに移行します。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--stack STACK

作成または更新するスタック名

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数 (非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。これは、P リリース後に削除されます。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。これは、P リリース後に削除されます。)

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。これは、P リリース後に削除されます。)

--dry-run

検証のみを実行しますが、変更は適用されません。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

表46.13 登録パラメーター

概要

--reg-method {satellite,portal}

オーバークラウドノードに使用する登録方法。

--reg-sat-url REG_SAT_URL

オーバークラウドノードを登録する Satellite サーバー

--reg-force

すでに登録済みでもシステムを登録します。

--reg-activation-key REG_ACTIVATION_KEY

登録に使用するアクティベーションキー

--rhel-reg

カスタマーポータルまたは Satellite 6 にオーバークラウドノードを登録します。

--reg-org REG_ORG

登録に使用する組織キー。

46.10. overcloud execute

サーバー上で Heat ソフトウェア設定を実行します。

使用方法

openstack overcloud execute [-h] [-s SERVER_NAME] [-g GROUP] file_in

表46.14 位置引数

概要

file_in

なし

表46.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-s SERVER_NAME, --server_name SERVER_NAME

照合する nova server_name またはパーシャル名。

-g GROUP、--group GROUP

Heat ソフトウェア設定 "グループ" 種別。デフォルトは script です。

46.11. overcloud failures

デプロイメントの失敗を取得します。

使用方法

openstack overcloud failures [-h] [--plan PLAN]

表46.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--plan PLAN、--stack PLAN

スタック/プラン の名前 (デフォルト:overcloud)

46.12. overcloud ffwd-upgrade converge

オーバークラウドノードの Fast Forward Upgrade を収束します。これは、Fast Forward Upgrade を完了するための最後のステップです。主なタスクは、プランおよびスタックを更新して、将来のスタック更新のブロックを解除します。ffwd アップグレードのワークフローでは、OS::TripleO および OS::Heat リソースの config-download Software/Structured Deployment を設定し、使用しました。これにより、それらの設定をデフォルト値に戻します。

使用方法

openstack overcloud ffwd-upgrade converge [--templates [TEMPLATES]]
                                                 [--stack STACK]
                                                 [--timeout <TIMEOUT>]
                                                 [--control-scale CONTROL_SCALE]
                                                 [--compute-scale COMPUTE_SCALE]
                                                 [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                                 [--block-storage-scale BLOCK_STORAGE_SCALE]
                                                 [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                                 [--control-flavor CONTROL_FLAVOR]
                                                 [--compute-flavor COMPUTE_FLAVOR]
                                                 [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                                 [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                                 [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                                 [--libvirt-type {kvm,qemu}]
                                                 [--ntp-server NTP_SERVER]
                                                 [--no-proxy NO_PROXY]
                                                 [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                                 [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                                 [--environment-file <HEAT ENVIRONMENT FILE>]
                                                 [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                                 [--roles-file ROLES_FILE]
                                                 [--networks-file NETWORKS_FILE]
                                                 [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                                 [--no-cleanup]
                                                 [--update-plan-only]
                                                 [--validation-errors-nonfatal]
                                                 [--validation-warnings-fatal]
                                                 [--disable-validations]
                                                 [--dry-run]
                                                 [--run-validations]
                                                 [--skip-postconfig]
                                                 [--force-postconfig]
                                                 [--skip-deploy-identifier]
                                                 [--rhel-reg]
                                                 [--reg-method {satellite,portal}]
                                                 [--reg-org REG_ORG]
                                                 [--reg-force]
                                                 [--reg-sat-url REG_SAT_URL]
                                                 [--reg-activation-key REG_ACTIVATION_KEY]
                                                 [--answers-file ANSWERS_FILE]
                                                 [--disable-password-generation]
                                                 [--deployed-server]
                                                 [--config-download]
                                                 [--output-dir OUTPUT_DIR]
                                                 [--yes]

表46.17 その他の引数 (オプション):

概要

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。これは、P リリース後に削除されます。)

--ceph-storage-scale CEPH_STORAGE_SCALE

新しい ceph ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。これは、P リリース後に削除されます。)

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。これは、P リリース後に削除されます。)

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、および image サービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--disable-validations

デプロイメント前の検証を完全に無効にします。これらの検証は、組み込みのデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

はい

--yes を使用して、ffwd-upgrade 操作の前に必要な確認をスキップします。注意して使用してください。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--control-scale CONTROL_SCALE

新しいコントロールノード数 (非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。これは、P リリース後に削除されます。)

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--output-dir OUTPUT_DIR

config-download を使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値 (/var/lib/mistral/<execution id>) が使用されます。

--block-storage-scale BLOCK_STORAGE_SCALE

新しい cinder ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。これは、P リリース後に削除されます。)

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。これは、P リリース後に削除されます。)

--swift-storage-scale SWIFT_STORAGE_SCALE

新しい swift ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。これは、P リリース後に削除されます。)

--config-download

config-download のメカニズムを使用してデプロイメントを実行する

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--disable-password-generation

パスワードの生成を無効にします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記: 今後のリリースでは、別のコマンドに移行します。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--stack STACK

作成または更新するスタック名

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数 (非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。これは、P リリース後に削除されます。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。これは、P リリース後に削除されます。)

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。これは、P リリース後に削除されます。)

--dry-run

検証のみを実行しますが、変更は適用されません。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

表46.18 登録パラメーター

概要

--reg-method {satellite,portal}

オーバークラウドノードに使用する登録方法。

--reg-sat-url REG_SAT_URL

オーバークラウドノードを登録する Satellite サーバー

--reg-force

すでに登録済みでもシステムを登録します。

--reg-activation-key REG_ACTIVATION_KEY

登録に使用するアクティベーションキー

--rhel-reg

カスタマーポータルまたは Satellite 6 にオーバークラウドノードを登録します。

--reg-org REG_ORG

登録に使用する組織キー。

46.13. overcloud ffwd-upgrade prepare

オーバークラウドノードの heat スタックの更新を実行して、heat stack の出力を更新します。heat スタックの出力は、後でメジャーアップグレードのワークフローを提供する Ansible Playbook を生成するのに使用されます。これは、オーバークラウドの Fast Forward Upgrade の最初のステップとして使用されます。

使用方法

openstack overcloud ffwd-upgrade prepare [--templates [TEMPLATES]]
                                                [--stack STACK]
                                                [--timeout <TIMEOUT>]
                                                [--control-scale CONTROL_SCALE]
                                                [--compute-scale COMPUTE_SCALE]
                                                [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                                [--block-storage-scale BLOCK_STORAGE_SCALE]
                                                [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                                [--control-flavor CONTROL_FLAVOR]
                                                [--compute-flavor COMPUTE_FLAVOR]
                                                [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                                [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                                [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                                [--libvirt-type {kvm,qemu}]
                                                [--ntp-server NTP_SERVER]
                                                [--no-proxy NO_PROXY]
                                                [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                                [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                                [--environment-file <HEAT ENVIRONMENT FILE>]
                                                [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                                [--roles-file ROLES_FILE]
                                                [--networks-file NETWORKS_FILE]
                                                [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                                [--no-cleanup]
                                                [--update-plan-only]
                                                [--validation-errors-nonfatal]
                                                [--validation-warnings-fatal]
                                                [--disable-validations]
                                                [--dry-run]
                                                [--run-validations]
                                                [--skip-postconfig]
                                                [--force-postconfig]
                                                [--skip-deploy-identifier]
                                                [--rhel-reg]
                                                [--reg-method {satellite,portal}]
                                                [--reg-org REG_ORG]
                                                [--reg-force]
                                                [--reg-sat-url REG_SAT_URL]
                                                [--reg-activation-key REG_ACTIVATION_KEY]
                                                [--answers-file ANSWERS_FILE]
                                                [--disable-password-generation]
                                                [--deployed-server]
                                                [--config-download]
                                                [--output-dir OUTPUT_DIR]
                                                [--yes]
                                                [--ceph-ansible-playbook CEPH_ANSIBLE_PLAYBOOK]

表46.19 その他の引数 (オプション):

概要

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。これは、P リリース後に削除されます。)

--ceph-storage-scale CEPH_STORAGE_SCALE

新しい ceph ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。これは、P リリース後に削除されます。)

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。これは、P リリース後に削除されます。)

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、および image サービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--disable-validations

デプロイメント前の検証を完全に無効にします。これらの検証は、組み込みのデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

はい

--yes を使用して、ffwd-upgrade 操作の前に必要な確認をスキップします。注意して使用してください。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--control-scale CONTROL_SCALE

新しいコントロールノード数 (非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。これは、P リリース後に削除されます。)

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--output-dir OUTPUT_DIR

config-download を使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値 (/var/lib/mistral/<execution id>) が使用されます。

--block-storage-scale BLOCK_STORAGE_SCALE

新しい cinder ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。これは、P リリース後に削除されます。)

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。これは、P リリース後に削除されます。)

--swift-storage-scale SWIFT_STORAGE_SCALE

新しい swift ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。これは、P リリース後に削除されます。)

--config-download

config-download のメカニズムを使用してデプロイメントを実行する

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--ceph-ansible-playbook CEPH_ANSIBLE_PLAYBOOK

アップグレードに使用する ceph-ansible Playbook を切り替えるパス。

--disable-password-generation

パスワードの生成を無効にします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記: 今後のリリースでは、別のコマンドに移行します。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--stack STACK

作成または更新するスタック名

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数 (非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。これは、P リリース後に削除されます。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。これは、P リリース後に削除されます。)

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。これは、P リリース後に削除されます。)

--dry-run

検証のみを実行しますが、変更は適用されません。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

表46.20 登録パラメーター

概要

--reg-method {satellite,portal}

オーバークラウドノードに使用する登録方法。

--reg-sat-url REG_SAT_URL

オーバークラウドノードを登録する Satellite サーバー

--reg-force

すでに登録済みでもシステムを登録します。

--reg-activation-key REG_ACTIVATION_KEY

登録に使用するアクティベーションキー

--rhel-reg

カスタマーポータルまたは Satellite 6 にオーバークラウドノードを登録します。

--reg-org REG_ORG

登録に使用する組織キー。

46.14. overcloud ffwd-upgrade run

オーバークラウドノードで Fast Forward Upgrade Ansible Playbook を実行します。これにより、fast_forward_upgrade_playbook.yaml Ansible Playbook が実行されます。この Playbook は、ffwd-upgrade prepare コマンドを実行したときに生成されました。'ffwd- upgrade run ' の実行は、ffwd アップグレードワークフローの 2 番目のステップです。

使用方法

openstack overcloud ffwd-upgrade run [-h] [--yes]
                                            [--static-inventory STATIC_INVENTORY]
                                            [--ssh-user SSH_USER]
                                            [--stack STACK]

表46.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--stack STACK

Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME)

--static-inventory STATIC_INVENTORY

使用する既存の Ansible インベントリーへのパス。指定されていない場合は、~/tripleo-ansible- inventory.yaml に生成されます。

はい

--yes を使用して、ffwd-upgrade 操作の前に必要な確認をスキップします。注意して使用してください。

--ssh-user SSH_USER

オーバークラウドノードに接続するための ssh ユーザー名。

46.15. overcloud generate fencing

フェンシングパラメーターを生成します。

使用方法

openstack overcloud generate fencing [-h] [-a FENCE_ACTION]
                                            [--delay DELAY] [--ipmi-lanplus]
                                            [--ipmi-no-lanplus]
                                            [--ipmi-cipher IPMI_CIPHER]
                                            [--ipmi-level IPMI_LEVEL]
                                            [--output OUTPUT]
                                            instackenv

表46.22 位置引数

概要

instackenv

なし

表46.23 その他の引数 (オプション):

概要

--ipmi-no-lanplus

lanplus を使用しません。デフォルトは false です。

--output OUTPUT

ファイルにパラメーターを書き込みます。

--delay DELAY

フェンシングが開始するまで遅延の秒数を待機します。

--ipmi-lanplus

非推奨: これがデフォルトです。

-a FENCE_ACTION、--action FENCE_ACTION

非推奨: このオプションは無視されます。

--ipmi-level IPMI_LEVEL

ipmi デバイスの権限レベル。有効なレベル: callback、user、operator、administrator

--ipmi-cipher IPMI_CIPHER

使用する暗号スイート (ipmitool -c パラメーターと同じ)。

-h, --help

ヘルプメッセージを表示して終了します。

46.16. overcloud image build

オーバークラウドのイメージをビルドします。

使用方法

openstack overcloud image build [-h] [--config-file <yaml config file>]
                                       [--image-name <image name>] [--no-skip]
                                       [--output-directory OUTPUT_DIRECTORY]

表46.24 その他の引数 (オプション):

概要

--no-skip

キャッシュされたイメージが存在する場合はビルドを省略します。

-h, --help

ヘルプメッセージを表示して終了します。

--config-file <yaml config file>

イメージビルドを指定する yaml 設定ファイル。複数回指定できます。順序は保持され、後のファイルは以前のファイルにある一部のオプションを上書きします。他のオプションは追加されます。

--image-name <image name>

ビルドするイメージの名前。複数回指定できます。指定されていない場合は、指定の YAML ファイルのすべてのイメージがビルドされます。

--output-directory OUTPUT_DIRECTORY

イメージのアウトプットディレクトリー。デフォルトは $TRIPLEO_ROOT で、未設定の場合は現在のディレクトリーです。

46.17. overcloud image upload

既存のイメージファイルからオーバークラウドの glance イメージを作成する。

使用方法

openstack overcloud image upload [-h] [--image-path IMAGE_PATH]
                                        [--os-image-name OS_IMAGE_NAME]
                                        [--ironic-python-agent-name IPA_NAME]
                                        [--http-boot HTTP_BOOT]
                                        [--update-existing] [--whole-disk]
                                        [--architecture ARCHITECTURE]
                                        [--platform PLATFORM]

表46.25 その他の引数 (オプション):

概要

--platform PLATFORM

これらのイメージのプラットフォーム種別。platform はアーキテクチャーのサブカテゴリーです。たとえば、x86_64 の汎用イメージがありますが、SNB (SandyBridge) に固有のイメージを提供することができます。

--update-existing

イメージがすでに存在する場合は更新します。

--os-image-name OS_IMAGE_NAME

Openstack ディスクイメージのファイル名

--image-path IMAGE_PATH

イメージファイルが含まれるディレクトリーへのパス

--http-boot HTTP_BOOT

イントロスペクションイメージのルートディレクトリー

--whole-disk

これを設定すると、アップロードされる overcloud-full イメージが完全なディスクのイメージとみなされます。

-h, --help

ヘルプメッセージを表示して終了します。

--architecture ARCHITECTURE

これらのイメージのアーキテクチャー種別。x86_64i386、および ppc64le は共通オプションです。このオプションは、instackenv.json の少なくとも 1 つの arch 値と一致している必要があります。

--ironic-python-agent-name IPA_NAME

Openstack ironic-python-agent (agent) イメージのファイル名

46.18. overcloud netenv validate

ネットワークの環境ファイルを検証します。

使用方法

openstack overcloud netenv validate [-h] [-f NETENV]

表46.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-f NETENV、--file NETENV

ネットワーク環境ファイルへのパス

46.19. overcloud node configure

ノードのブートオプションを設定します。

使用方法

openstack overcloud node configure [-h] [--all-manageable]
                                          [--deploy-kernel DEPLOY_KERNEL]
                                          [--deploy-ramdisk DEPLOY_RAMDISK]
                                          [--instance-boot-option {local,netboot}]
                                          [--root-device ROOT_DEVICE]
                                          [--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE]
                                          [--overwrite-root-device-hints]
                                          [<node_uuid> [<node_uuid> ...]]

表46.27 位置引数

概要

<node_uuid>

設定するノードのベアメタルノード uuid

表46.28 その他の引数 (オプション):

概要

--deploy-kernel DEPLOY_KERNEL

デプロイカーネルのあるイメージ。

--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE

検出されるルートデバイスの最小サイズ (gib 単位)。--root-device と併用します。

--root-device ROOT_DEVICE

ノードのルートデバイスを定義します。選択元となるデバイス名の一覧 (/dev を省く)、または 2 つのストラテジー (最大または最小) のいずれかを選択できます。機能するには、イントロスペクション後にこのコマンドを実行する必要があります。

--all-manageable

現在 manageable の状態にあるノードを設定します。

--deploy-ramdisk DEPLOY_RAMDISK

デプロイ ramdisk のあるイメージ

--instance-boot-option {local,netboot}

インスタンスをローカルのハードドライブ (local) またはネットワーク (netboot) から起動するかどうかを設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--overwrite-root-device-hints

--root-device が使用されたときに既存のルートデバイスヒントを上書きするかどうか。

46.20. overcloud node delete

オーバークラウドノードを削除します。

使用方法

openstack overcloud node delete [-h] [--stack STACK]
                                       [--templates [TEMPLATES]]
                                       [-e <HEAT ENVIRONMENT FILE>]
                                       [--timeout <TIMEOUT>]
                                       <node> [<node> ...]

表46.29 位置引数

概要

<node>

削除するノード ID

表46.30 その他の引数 (オプション):

概要

-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。) この引数は非推奨です。このコマンドはデプロイメントプランを活用しています。プランは、このコマンドを実行する前に更新する必要があります。それ以外の場合は、この引数は警告なしで無視されます。

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。この引数は非推奨です。このコマンドはデプロイメントプランを活用しています。プランは、このコマンドを実行する前に更新する必要があります。それ以外の場合は、この引数は警告なしで無視されます。

-h, --help

ヘルプメッセージを表示して終了します。

--stack STACK

スケーリングする heat スタックの名前または ID(デフォルト=env: OVERCLOUD_STACK_NAME)

--timeout <TIMEOUT>

ノードが削除されるまで待機するタイムアウト (分単位)。keystone セッション時間により、タイムアウトに 4 時間の上限がある点に注意してください。

46.21. overcloud node discover

BMC をポーリングしてオーバークラウドノードを検出します。

使用方法

openstack overcloud node discover [-h] (--ip <ips> | --range <range>)
                                         --credentials <key:value>
                                         [--port <ports>] [--introspect]
                                         [--run-validations] [--provide]
                                         [--no-deploy-image]
                                         [--instance-boot-option {local,netboot}]

表46.31 その他の引数 (オプション):

概要

--provide

ノードを指定 (利用可能に) します。

--no-deploy-image

デプロイカーネルおよび ramdisk の設定を省略します。

--instance-boot-option {local,netboot}

インスタンスをローカルのハードドライブ (local) またはネットワーク (netboot) から起動するかどうかを設定します。

--credentials <key:value>

使用できる認証情報のキー/値のペア

--range <range>

プローブまでの IP 範囲

--port <ports>

プローブする BMC ポート

--run-validations

デプロイメント前の検証を実行します。これらの外部検証は TripleO Validations プロジェクトからのものです。

-h, --help

ヘルプメッセージを表示して終了します。

--introspect

インポートしたノードをイントロスペクションします。

--ip <ips>

プローブする IP アドレス

46.22. overcloud node import

JSON、YAML または CSV ファイルからベアメタルノードをインポートします。ノードのステータスはデフォルトで manageable に設定されます。

使用方法

openstack overcloud node import [-h] [--introspect] [--run-validations]
                                       [--validate-only] [--provide]
                                       [--no-deploy-image]
                                       [--instance-boot-option {local,netboot}]
                                       env_file

表46.32 位置引数

概要

env_file

なし

表46.33 その他の引数 (オプション):

概要

--provide

ノードを指定 (利用可能に) します。

--no-deploy-image

デプロイカーネルおよび ramdisk の設定を省略します。

--validate-only

env_file を検証し、実際にノードをインポートせずに終了します。

--run-validations

デプロイメント前の検証を実行します。これらの外部検証は TripleO Validations プロジェクトからのものです。

--instance-boot-option {local,netboot}

インスタンスをローカルのハードドライブ (local) またはネットワーク (netboot) から起動するかどうかを設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--introspect

インポートしたノードをイントロスペクションします。

46.23. overcloud node introspect

manageable の状態にある、指定のノードまたはすべてのノードをイントロスペクションします。

使用方法

openstack overcloud node introspect [-h] [--all-manageable] [--provide]
                                           [--run-validations]
                                           [<node_uuid> [<node_uuid> ...]]

表46.34 位置引数

概要

<node_uuid>

イントロスペクションするノードのベアメタルノード uuid

表46.35 その他の引数 (オプション):

概要

--provide

ノードのイントロスペクション後に指定 (利用可能に) します。

--all-manageable

現在 manageable の状態にある全ノードをイントロスペクションします。

-h, --help

ヘルプメッセージを表示して終了します。

--run-validations

デプロイメント前の検証を実行します。これらの外部検証は TripleO Validations プロジェクトからのものです。

46.24. overcloud node provide

UUID または現在の manageable の状態をもとに、ノードを利用可能とマークします。

使用方法

openstack overcloud node provide [-h] [--all-manageable]
                                        [<node_uuid> [<node_uuid> ...]]

表46.36 位置引数

概要

<node_uuid>

指定するノードのベアメタルノード uuid

表46.37 その他の引数 (オプション):

概要

--all-manageable

現在 manageable の状態にあるノードをすべて提供します。

-h, --help

ヘルプメッセージを表示して終了します。

46.25. overcloud parameters set

プランのパラメーターを設定します。

使用方法

openstack overcloud parameters set [-h] name file_in

表46.38 位置引数

概要

name

プランの名前 (swift コンテナー、Mistral 環境、および Heat スタック名に使用されます)。

file_in

なし

表46.39 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

46.26. overcloud plan create

デプロイメントプランを作成します。

使用方法

openstack overcloud plan create [-h] [--templates TEMPLATES]
                                       [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                       [--disable-password-generation]
                                       [--source-url SOURCE_URL]
                                       name

表46.40 位置引数

概要

name

プランの名前 (オブジェクトストレージコンテナー、ワークフロー環境、およびオーケストレーションスタック名に使用されます)。

表46.41 その他の引数 (オプション):

概要

--source-url SOURCE_URL

デプロイする Heat テンプレートが格納されている git リポジトリーの url。このオプションまたは --templates を指定しないと、アンダークラウドにパッケージ化されたテンプレートが使用されます。

-h, --help

ヘルプメッセージを表示して終了します。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--disable-password-generation

パスワードの生成を無効にします。

--templates TEMPLATES

デプロイする Heat テンプレートが格納されているディレクトリー。このオプションまたは --source_url を指定しないと、アンダークラウドにパッケージ化されたテンプレートが使用されます。

46.27. overcloud plan delete

オーバークラウドデプロイメントプランを削除します。同じ名前のスタックが存在する場合には、プランは削除されません。

使用方法

openstack overcloud plan delete [-h] <name> [<name> ...]

表46.42 位置引数

概要

<name>

削除するプランの名前

表46.43 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

46.28. overcloud plan deploy

デプロイメントプランをデプロイします。

使用方法

openstack overcloud plan deploy [-h] [--timeout <TIMEOUT>]
                                       [--run-validations]
                                       name

表46.44 位置引数

概要

name

デプロイするプランの名前。

表46.45 その他の引数 (オプション):

概要

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

-h, --help

ヘルプメッセージを表示して終了します。

--run-validations

デプロイメント前の検証を実行します。これらの外部検証は TripleO Validations プロジェクトからのものです。

46.29. overcloud plan export

デプロイメントプランをエクスポートします。

使用方法

openstack overcloud plan export [-h] [--output-file <output file>]
                                       [--force-overwrite]
                                       <name>

表46.46 位置引数

概要

<name>

エクスポートするプランの名前。

表46.47 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--output-file <output file>, -o <output file>

エクスポート用の出力ファイルの名前。デフォルトは "<name>.tar.gz" です。

--force-overwrite, -f

出力ファイルが存在する場合は上書きします。

46.30. overcloud plan list

オーバークラウドデプロイメントプランを一覧表示します。

使用方法

openstack overcloud plan list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]

表46.48 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表46.49 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表46.50 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表46.51 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表46.52 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

46.31. overcloud profiles list

オーバークラウドノードのプロファイルを一覧表示します。

使用方法

openstack overcloud profiles list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN] [--all]
                                         [--control-scale CONTROL_SCALE]
                                         [--compute-scale COMPUTE_SCALE]
                                         [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                         [--block-storage-scale BLOCK_STORAGE_SCALE]
                                         [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                         [--control-flavor CONTROL_FLAVOR]
                                         [--compute-flavor COMPUTE_FLAVOR]
                                         [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                         [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                         [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]

表46.53 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表46.54 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表46.55 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表46.56 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表46.57 その他の引数 (オプション):

概要

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー

--control-flavor CONTROL_FLAVOR

コントロールノードに使用する nova フレーバー。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー

--control-scale CONTROL_SCALE

新しいコントロールノード数。

--ceph-storage-scale CEPH_STORAGE_SCALE

新しい ceph ストレージノード数。

--block-storage-scale BLOCK_STORAGE_SCALE

新しい cinder ストレージノード数。

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数。

--swift-storage-scale SWIFT_STORAGE_SCALE

新しい swift ストレージノード数。

-h, --help

ヘルプメッセージを表示して終了します。

--all

nova で利用できないノードであっても、すべてのノードを一覧表示します。

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用する nova フレーバー。

46.32. overcloud profiles match

ノード上のプロファイルを割り当ておよび検証します。

使用方法

openstack overcloud profiles match [-h] [--dry-run]
                                          [--control-scale CONTROL_SCALE]
                                          [--compute-scale COMPUTE_SCALE]
                                          [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                          [--block-storage-scale BLOCK_STORAGE_SCALE]
                                          [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                          [--control-flavor CONTROL_FLAVOR]
                                          [--compute-flavor COMPUTE_FLAVOR]
                                          [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                          [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                          [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]

表46.58 その他の引数 (オプション):

概要

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー

--control-flavor CONTROL_FLAVOR

コントロールノードに使用する nova フレーバー。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー

--control-scale CONTROL_SCALE

新しいコントロールノード数。

--ceph-storage-scale CEPH_STORAGE_SCALE

新しい ceph ストレージノード数。

--block-storage-scale BLOCK_STORAGE_SCALE

新しい cinder ストレージノード数。

--dry-run

検証のみを実行しますが、変更は適用されません。

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数。

--swift-storage-scale SWIFT_STORAGE_SCALE

新しい swift ストレージノード数。

-h, --help

ヘルプメッセージを表示して終了します。

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用する nova フレーバー。

46.33. overcloud raid create

指定のノードに RAID を作成します。

使用方法

openstack overcloud raid create [-h] --node NODE configuration

表46.59 位置引数

概要

configuration

RAID 設定 (yaml/json 文字列またはファイル名)

表46.60 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--node NODE

RAID を作成するノード (状態が manageable でなければなりません)。複数回指定できます。

46.34. overcloud role list

利用可能なロールを一覧表示します。

使用方法

openstack overcloud role list [-h] [--roles-path <roles directory>]

表46.61 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--roles-path <roles directory>

ロールの yaml ファイルが含されるファイルシステムパス。デフォルトでは /usr/share/openstack-tripleo-heat- templates/roles です。

46.35. overcloud role show

特定のロールに関する情報を表示します。

使用方法

openstack overcloud role show [-h] [--roles-path <roles directory>]
                                     <role>

表46.62 位置引数

概要

<role>

詳細情報を表示するロール。

表46.63 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--roles-path <roles directory>

ロールの yaml ファイルが含されるファイルシステムパス。デフォルトでは /usr/share/openstack-tripleo-heat- templates/roles です。

46.36. overcloud roles generate

roles_data.yaml ファイルを生成します。

使用方法

openstack overcloud roles generate [-h]
                                          [--roles-path <roles directory>]
                                          [-o <output file>] [--skip-validate]
                                          <role> [<role> ...]

表46.64 位置引数

概要

<role>

デプロイメントの roles_data.yaml ファイルを生成するために使用するロールの一覧。注記: ロールに primary および controller タグがない場合は、順序が重要になります。ロールがタグ付けされない場合、最初に一覧表示されるロールはプライマリーロールとみなされます。これは通常、Controller ロールです。

表46.65 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-o <output file>, --output-file <output file>

roles_data.yaml など、すべての出力をキャプチャーするためのファイル。

--roles-path <roles directory>

ロールの yaml ファイルが含されるファイルシステムパス。デフォルトでは /usr/share/openstack-tripleo-heat- templates/roles です。

--skip-validate

roles_data.yaml を生成する際に、ロールのメタデータ種別の検証をスキップします。

46.37. overcloud status

デプロイメントのステータスを取得します。

使用方法

openstack overcloud status [-h] [--plan PLAN]

表46.66 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--plan PLAN、--stack PLAN

スタック/プラン の名前 (デフォルト:overcloud)

46.38. overcloud support report collect

選択したサーバーで sosreport を実行します。

使用方法

openstack overcloud support report collect [-h] [-c CONTAINER]
                                                  [-o DESTINATION]
                                                  [--skip-container-delete]
                                                  [-t TIMEOUT]
                                                  [-n CONCURRENCY]
                                                  [--collect-only | --download-only]
                                                  server_name

表46.67 位置引数

概要

server_name

照合する nova server_name またはパーシャル名。たとえば、controller は環境のすべてのコントローラーと一致します。

表46.68 その他の引数 (オプション):

概要

-c CONTAINER, --container CONTAINER

ログを保存する swift コンテナー

-o DESTINATION, --output DESTINATION

レポートの出力ディレクトリー

--skip-container-delete

ファイルがダウンロードされた後にコンテナーを削除しません。--collect-only または --download- only が指定されている場合は無視されます。

--collect-only

ログのダウンロードをスキップし、ログの収集およびコンテナーへの配置だけを実施します。

--download-only

生成をスキップし、指定されたコンテナーからのダウンロードだけを実施します。

-n CONCURRENCY、--concurrency CONCURRENCY

実行する並列ログコレクションおよびオブジェクトの削除タスクの数。

-t TIMEOUT, --timeout TIMEOUT

ログの収集およびコンテナーの削除ワークフローが完了するまでの最大待機時間。

-h, --help

ヘルプメッセージを表示して終了します。

46.39. overcloud update converge

オーバークラウドノードで更新を収束します。これによりプランおよびスタックが復元され、通常のデプロイメントワークフローに戻されます。

使用方法

openstack overcloud update converge [--templates [TEMPLATES]]
                                           [--stack STACK]
                                           [--timeout <TIMEOUT>]
                                           [--control-scale CONTROL_SCALE]
                                           [--compute-scale COMPUTE_SCALE]
                                           [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                           [--block-storage-scale BLOCK_STORAGE_SCALE]
                                           [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                           [--control-flavor CONTROL_FLAVOR]
                                           [--compute-flavor COMPUTE_FLAVOR]
                                           [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                           [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                           [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                           [--libvirt-type {kvm,qemu}]
                                           [--ntp-server NTP_SERVER]
                                           [--no-proxy NO_PROXY]
                                           [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                           [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                           [--environment-file <HEAT ENVIRONMENT FILE>]
                                           [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                           [--roles-file ROLES_FILE]
                                           [--networks-file NETWORKS_FILE]
                                           [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                           [--no-cleanup] [--update-plan-only]
                                           [--validation-errors-nonfatal]
                                           [--validation-warnings-fatal]
                                           [--disable-validations] [--dry-run]
                                           [--run-validations]
                                           [--skip-postconfig]
                                           [--force-postconfig]
                                           [--skip-deploy-identifier]
                                           [--rhel-reg]
                                           [--reg-method {satellite,portal}]
                                           [--reg-org REG_ORG] [--reg-force]
                                           [--reg-sat-url REG_SAT_URL]
                                           [--reg-activation-key REG_ACTIVATION_KEY]
                                           [--answers-file ANSWERS_FILE]
                                           [--disable-password-generation]
                                           [--deployed-server]
                                           [--config-download]
                                           [--output-dir OUTPUT_DIR]

表46.69 その他の引数 (オプション):

概要

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。これは、P リリース後に削除されます。)

--ceph-storage-scale CEPH_STORAGE_SCALE

新しい ceph ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。これは、P リリース後に削除されます。)

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。これは、P リリース後に削除されます。)

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、および image サービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--disable-validations

デプロイメント前の検証を完全に無効にします。これらの検証は、組み込みのデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--control-scale CONTROL_SCALE

新しいコントロールノード数 (非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。これは、P リリース後に削除されます。)

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--output-dir OUTPUT_DIR

config-download を使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値 (/var/lib/mistral/<execution id>) が使用されます。

--block-storage-scale BLOCK_STORAGE_SCALE

新しい cinder ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。これは、P リリース後に削除されます。)

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。これは、P リリース後に削除されます。)

--swift-storage-scale SWIFT_STORAGE_SCALE

新しい swift ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。これは、P リリース後に削除されます。)

--config-download

config-download のメカニズムを使用してデプロイメントを実行する

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--disable-password-generation

パスワードの生成を無効にします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記: 今後のリリースでは、別のコマンドに移行します。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--stack STACK

作成または更新するスタック名

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数 (非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。これは、P リリース後に削除されます。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。これは、P リリース後に削除されます。)

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。これは、P リリース後に削除されます。)

--dry-run

検証のみを実行しますが、変更は適用されません。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

表46.70 登録パラメーター

概要

--reg-method {satellite,portal}

オーバークラウドノードに使用する登録方法。

--reg-sat-url REG_SAT_URL

オーバークラウドノードを登録する Satellite サーバー

--reg-force

すでに登録済みでもシステムを登録します。

--reg-activation-key REG_ACTIVATION_KEY

登録に使用するアクティベーションキー

--rhel-reg

カスタマーポータルまたは Satellite 6 にオーバークラウドノードを登録します。

--reg-org REG_ORG

登録に使用する組織キー。

46.40. overcloud update prepare

オーバークラウドノードの heat スタックの更新を実行して、heat stack の出力を更新します。heat スタックの出力は、後でマイナー更新のワークフローを提供する Ansible Playbook を生成するのに使用されます。これは、オーバークラウドのマイナー更新の最初のステップとして使用されます。

使用方法

openstack overcloud update prepare [--templates [TEMPLATES]]
                                          [--stack STACK]
                                          [--timeout <TIMEOUT>]
                                          [--control-scale CONTROL_SCALE]
                                          [--compute-scale COMPUTE_SCALE]
                                          [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                          [--block-storage-scale BLOCK_STORAGE_SCALE]
                                          [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                          [--control-flavor CONTROL_FLAVOR]
                                          [--compute-flavor COMPUTE_FLAVOR]
                                          [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                          [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                          [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                          [--libvirt-type {kvm,qemu}]
                                          [--ntp-server NTP_SERVER]
                                          [--no-proxy NO_PROXY]
                                          [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                          [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                          [--environment-file <HEAT ENVIRONMENT FILE>]
                                          [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                          [--roles-file ROLES_FILE]
                                          [--networks-file NETWORKS_FILE]
                                          [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                          [--no-cleanup] [--update-plan-only]
                                          [--validation-errors-nonfatal]
                                          [--validation-warnings-fatal]
                                          [--disable-validations] [--dry-run]
                                          [--run-validations]
                                          [--skip-postconfig]
                                          [--force-postconfig]
                                          [--skip-deploy-identifier]
                                          [--rhel-reg]
                                          [--reg-method {satellite,portal}]
                                          [--reg-org REG_ORG] [--reg-force]
                                          [--reg-sat-url REG_SAT_URL]
                                          [--reg-activation-key REG_ACTIVATION_KEY]
                                          [--answers-file ANSWERS_FILE]
                                          [--disable-password-generation]
                                          [--deployed-server]
                                          [--config-download]
                                          [--output-dir OUTPUT_DIR]
                                          [--ceph-ansible-playbook CEPH_ANSIBLE_PLAYBOOK]

表46.71 その他の引数 (オプション):

概要

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。これは、P リリース後に削除されます。)

--ceph-storage-scale CEPH_STORAGE_SCALE

新しい ceph ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。これは、P リリース後に削除されます。)

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。これは、P リリース後に削除されます。)

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、および image サービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--disable-validations

デプロイメント前の検証を完全に無効にします。これらの検証は、組み込みのデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--control-scale CONTROL_SCALE

新しいコントロールノード数 (非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。これは、P リリース後に削除されます。)

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--output-dir OUTPUT_DIR

config-download を使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値 (/var/lib/mistral/<execution id>) が使用されます。

--block-storage-scale BLOCK_STORAGE_SCALE

新しい cinder ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。これは、P リリース後に削除されます。)

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。これは、P リリース後に削除されます。)

--swift-storage-scale SWIFT_STORAGE_SCALE

新しい swift ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。これは、P リリース後に削除されます。)

--config-download

config-download のメカニズムを使用してデプロイメントを実行する

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--ceph-ansible-playbook CEPH_ANSIBLE_PLAYBOOK

更新に使用する ceph-ansible Playbook を切り替えるパス。

--disable-password-generation

パスワードの生成を無効にします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記: 今後のリリースでは、別のコマンドに移行します。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--stack STACK

作成または更新するスタック名

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数 (非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。これは、P リリース後に削除されます。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。これは、P リリース後に削除されます。)

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。これは、P リリース後に削除されます。)

--dry-run

検証のみを実行しますが、変更は適用されません。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

表46.72 登録パラメーター

概要

--reg-method {satellite,portal}

オーバークラウドノードに使用する登録方法。

--reg-sat-url REG_SAT_URL

オーバークラウドノードを登録する Satellite サーバー

--reg-force

すでに登録済みでもシステムを登録します。

--reg-activation-key REG_ACTIVATION_KEY

登録に使用するアクティベーションキー

--rhel-reg

カスタマーポータルまたは Satellite 6 にオーバークラウドノードを登録します。

--reg-org REG_ORG

登録に使用する組織キー。

46.41. overcloud update run

オーバークラウドノードでマイナー更新 Ansible Playbook を実行します。

使用方法

openstack overcloud update run [-h] --nodes NODES [--playbook PLAYBOOK]
                                      [--ssh-user SSH_USER]
                                      [--static-inventory STATIC_INVENTORY]
                                      [--stack STACK]

表46.73 その他の引数 (オプション):

概要

--playbook PLAYBOOK

マイナー更新に使用する Ansible Playbook。デフォルトは特殊な値 all で、すべての更新 Playbook が実行されます。これは、update_steps_playbook.yaml、次に deploy_steps_playbook.yaml です。手動で実行したい場合は、このコマンドの連続した呼び出しで、これを各 Playbook に設定します。注記: すべてのサービスが更新され、ターゲットバージョンの設定で実行されるように、これらの Playbook の両方を必ず実行してください。

--ssh-user SSH_USER

オーバークラウドノードに接続するための ssh ユーザー名。

--stack STACK

Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME)

--static-inventory STATIC_INVENTORY

使用する既存の Ansible インベントリーへのパス。指定されていない場合は、~/tripleo-ansible- inventory.yaml に生成されます。

--nodes NODES

必須パラメーター。これにより、マイナー更新 Playbook を実行するオーバークラウドノードを指定します。特定のノードの名前、またはロール名を使用することができます(例:Compute)。すべてのノードでマイナーを実行する場合は、特殊な値 all を使用することもできます。いずれの場合も、マイナー更新 Ansible Playbook は一度に 1 つのノードで実行されます(シリアル 1 を使用)。

-h, --help

ヘルプメッセージを表示して終了します。

46.42. overcloud upgrade converge

メジャーアップグレードの収束: 保存したプランの Heat リソースをリセットします。これは、オーバークラウドのメジャーアップグレードを完了するための最後のステップです。主なタスクは、プランおよびスタックを更新して、将来のスタック更新のブロックを解除します。メジャーアップグレードのワークフローでは、一部のスタック Heat リソースに特定の値を設定しています。これにより、それらの設定をデフォルト値に戻します。

使用方法

openstack overcloud upgrade converge [--templates [TEMPLATES]]
                                            [--stack STACK]
                                            [--timeout <TIMEOUT>]
                                            [--control-scale CONTROL_SCALE]
                                            [--compute-scale COMPUTE_SCALE]
                                            [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                            [--block-storage-scale BLOCK_STORAGE_SCALE]
                                            [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                            [--control-flavor CONTROL_FLAVOR]
                                            [--compute-flavor COMPUTE_FLAVOR]
                                            [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                            [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                            [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                            [--libvirt-type {kvm,qemu}]
                                            [--ntp-server NTP_SERVER]
                                            [--no-proxy NO_PROXY]
                                            [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                            [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                            [--environment-file <HEAT ENVIRONMENT FILE>]
                                            [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                            [--roles-file ROLES_FILE]
                                            [--networks-file NETWORKS_FILE]
                                            [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                            [--no-cleanup]
                                            [--update-plan-only]
                                            [--validation-errors-nonfatal]
                                            [--validation-warnings-fatal]
                                            [--disable-validations]
                                            [--dry-run] [--run-validations]
                                            [--skip-postconfig]
                                            [--force-postconfig]
                                            [--skip-deploy-identifier]
                                            [--rhel-reg]
                                            [--reg-method {satellite,portal}]
                                            [--reg-org REG_ORG] [--reg-force]
                                            [--reg-sat-url REG_SAT_URL]
                                            [--reg-activation-key REG_ACTIVATION_KEY]
                                            [--answers-file ANSWERS_FILE]
                                            [--disable-password-generation]
                                            [--deployed-server]
                                            [--config-download]
                                            [--output-dir OUTPUT_DIR]

表46.74 その他の引数 (オプション):

概要

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。これは、P リリース後に削除されます。)

--ceph-storage-scale CEPH_STORAGE_SCALE

新しい ceph ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。これは、P リリース後に削除されます。)

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。これは、P リリース後に削除されます。)

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、および image サービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--disable-validations

デプロイメント前の検証を完全に無効にします。これらの検証は、組み込みのデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--control-scale CONTROL_SCALE

新しいコントロールノード数 (非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。これは、P リリース後に削除されます。)

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--output-dir OUTPUT_DIR

config-download を使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値 (/var/lib/mistral/<execution id>) が使用されます。

--block-storage-scale BLOCK_STORAGE_SCALE

新しい cinder ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。これは、P リリース後に削除されます。)

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。これは、P リリース後に削除されます。)

--swift-storage-scale SWIFT_STORAGE_SCALE

新しい swift ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。これは、P リリース後に削除されます。)

--config-download

config-download のメカニズムを使用してデプロイメントを実行する

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--disable-password-generation

パスワードの生成を無効にします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記: 今後のリリースでは、別のコマンドに移行します。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--stack STACK

作成または更新するスタック名

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数 (非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。これは、P リリース後に削除されます。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。これは、P リリース後に削除されます。)

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。これは、P リリース後に削除されます。)

--dry-run

検証のみを実行しますが、変更は適用されません。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

表46.75 登録パラメーター

概要

--reg-method {satellite,portal}

オーバークラウドノードに使用する登録方法。

--reg-sat-url REG_SAT_URL

オーバークラウドノードを登録する Satellite サーバー

--reg-force

すでに登録済みでもシステムを登録します。

--reg-activation-key REG_ACTIVATION_KEY

登録に使用するアクティベーションキー

--rhel-reg

カスタマーポータルまたは Satellite 6 にオーバークラウドノードを登録します。

--reg-org REG_ORG

登録に使用する組織キー。

46.43. overcloud upgrade prepare

オーバークラウドノードの heat スタックの更新を実行して、heat stack の出力を更新します。heat スタックの出力は、後でメジャーアップグレードのワークフローを提供する Ansible Playbook を生成するのに使用されます。これは、オーバークラウドのメジャーアップグレードの最初のステップとして使用されます。

使用方法

openstack overcloud upgrade prepare [--templates [TEMPLATES]]
                                           [--stack STACK]
                                           [--timeout <TIMEOUT>]
                                           [--control-scale CONTROL_SCALE]
                                           [--compute-scale COMPUTE_SCALE]
                                           [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                           [--block-storage-scale BLOCK_STORAGE_SCALE]
                                           [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                           [--control-flavor CONTROL_FLAVOR]
                                           [--compute-flavor COMPUTE_FLAVOR]
                                           [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                           [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                           [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                           [--libvirt-type {kvm,qemu}]
                                           [--ntp-server NTP_SERVER]
                                           [--no-proxy NO_PROXY]
                                           [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                           [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                           [--environment-file <HEAT ENVIRONMENT FILE>]
                                           [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                           [--roles-file ROLES_FILE]
                                           [--networks-file NETWORKS_FILE]
                                           [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                           [--no-cleanup] [--update-plan-only]
                                           [--validation-errors-nonfatal]
                                           [--validation-warnings-fatal]
                                           [--disable-validations] [--dry-run]
                                           [--run-validations]
                                           [--skip-postconfig]
                                           [--force-postconfig]
                                           [--skip-deploy-identifier]
                                           [--rhel-reg]
                                           [--reg-method {satellite,portal}]
                                           [--reg-org REG_ORG] [--reg-force]
                                           [--reg-sat-url REG_SAT_URL]
                                           [--reg-activation-key REG_ACTIVATION_KEY]
                                           [--answers-file ANSWERS_FILE]
                                           [--disable-password-generation]
                                           [--deployed-server]
                                           [--config-download]
                                           [--output-dir OUTPUT_DIR]
                                           [--ceph-ansible-playbook CEPH_ANSIBLE_PLAYBOOK]

表46.76 その他の引数 (オプション):

概要

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。これは、P リリース後に削除されます。)

--ceph-storage-scale CEPH_STORAGE_SCALE

新しい ceph ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。これは、P リリース後に削除されます。)

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。これは、P リリース後に削除されます。)

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、および image サービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--disable-validations

デプロイメント前の検証を完全に無効にします。これらの検証は、組み込みのデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--control-scale CONTROL_SCALE

新しいコントロールノード数 (非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。これは、P リリース後に削除されます。)

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--output-dir OUTPUT_DIR

config-download を使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値 (/var/lib/mistral/<execution id>) が使用されます。

--block-storage-scale BLOCK_STORAGE_SCALE

新しい cinder ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。これは、P リリース後に削除されます。)

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。これは、P リリース後に削除されます。)

--swift-storage-scale SWIFT_STORAGE_SCALE

新しい swift ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。これは、P リリース後に削除されます。)

--config-download

config-download のメカニズムを使用してデプロイメントを実行する

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--ceph-ansible-playbook CEPH_ANSIBLE_PLAYBOOK

アップグレードに使用する ceph-ansible Playbook を切り替えるパス。

--disable-password-generation

パスワードの生成を無効にします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記: 今後のリリースでは、別のコマンドに移行します。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--stack STACK

作成または更新するスタック名

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数 (非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。これは、P リリース後に削除されます。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。これは、P リリース後に削除されます。)

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。これは、P リリース後に削除されます。)

--dry-run

検証のみを実行しますが、変更は適用されません。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

表46.77 登録パラメーター

概要

--reg-method {satellite,portal}

オーバークラウドノードに使用する登録方法。

--reg-sat-url REG_SAT_URL

オーバークラウドノードを登録する Satellite サーバー

--reg-force

すでに登録済みでもシステムを登録します。

--reg-activation-key REG_ACTIVATION_KEY

登録に使用するアクティベーションキー

--rhel-reg

カスタマーポータルまたは Satellite 6 にオーバークラウドノードを登録します。

--reg-org REG_ORG

登録に使用する組織キー。

46.44. overcloud upgrade run

オーバークラウドノードでメジャーアップグレード Ansible Playbook を実行します。この Playbook は、オーバークラウドでメジャーアップグレード Ansible Playbook を実行します。デフォルトでは、すべての Playbook が実行されます。つまり、upgrade_steps_playbook.yaml、続いて deploy_steps_playbook.yaml、続いて post_upgrade_steps_playbook.yaml が実行されます。overcloud upgrade prepare コマンドの完了後に、アップグレード Playbook が利用可能になります。この overcloud upgrade run コマンドは、メジャーアップグレードのワークフローの 2 番目のステップです。

使用方法

openstack overcloud upgrade run [-h] (--nodes NODES | --roles ROLES)
                                       [--playbook PLAYBOOK]
                                       [--static-inventory STATIC_INVENTORY]
                                       [--ssh-user SSH_USER]
                                       [--skip-tags SKIP_TAGS] [--stack STACK]

表46.78 その他の引数 (オプション):

概要

--playbook PLAYBOOK

メジャーアップグレードに使用する Ansible Playbook。デフォルトは特殊な値 all で、すべてのアップグレード Playbook が実行されます。つまり、upgrade_steps_playbook.yaml、続いて deploy_steps_playbook.yaml、続いて post_upgrade_steps_playbook.yaml が実行されます。手動で実行したい場合は、このコマンドの連続した呼び出しで、これを各 Playbook に設定します。注記: すべてのサービスがアップグレードされ、ターゲットバージョンの設定で実行されるように、これらの Playbook のすべてを実行しなければならない場合があります。

--roles ROLES

このアップグレード実行呼び出しでアップグレードされるロールまたはコンマ区切りのロール一覧を識別する文字列。注記:指定されたロールのノードは並行してアップグレードされます。これは、コントロールプレーンのロールの場合 必須 です。コントロールプレーン以外のロール(コンピュートなど)の場合は、代わりに --nodes 引数を使用して、アップグレードを特定のノードまたはノードの一覧(コンマ区切りの文字列)に制限することを検討してください。

--stack STACK

Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME)

--static-inventory STATIC_INVENTORY

使用する既存の Ansible インベントリーへのパス。指定されていない場合は、~/tripleo-ansible- inventory.yaml に生成されます。

--nodes NODES

このアップグレード実行の呼び出しで並行してアップグレードされる単一ノードまたはコンマ区切りのノードリストを特定する文字列。例:--nodes "compute-0, compute-1, compute-5"注記:このパラメーターをコントロールプレーンロールのノード(例:-- nodes controller-1)で使用してもサポートされておらず、そのロールのすべてのノードをコンマ区切りの文字列として含まれない限り、WILL 終了は適切ではありません。代わりに、コントロールプレーンのロールに --roles パラメーターを使用し、ロール名を指定する必要があります。

-h, --help

ヘルプメッセージを表示して終了します。

--ssh-user SSH_USER

オーバークラウドノードに接続するための ssh ユーザー名。

--skip-tags SKIP_TAGS

ansible-playbook に --skip-tags として渡すタグまたはタグのコンマ区切りリストを指定する文字列。現在サポートされている値は validation および pre-upgrade です。特に、validationは、アップグレードに失敗した後に再実行する必要があり、一部のサービスが起動できない場合に有用です。

第47章 port

本章では、port コマンドに含まれるコマンドについて説明します。

47.1. port create

新規ポートの作成

使用方法

openstack port create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             --network <network> [--description <description>]
                             [--device <device-id>]
                             [--mac-address <mac-address>]
                             [--device-owner <device-owner>]
                             [--vnic-type <vnic-type>] [--host <host-id>]
                             [--dns-name dns-name]
                             [--fixed-ip subnet=<subnet>,ip-address=<ip-address> | --no-fixed-ip]
                             [--binding-profile <binding-profile>]
                             [--enable | --disable] [--project <project>]
                             [--project-domain <project-domain>]
                             [--security-group <security-group> | --no-security-group]
                             [--qos-policy <qos-policy>]
                             [--enable-port-security | --disable-port-security]
                             [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
                             [--tag <tag> | --no-tag]
                             <name>

表47.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表47.2 位置引数

概要

<name>

このポートの名前

表47.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表47.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表47.5 その他の引数 (オプション):

概要

--enable

ポートを有効にします (デフォルト)。

--no-security-group

このポートとはどのセキュリティーグループも関連付けません。

--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]

このポートに関連付けられる許可アドレスペアを追加します:ip-address=<ip-address>[,mac-address=<mac-address>](複数の許可アドレスペアを設定する場合はオプションを繰り返し使用します)

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

このポートに必要な ip やサブネット (名前または id): subnet=<subnet>,ip-address=<ip-address>(複数の Fixed IP アドレスを設定する場合はオプションを繰り返し使用します)

--disable-port-security

このポートのポートセキュリティーを無効にします。

--enable-port-security

このポートのポートセキュリティーを有効にします (デフォルト)。

--device-owner <device-owner>

このポートのデバイス所有者。これは、ポートを使用するエンティティーです (例:network:dhcp)。

--network <network>

このポートが属するネットワーク (名前または id)

--device <device-id>

ポートデバイス ID

--vnic-type <vnic-type>

このポートの vNIC 種別 (direct)

direct-physical

macvtap

normal

baremetal

virtio-forwarder, default: normal)

-h, --help

ヘルプメッセージを表示して終了します。

--disable

ポートを無効にします。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--mac-address <mac-address>

このポートの MAC アドレス (管理者のみ)

--no-tag

ポートにタグを関連付けません。

--binding-profile <binding-profile>

binding:profile として渡されるカスタムデータ。データは <key>=<value> または JSON として渡されることがあります (複数の binding:profile データを設定する場合はオプションを繰り返し使用します)。

--security-group <security-group>

このポートに関連付けるセキュリティーグループ (名前または ID)(複数のセキュリティーグループを設定する場合はオプションを繰り返し使用します)

--qos-policy <qos-policy>

このポートに qos ポリシーを割り当てます (名前または id)。

--project <project>

所有者のプロジェクト (名前または ID)

--tag <tag>

ポートに追加されるタグ (複数のタグを設定する場合はオプションを繰り返し使用します)

--description <description>

このポートの説明

--no-fixed-ip

このポートには ip または subnet を設定しません。

--host <host-id>

ホスト <host-id>でポートを割り当てます (id のみ)。

--dns-name dns-name

表47.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

47.2. port delete

ポートを削除します。

使用方法

openstack port delete [-h] <port> [<port> ...]

表47.7 位置引数

概要

<port>

削除するポート (名前または ID)

表47.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

47.3. port list

ポートの一覧を表示します。

使用方法

openstack port list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--sort-column SORT_COLUMN]
                           [--device-owner <device-owner>]
                           [--network <network>]
                           [--router <router> | --server <server> | --device-id <device-id>]
                           [--mac-address <mac-address>] [--long]
                           [--project <project>]
                           [--project-domain <project-domain>]
                           [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
                           [--tags <tag>[,<tag>,...]]
                           [--any-tags <tag>[,<tag>,...]]
                           [--not-tags <tag>[,<tag>,...]]
                           [--not-any-tags <tag>[,<tag>,...]]

表47.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表47.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表47.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表47.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表47.13 その他の引数 (オプション):

概要

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--mac-address <mac-address>

この mac アドレスを持つポートのみを一覧表示します。

--not-any-tags <tag>[,<tag>,…​]

指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたポートを除外します。

--router <router>

このルーターに割り当てられたポートのみを一覧表示します (名前または ID)。

--tags <tag>[,<tag>,…​]

指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたポートを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--project <project>

プロジェクトに従ってポートを一覧表示します (名前または ID)。

--any-tags <tag>[,<tag>,…​]

指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたポートを一覧表示します。

--device-owner <device-owner>

指定したデバイス所有者のポートのみを一覧表示します。これは、ポートを使用するエンティティーです (例:network:dhcp)。

--network <network>

このネットワークに接続されたポートのみを一覧表示します (名前または ID)。

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

このポートに必要な ip やサブネット (名前または id): subnet=<subnet>,ip-address=<ip-address>(複数の Fixed IP アドレスを設定する場合はオプションを繰り返し使用します)

--not-tags <tag>[,<tag>,…​]

指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたポートを除外します。

-h, --help

ヘルプメッセージを表示して終了します。

--device-id <device-id>

指定されたデバイス ID を持つポートのみを一覧表示します。

--server <server>

このサーバーに割り当てられているポートのみを一覧表示します (名前または ID)。

47.4. port set

ポートの属性を設定します。

使用方法

openstack port set [-h] [--description <description>]
                          [--device <device-id>] [--mac-address <mac-address>]
                          [--device-owner <device-owner>]
                          [--vnic-type <vnic-type>] [--host <host-id>]
                          [--dns-name dns-name] [--enable | --disable]
                          [--name <name>]
                          [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
                          [--no-fixed-ip]
                          [--binding-profile <binding-profile>]
                          [--no-binding-profile] [--qos-policy <qos-policy>]
                          [--security-group <security-group>]
                          [--no-security-group]
                          [--enable-port-security | --disable-port-security]
                          [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
                          [--no-allowed-address]
                          [--data-plane-status <status>] [--tag <tag>]
                          [--no-tag]
                          <port>

表47.14 位置引数

概要

<port>

変更するポート (名前または ID)

表47.15 その他の引数 (オプション):

概要

--enable

ポートを有効にします。

--no-security-group

このポートに関連付けられた既存のセキュリティーグループを消去します。

--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]

このポートに関連付けられる許可アドレスペアを追加します:ip-address=<ip-address>[,mac-address=<mac-address>](複数の許可アドレスペアを設定する場合はオプションを繰り返し使用します)

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

このポートに必要な ip やサブネット (名前または id): subnet=<subnet>,ip-address=<ip-address>(複数の Fixed IP アドレスを設定する場合はオプションを繰り返し使用します)

--disable-port-security

このポートのポートセキュリティーを無効にします。

--enable-port-security

このポートのポートセキュリティーを有効にします。

--name <name>

ポート名を設定します。

--no-binding-profile

binding:profile の既存情報を消去します。現在の binding:profile 情報を上書きするには、--binding-profile および --no-binding-profile の両方を指定します。

--device-owner <device-owner>

このポートのデバイス所有者。これは、ポートを使用するエンティティーです (例:network:dhcp)。

--device <device-id>

ポートデバイス ID

--qos-policy <qos-policy>

このポートに qos ポリシーを割り当てます (名前または id)。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

ポートを無効にします。

--data-plane-status <status>

このポートのデータプレーンステータスを設定します (active | down)。

Down.port unset コマンドを使ってこれを None に設定解除します (データプレーンのステータス拡張機能が必要)

--mac-address <mac-address>

このポートの MAC アドレス (管理者のみ)

--no-tag

ポートに関連付けられたタグを消去します。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。

--binding-profile <binding-profile>

binding:profile として渡されるカスタムデータ。データは <key>=<value> または JSON として渡されることがあります (複数の binding:profile データを設定する場合はオプションを繰り返し使用します)。

--security-group <security-group>

このポートに関連付けるセキュリティーグループ (名前または ID)(複数のセキュリティーグループを設定する場合はオプションを繰り返し使用します)

--vnic-type <vnic-type>

このポートの vNIC 種別 (direct)

direct-physical

macvtap

normal

baremetal

virtio-forwarder, default: normal)

--tag <tag>

ポートに追加されるタグ (複数のタグを設定する場合はオプションを繰り返し使用します)

--description <description>

このポートの説明

--no-fixed-ip

Fixed IP アドレスの既存の情報を消去します。現在の Fixed IP アドレスを上書きするには、--fixed-ip と --no-fixed-ip の両方を指定します。

--host <host-id>

ホスト <host-id>でポートを割り当てます (id のみ)。

--no-allowed-address

このポートに関連付けられている既存の許可アドレスペアを消去します(--allowed-address と --no- allowed-address の両方を指定して、現在の許可アドレスのペアを上書きします)。

--dns-name dns-name

このポートの dns 名を設定します (dns 統合拡張が必要です)。

47.5. port show

ポートの詳細を表示します。

使用方法

openstack port show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent] [--prefix PREFIX]
                           <port>

表47.16 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表47.17 位置引数

概要

<port>

表示するポート (名前または ID)

表47.18 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表47.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表47.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表47.21 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

47.6. port unset

ポート属性の設定を解除します。

使用方法

openstack port unset [-h]
                            [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
                            [--binding-profile <binding-profile-key>]
                            [--security-group <security-group>]
                            [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
                            [--qos-policy] [--data-plane-status]
                            [--tag <tag> | --all-tag]
                            <port>

表47.22 位置引数

概要

<port>

変更するポート (名前または ID)

表47.23 その他の引数 (オプション):

概要

--all-tag

ポートに関連付けられたすべてのタグを消去します。

--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]

このポートから削除する必要のある許可アドレスペア:ip-address=<ip-address>[,mac- address=<mac-address>](複数の許可アドレスペアの設定を解除する場合はオプションを繰り返し使用します)

--data-plane-status

データプレーンステータスの既存情報を消去します。

--qos-policy

ポートに割り当てられた qos ポリシーを削除します。

--security-group <security-group>

このポートから削除する必要のあるセキュリティーグループ (名前または ID)(複数のセキュリティーグループの設定を解除する場合はオプションを繰り返し使用します)

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

このポート (名前または id) から削除する必要のある ip やサブネット: subnet=<subnet>,ip- address=<ip-address>(複数の Fixed IP アドレスの設定を解除する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

--binding-profile <binding-profile-key>

binding:profile から削除される必要のあるキー (複数の binding:profile データの設定を解除する場合はオプションを繰り返し使用します)

--tag <tag>

ポートから削除するタグ (複数のタグを削除する場合はオプションを繰り返し使用します)

第48章 project

本章では、project コマンドに含まれるコマンドについて説明します。

48.1. project create

新規プロジェクトを作成します。

使用方法

openstack project create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                [--description <description>]
                                [--enable | --disable]
                                [--property <key=value>] [--or-show]
                                <project-name>

表48.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表48.2 位置引数

概要

<project-name>

新規プロジェクト名

表48.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表48.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表48.5 その他の引数 (オプション):

概要

--description <description>

プロジェクトの説明

--enable

プロジェクトを有効にします(デフォルト)。

--or-show

既存のプロジェクトを返します。

--property <key=value>

<name> に属性を追加します (複数の属性を設定する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

--disable

プロジェクトを無効にします。

表48.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

48.2. project delete

プロジェクトを削除します。

使用方法

openstack project delete [-h] <project> [<project> ...]

表48.7 位置引数

概要

<project>

削除するプロジェクト (名前または ID)

表48.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

48.3. project list

プロジェクトを一覧表示します。

使用方法

openstack project list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN] [--long]
                              [--sort <key>[:<direction>]]

表48.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表48.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表48.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表48.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表48.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--sort <key>[:<direction>]

選択した鍵と方向 (asc または desc) で出力をソートします (デフォルト:asc)。複数のキーと方向を指定する場合はこのオプションを繰り返し使用します。

--long

出力の追加フィールドを一覧表示します。

48.4. project purge

プロジェクトに関連付けられたリソースをクリーンアップします。

使用方法

openstack project purge [-h] [--dry-run] [--keep-project]
                               (--auth-project | --project <project>)
                               [--project-domain <project-domain>]

表48.14 その他の引数 (オプション):

概要

--auth-project

認証に使用するプロジェクトのリソースを削除します。

--project <project>

クリーンアップするプロジェクト (名前または ID)

--dry-run

プロジェクトのリソースを一覧表示します。

--keep-project

プロジェクトのリソースをクリーンアップしますが、プロジェクトは削除しません。

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

48.5. project set

プロジェクトの属性を設定します。

使用方法

openstack project set [-h] [--name <name>]
                             [--description <description>]
                             [--enable | --disable] [--property <key=value>]
                             <project>

表48.15 位置引数

概要

<project>

変更するプロジェクト (名前または ID)

表48.16 その他の引数 (オプション):

概要

--description <description>

プロジェクトの説明を設定します。

--enable

プロジェクトを有効にします。

--name <name>

プロジェクト名を設定します。

--property <key=value>

プロジェクト属性を設定します(複数の属性を設定する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

--disable

プロジェクトを無効にします。

48.6. project show

プロジェクトの詳細を表示します。

使用方法

openstack project show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX]
                              <project>

表48.17 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表48.18 位置引数

概要

<project>

表示するプロジェクト (名前または ID)

表48.19 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表48.20 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表48.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表48.22 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

48.7. project unset

プロジェクトの属性を設定します。

使用方法

openstack project unset [-h] [--property <key>] <project>

表48.23 位置引数

概要

<project>

変更するプロジェクト (名前または ID)

表48.24 その他の引数 (オプション):

概要

--property <key>

プロジェクトプロパティーの設定を解除します(複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

第49章 ptr

本章では、ptr コマンドに含まれるコマンドについて説明します。

49.1. ptr record list

floatingip ptr レコードを一覧表示します。

使用方法

openstack ptr record list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN] [--all-projects]
                                 [--edit-managed]
                                 [--sudo-project-id SUDO_PROJECT_ID]

表49.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表49.2 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表49.3 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表49.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.5 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

49.2. ptr record set

floatingip ptr レコードを設定します。

使用方法

openstack ptr record set [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                [--description DESCRIPTION | --no-description]
                                [--ttl TTL | --no-ttl] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                floatingip_id ptrdname

表49.6 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表49.7 位置引数

概要

floatingip_id

region:floatingip_id 形式の Floating IP id

ptrdname

Ptrd 名

表49.8 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.10 その他の引数 (オプション):

概要

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--no-ttl—​all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--no-description—​ttl TTL

Ttl

--description DESCRIPTION

説明

-h, --help

ヘルプメッセージを表示して終了します。

表49.11 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

49.3. ptr record show

floatingip ptr レコードの詳細を表示します。

使用方法

openstack ptr record show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX] [--all-projects]
                                 [--edit-managed]
                                 [--sudo-project-id SUDO_PROJECT_ID]
                                 floatingip_id

表49.12 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表49.13 位置引数

概要

floatingip_id

region:floatingip_id 形式の Floating IP id

表49.14 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.15 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.16 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表49.17 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

49.4. ptr record unset

floatingip ptr レコードの設定を解除します。

使用方法

openstack ptr record unset [-h] [--all-projects] [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  floatingip_id

表49.18 位置引数

概要

floatingip_id

region:floatingip_id 形式の Floating IP id

表49.19 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

第50章 quota

本章では、quota コマンドに含まれるコマンドについて説明します。

50.1. quota list

デフォルト以外のクォータ値を持つすべてのプロジェクトのクォータを一覧表示します。または、要求されるプロジェクトの詳細なクォータ情報を一覧表示します。

使用方法

openstack quota list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--sort-column SORT_COLUMN] [--project <project>]
                            [--detail] (--compute | --volume | --network)

表50.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表50.2 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表50.3 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表50.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表50.5 その他の引数 (オプション):

概要

--compute

コンピュートクォータを一覧表示します。

--project <project>

このプロジェクト <project>のクォータを一覧表示します (名前または id)。

--detail

クォータの使用状況についての詳細を表示します。

--volume

ボリュームクォータを一覧表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--network

ネットワーククォータを一覧表示します。

50.2. quota set

プロジェクトまたはクラスのクォータを設定します。

使用方法

openstack quota set [-h] [--class] [--properties <properties>]
                           [--server-groups <server-groups>] [--ram <ram>]
                           [--key-pairs <key-pairs>] [--instances <instances>]
                           [--fixed-ips <fixed-ips>]
                           [--injected-file-size <injected-file-size>]
                           [--server-group-members <server-group-members>]
                           [--injected-files <injected-files>]
                           [--cores <cores>]
                           [--injected-path-size <injected-path-size>]
                           [--per-volume-gigabytes <per-volume-gigabytes>]
                           [--gigabytes <gigabytes>]
                           [--backup-gigabytes <backup-gigabytes>]
                           [--snapshots <snapshots>] [--volumes <volumes>]
                           [--backups <backups>] [--l7policies <l7policies>]
                           [--subnetpools <subnetpools>] [--vips <vips>]
                           [--ports <ports>] [--subnets <subnets>]
                           [--networks <networks>]
                           [--floating-ips <floating-ips>]
                           [--secgroup-rules <secgroup-rules>]
                           [--health-monitors <health-monitors>]
                           [--secgroups <secgroups>] [--routers <routers>]
                           [--rbac-policies <rbac-policies>]
                           [--volume-type <volume-type>]
                           <project/class>

表50.6 位置引数

概要

<project/class>

このプロジェクトまたはクラスのクォータを設定します (名前/id)。

表50.7 その他の引数 (オプション):

概要

--server-groups <server-groups>

server-groups クォータの新しい値

--subnetpools <subnetpools>

subnetpools クォータの新しい値

--injected-path-size <injected-path-size>

injected-path-size クォータの新しい値

--rbac-policies <rbac-policies>

rbac-policies クォータの新しい値

--fixed-ips <fixed-ips>

fixed-ips クォータの新しい値

--per-volume-gigabytes <per-volume-gigabytes>

per-volume-gigabytes クォータの新しい値

--ports <ports>

ports クォータの新しい値

--volume-type <volume-type>

特定の <volume-type> のクォータを設定します。

--snapshots <snapshots>

snapshots クォータの新しい値

--subnets <subnets>

subnets クォータの新しい値

--networks <networks>

networks クォータの新しい値

--backups <backups>

backups クォータの新しい値

--backup-gigabytes <backup-gigabytes>

backup-gigabytes クォータの新しい値

--volumes <volumes>

volumes クォータの新しい値

-h, --help

ヘルプメッセージを表示して終了します。

--cores <cores>

cores クォータの新しい値

--key-pairs <key-pairs>

key-pairs クォータの新しい値

--l7policies <l7policies>

l7policies クォータの新しい値

--instances <instances>

instances クォータの新しい値

--injected-files <injected-files>

injected-files クォータの新しい値

--routers <routers>

routers クォータの新しい値

--properties <properties>

properties クォータの新しい値

--secgroup-rules <secgroup-rules>

secgroup-rules クォータの新しい値

--server-group-members <server-group-members>

server-group-members クォータの新しい値

--secgroups <secgroups>

secgroups クォータの新しい値

--ram <ram>

ram クォータの新しい値

--injected-file-size <injected-file-size>

injected-file-size クォータの新しい値

--vips <vips>

vips クォータの新しい値

--health-monitors <health-monitors>

health-monitors クォータの新しい値

--gigabytes <gigabytes>

gigabytes クォータの新しい値

--class

<class> のクォータを設定します。

--floating-ips <floating-ips>

floating-ips クォータの新しい値

50.3. quota show

プロジェクトまたはクラスのクォータを表示します。

使用方法

openstack quota show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent] [--prefix PREFIX]
                            [--class | --default]
                            [<project/class>]

表50.8 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表50.9 位置引数

概要

<project/class>

このプロジェクトまたはクラスのクォータを表示します (名前または id)。

表50.10 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表50.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表50.12 その他の引数 (オプション):

概要

--default

<project> のデフォルトクォータを表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--class

<class> のクォータを表示します。

表50.13 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第51章 recordset

本章では、recordset コマンドに含まれるコマンドについて説明します。

51.1. recordset create

新規レコードセットを作成します

使用方法

openstack recordset create [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX] --record RECORD --type
                                  TYPE [--ttl TTL] [--description DESCRIPTION]
                                  [--all-projects] [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_id name

表51.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表51.2 位置引数

概要

zone_id

ゾーンの id

name

レコードセット名

表51.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.5 その他の引数 (オプション):

概要

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--ttl TTL

存続期間 (秒)

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--record RECORD

レコードセットレコード (必要な場合は繰り返します)

--type TYPE

レコードセットの種別

--description DESCRIPTION

説明

-h, --help

ヘルプメッセージを表示して終了します。

表51.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

51.2. recordset delete

レコードセットを削除します。

使用方法

openstack recordset delete [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_id id

表51.7 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表51.8 位置引数

概要

zone_id

ゾーンの id

id

レコードセットの id

表51.9 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.10 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.11 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表51.12 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

51.3. recordset list

レコードセットを一覧表示します。

使用方法

openstack recordset list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--sort-column SORT_COLUMN] [--name NAME]
                                [--type TYPE] [--data DATA] [--ttl TTL]
                                [--description DESCRIPTION] [--status STATUS]
                                [--action ACTION] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                zone_id

表51.13 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表51.14 位置引数

概要

zone_id

ゾーンの id。(全レコードセットを一覧表示するには、all を指定します)

表51.15 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表51.16 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表51.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.18 その他の引数 (オプション):

概要

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--data DATA

レコードセットレコードデータ

--ttl TTL

存続期間 (秒)

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--name NAME

レコードセット名

--type TYPE

レコードセットの種別

--description DESCRIPTION

説明

--status STATUS

レコードセットステータス

-h, --help

ヘルプメッセージを表示して終了します。

--action ACTION

レコードセットアクション

51.4. recordset set

レコードセットの属性を設定します。

使用方法

openstack recordset set [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]
                               [--records RECORDS [RECORDS ...]]
                               [--description DESCRIPTION | --no-description]
                               [--ttl TTL | --no-ttl] [--all-projects]
                               [--edit-managed]
                               [--sudo-project-id SUDO_PROJECT_ID]
                               zone_id id

表51.19 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表51.20 位置引数

概要

zone_id

ゾーンの id

id

レコードセットの id

表51.21 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.22 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.23 その他の引数 (オプション):

概要

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--no-ttl—​all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--no-description—​ttl TTL

Ttl

--records RECORDS [RECORDS …​]

Records

--description DESCRIPTION

説明

-h, --help

ヘルプメッセージを表示して終了します。

表51.24 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

51.5. recordset show

レコードセットの詳細を表示します。

使用方法

openstack recordset show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                zone_id id

表51.25 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表51.26 位置引数

概要

zone_id

ゾーンの id

id

レコードセットの id

表51.27 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.28 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.29 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表51.30 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第52章 resource

本章では、resource コマンドに含まれるコマンドについて説明します。

52.1. resource member create

別のテナントとリソースを共有します。

使用方法

openstack resource member create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        resource_id resource_type member_id

表52.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表52.2 位置引数

概要

member_id

リソースを共有するプロジェクト ID。

resource_type

リソースタイプ。

resource_id

共有されるリソース ID。

表52.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表52.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

52.2. resource member delete

リソース共有の関係を削除します。

使用方法

openstack resource member delete [-h] resource resource_type member_id

表52.7 位置引数

概要

resource

共有されるリソース ID。

resource_type

リソースタイプ。

member_id

リソースを共有するプロジェクト ID。

表52.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

52.3. resource member list

すべてのメンバーを一覧表示します。

使用方法

openstack resource member list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      resource_id resource_type

表52.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表52.10 位置引数

概要

resource_type

リソースタイプ。

resource_id

共有されるリソース ID。

表52.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表52.12 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表52.13 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

52.4. resource member show

特定のメンバーの情報を表示します。

使用方法

openstack resource member show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [-m MEMBER_ID]
                                      resource resource_type

表52.15 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表52.16 位置引数

概要

resource

共有されるリソース ID。

resource_type

リソースタイプ。

表52.17 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.18 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-m MEMBER_ID, --member-id MEMBER_ID

リソースを共有するプロジェクト ID。リソースメンバーの場合には、このパラメーターを指定する必要はありません。

表52.20 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

52.5. resource member update

リソース共有のステータスを更新します。

使用方法

openstack resource member update [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [-m MEMBER_ID]
                                        [-s {pending,accepted,rejected}]
                                        resource_id resource_type

表52.21 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表52.22 位置引数

概要

resource_type

リソースタイプ。

resource_id

共有されるリソース ID。

表52.23 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.24 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.25 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-m MEMBER_ID, --member-id MEMBER_ID

リソースを共有するプロジェクト ID。リソースメンバーの場合には、このパラメーターを指定する必要はありません。

-s {pending,accepted,rejected}, --status {pending,accepted,rejected}

共有のステータス。

表52.26 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第53章 role

本章では、role コマンドに含まれるコマンドについて説明します。

53.1. role add

ロールを project:user に追加します。

使用方法

openstack role add [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                          [--max-width <integer>] [--fit-width]
                          [--print-empty] [--noindent] [--prefix PREFIX]
                          --project <project> --user <user>
                          <role>

表53.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表53.2 位置引数

概要

<role>

<project>:<user> に追加するロール(名前または ID)

表53.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表53.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表53.5 その他の引数 (オプション):

概要

--user <user>

<user>を含めます (名前または ID)。

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

<project>を含めます (名前または ID)。

表53.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

53.2. role assignment list

ロールの割り当てを一覧表示します。

使用方法

openstack role assignment list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--user <user>] [--project <project>]
                                      [--names] [--auth-user] [--auth-project]

表53.7 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表53.8 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表53.9 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表53.10 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表53.11 その他の引数 (オプション):

概要

--auth-project

認証されたユーザーのトークンがスコープ設定されているプロジェクトの割り当てのみを一覧表示します。

--user <user>

フィルターするユーザー (名前または ID)

--auth-user

認証済みユーザーの割り当てのみを一覧表示します。

--names

id ではなく名前を表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

フィルターするプロジェクト (名前または ID)

53.3. role create

新規ロールを作成します。

使用方法

openstack role create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             [--or-show]
                             <name>

表53.12 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表53.13 位置引数

概要

<name>

新しいロール名

表53.14 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表53.15 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表53.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--or-show

既存のロールを返します。

表53.17 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

53.4. role delete

ロールを削除します。

使用方法

openstack role delete [-h] <role> [<role> ...]

表53.18 位置引数

概要

<role>

削除するロール (名前または ID)

表53.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

53.5. role list

ロールを一覧表示します。

使用方法

openstack role list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--sort-column SORT_COLUMN] [--project <project>]
                           [--user <user>]

表53.20 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表53.21 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表53.22 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表53.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表53.24 その他の引数 (オプション):

概要

--user <user>

<user>でロールをフィルターします(名前または ID)。

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

<project>でロールをフィルターします(名前または ID)。

53.6. role remove

プロジェクト : user からロールを削除します。

使用方法

openstack role remove [-h] --project <project> --user <user> <role>

表53.25 位置引数

概要

<role>

削除するロール (名前または ID)

表53.26 その他の引数 (オプション):

概要

--user <user>

<user>を含めます (名前または ID)。

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

<project>を含めます (名前または ID)。

53.7. role show

ロールの詳細を表示します。

使用方法

openstack role show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent] [--prefix PREFIX]
                           <role>

表53.27 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表53.28 位置引数

概要

<role>

表示するロール (名前または ID)

表53.29 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表53.30 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表53.31 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表53.32 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第54章 ルーター

本章では、router コマンドに含まれるコマンドについて説明します。

54.1. router add port

ルーターにポートを追加します。

使用方法

openstack router add port [-h] <router> <port>

表54.1 位置引数

概要

<port>

追加するポート (名前または ID)

<router>

ポートが追加されるルーター (名前または ID)

表54.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.2. router add subnet

ルーターにサブネットを追加します。

使用方法

openstack router add subnet [-h] <router> <subnet>

表54.3 位置引数

概要

<subnet>

追加するサブネット (名前または ID)

<router>

サブネットを追加するルーター (名前または ID)

表54.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.3. router create

新規ルーターを作成します。

使用方法

openstack router create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] [--enable | --disable]
                               [--distributed | --centralized]
                               [--ha | --no-ha] [--description <description>]
                               [--project <project>]
                               [--project-domain <project-domain>]
                               [--availability-zone-hint <availability-zone>]
                               [--tag <tag> | --no-tag]
                               <name>

表54.5 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表54.6 位置引数

概要

<name>

新しいルーター名

表54.7 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.8 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.9 その他の引数 (オプション):

概要

--availability-zone-hint <availability-zone>

このルーターを作成するアベイラビリティーゾーン (Router Availability Zone 拡張機能が必要、複数のアベイラビリティーゾーンに設定するにはオプションを繰り返します)

--description <description>

ルーターの説明を設定します。

--distributed

分散ルーターを作成します。

--ha

高可用性ルーターを作成します。

--no-tag

ルーターにタグを関連付けません。

--enable

ルーターを有効にします (デフォルト)。

--centralized

集中ルーターを作成します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--no-ha

レガシーのルーターを作成します。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

ルーターを無効にします。

--project <project>

所有者のプロジェクト (名前または ID)

--tag <tag>

ルーターに追加するタグ (複数のタグを設定する場合はオプションを繰り返し使用します)

表54.10 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

54.4. router delete

ルーターを削除します。

使用方法

openstack router delete [-h] <router> [<router> ...]

表54.11 位置引数

概要

<router>

削除するルーター (名前または ID)

表54.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.5. router list

ルーターを一覧表示します。

使用方法

openstack router list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--name <name>]
                             [--enable | --disable] [--long]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--agent <agent-id>] [--tags <tag>[,<tag>,...]]
                             [--any-tags <tag>[,<tag>,...]]
                             [--not-tags <tag>[,<tag>,...]]
                             [--not-any-tags <tag>[,<tag>,...]]

表54.13 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表54.14 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.15 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.17 その他の引数 (オプション):

概要

--agent <agent-id>

エージェントがホストする ルーターを一覧表示します (ID のみ)

--enable

有効なルーターを一覧表示します。

--not-any-tags <tag>[,<tag>,…​]

指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたルーターを除外します。

--name <name>

名前に従ってルーターを一覧表示します。

--tags <tag>[,<tag>,…​]

指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたルーターを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--any-tags <tag>[,<tag>,…​]

指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたルーターを一覧表示します。

--not-tags <tag>[,<tag>,…​]

指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたルーターを除外します。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

無効なルーターを一覧表示します。

--project <project>

プロジェクトに従ってルーターを一覧表示します (名前または ID)。

54.6. router remove port

ルーターからポートを削除します。

使用方法

openstack router remove port [-h] <router> <port>

表54.18 位置引数

概要

<port>

削除および削除されるポート (名前または ID)

<router>

ポートを削除するルーター (名前または ID)

表54.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.7. router remove subnet

ルーターからサブネットを削除します。

使用方法

openstack router remove subnet [-h] <router> <subnet>

表54.20 位置引数

概要

<subnet>

削除するサブネット (名前または ID)

<router>

サブネットが削除されるルーター (名前または ID)

表54.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.8. router set

ルーターの属性を設定します。

使用方法

openstack router set [-h] [--name <name>] [--description <description>]
                            [--enable | --disable]
                            [--distributed | --centralized]
                            [--route destination=<subnet>,gateway=<ip-address>]
                            [--no-route] [--ha | --no-ha]
                            [--external-gateway <network>]
                            [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
                            [--enable-snat | --disable-snat] [--tag <tag>]
                            [--no-tag]
                            <router>

表54.22 位置引数

概要

<router>

変更するルーター (名前または ID)

表54.23 その他の引数 (オプション):

概要

--description <description>

ルーターの説明を設定します。

--distributed

ルーターを分散モードに設定します (無効なルーターのみ)。

--route destination=<subnet>,gateway=<ip-address>

ルーターの宛先に関連付けられたルート: 宛先サブネット (CIDR 表記) ゲートウェイ:nexthop IP アドレス (複数のルートを設定する場合はオプションを繰り返し使用します)

--no-ha

ルーターの高可用性属性を消去します (無効ルーターのみ)。

--enable

ルーターを有効にします。

--no-tag

ルーターに関連付けられたタグを消去します。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。

--name <name>

ルーター名を設定します。

--ha

ルーターを高可用性として設定します (無効なルーターのみ)。

--tag <tag>

ルーターに追加するタグ (複数のタグを設定する場合はオプションを繰り返し使用します)

--centralized

ルーターを集中モードに設定します (無効なルーターのみ)。

--disable-snat

外部ゲートウェイでソース nat を無効にします。

--external-gateway <network>

ルーターのゲートウェイとして使用する外部ネットワーク (名前または ID)

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

外部ゲートウェイの必要な ip やサブネット (名前または id): subnet=<subnet>,ip-address=<ip-address>(複数の Fixed IP アドレスを設定する場合はオプションを繰り返し使用します)

--no-route

ルーターに関連付けられたルートを消去します。ルートの現在の値を上書きするには、--route と --no-route の両方を指定します。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

ルーターを無効にします。

--enable-snat

外部ゲートウェイでソース nat を有効にします。

54.9. router show

ルーターの詳細を表示します。

使用方法

openstack router show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             <router>

表54.24 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表54.25 位置引数

概要

<router>

表示するルーター (名前または ID)

表54.26 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.27 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.29 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

54.10. router unset

ルーター属性の設定を解除します。

使用方法

openstack router unset [-h]
                              [--route destination=<subnet>,gateway=<ip-address>]
                              [--external-gateway] [--tag <tag> | --all-tag]
                              <router>

表54.30 位置引数

概要

<router>

変更するルーター (名前または ID)

表54.31 その他の引数 (オプション):

概要

--external-gateway

ルーターから外部ゲートウェイ情報を削除します。

--all-tag

ルーターに関連付けられたすべてのタグを消去します。

-h, --help

ヘルプメッセージを表示して終了します。

--route destination=<subnet>,gateway=<ip-address>

ルーターの宛先から削除されるルート: 宛先サブネット (CIDR 表記) ゲートウェイ:nexthop IP アドレス (複数ルートの設定を解除する場合はオプションを繰り返し使用します)

--tag <tag>

ルーターから削除するタグ (複数のタグを削除する場合はオプションを繰り返し使用します)

第55章 secret

本章では、secret コマンドに含まれるコマンドについて説明します。

55.1. secret container create

Barbican にコンテナーを保存します。

使用方法

openstack secret container create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         [--name NAME] [--type TYPE]
                                         [--secret SECRET]

表55.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表55.2 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表55.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表55.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--secret SECRET, -s SECRET

コンテナーに保存する 1 つのシークレット (複数回設定できます)。例:--secret "private_key=https://url.test/v1/secrets/1-2-3-4"

--name NAME, -n NAME

人間に分かりやすい名前。

--type TYPE

作成するコンテナーの種別 (デフォルト:generic)。

表55.5 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

55.2. secret container delete

href を指定してコンテナーを削除します。

使用方法

openstack secret container delete [-h] URI

表55.6 位置引数

概要

URI

コンテナーの uri 参照

表55.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

55.3. secret container get

URI を指定してコンテナーを取得します。

使用方法

openstack secret container get [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      URI

表55.8 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表55.9 位置引数

概要

URI

コンテナーの uri 参照。

表55.10 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表55.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表55.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表55.13 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

55.4. secret container list

コンテナーを一覧表示します。

使用方法

openstack secret container list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN]
                                       [--limit LIMIT] [--offset OFFSET]
                                       [--name NAME] [--type TYPE]

表55.14 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表55.15 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表55.16 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表55.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表55.18 その他の引数 (オプション):

概要

--type TYPE、-t TYPE

リストのタイプフィルターを指定します (デフォルト:none)。

-h, --help

ヘルプメッセージを表示して終了します。

--limit LIMIT, -l LIMIT

ページごとに表示する項目数に制限を指定します (デフォルト:10、最大: 100)。

--name NAME, -n NAME

コンテナー名を指定します (デフォルト:none)。

--offset OFFSET, -o OFFSET

ページのオフセットを指定します (デフォルト:0)。

55.5. secret delete

URI を指定してシークレットを削除します。

使用方法

openstack secret delete [-h] URI

表55.19 位置引数

概要

URI

シークレットの uri 参照

表55.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

55.6. secret get

URI を指定してシークレットを取得します。

使用方法

openstack secret get [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent] [--prefix PREFIX]
                            [--decrypt] [--payload]
                            [--payload_content_type PAYLOAD_CONTENT_TYPE]
                            URI

表55.21 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表55.22 位置引数

概要

URI

シークレットの uri 参照。

表55.23 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表55.24 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表55.25 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--payload, -p

指定されている場合は、暗号化されていないシークレットデータを取得します。データタイプは --payload_content_type で指定できます。ユーザーがペイロードの値のみを取得する場合は、ペイロードの値のみを返すために "-f value" を追加する必要があります。

--payload_content_type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

復号化されたシークレットのコンテンツ種別 (デフォルト:text/plain)。

--decrypt, -d

指定されている場合は、暗号化されていないシークレットデータを取得します。データタイプは --payload_content_type で指定できます。

表55.26 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

55.7. secret list

シークレットを一覧表示します。

使用方法

openstack secret list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--limit LIMIT]
                             [--offset OFFSET] [--name NAME]
                             [--algorithm ALGORITHM] [--bit-length BIT_LENGTH]
                             [--mode MODE] [--secret-type SECRET_TYPE]

表55.27 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表55.28 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表55.29 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表55.30 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表55.31 その他の引数 (オプション):

概要

--secret-type SECRET_TYPE, -s SECRET_TYPE

シークレットの種別を指定します (デフォルト: none)。

--name NAME, -n NAME

シークレット名を指定します (デフォルト: none)

--limit LIMIT, -l LIMIT

ページごとに表示する項目数に制限を指定します (デフォルト:10、最大: 100)。

--bit-length BIT_LENGTH, -b BIT_LENGTH

リストのビット長フィルター (デフォルト:0)。

--algorithm ALGORITHM、-a ALGORITHM

リストのアルゴリズムフィルター (デフォルト: none)

-h, --help

ヘルプメッセージを表示して終了します。

--mode MODE、-m MODE

リストのアルゴリズムモードフィルター (デフォルト:None)。

--offset OFFSET, -o OFFSET

ページのオフセットを指定します (デフォルト:0)。

55.8. secret order create

新しい順序を作成します。

使用方法

openstack secret order create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--name NAME] [--algorithm ALGORITHM]
                                     [--bit-length BIT_LENGTH] [--mode MODE]
                                     [--payload-content-type PAYLOAD_CONTENT_TYPE]
                                     [--expiration EXPIRATION]
                                     [--request-type REQUEST_TYPE]
                                     [--subject-dn SUBJECT_DN]
                                     [--source-container-ref SOURCE_CONTAINER_REF]
                                     [--ca-id CA_ID] [--profile PROFILE]
                                     [--request-file REQUEST_FILE]
                                     type

表55.32 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表55.33 位置引数

概要

type

作成する順序の種別 (鍵、非対称、証明書)。

表55.34 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表55.35 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表55.36 その他の引数 (オプション):

概要

--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

生成されるシークレットの種別/形式 (デフォルト:application/octet-stream)。

--expiration EXPIRATION、-x EXPIRATION

iso 8601 形式のシークレットの有効期限

--request-file REQUEST_FILE

csr が含まれるファイル。

--subject-dn SUBJECT_DN

証明書のサブジェクト。

--request-type REQUEST_TYPE

証明書要求の種別。

--name NAME, -n NAME

人間に分かりやすい名前。

--bit-length BIT_LENGTH, -b BIT_LENGTH

要求されるシークレットキーのビット長 (デフォルト:256)。

--source-container-ref SOURCE_CONTAINER_REF

stored-key 要求を使用する際の証明書のソース。

--algorithm ALGORITHM、-a ALGORITHM

要求されたキーで使用されるアルゴリズム (デフォルト:aes)

-h, --help

ヘルプメッセージを表示して終了します。

--mode MODE、-m MODE

要求されたキーで使用されるアルゴリズムモード (デフォルト:cbc)

--profile PROFILE

使用する証明書のプロファイル。

--ca-id CA_ID

証明書要求に使用する ca の識別子。

表55.37 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

55.9. secret order delete

href を指定して順序を削除します。

使用方法

openstack secret order delete [-h] URI

表55.38 位置引数

概要

URI

順序の URI 参照

表55.39 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

55.10. secret order get

URI を指定して順序を取得します。

使用方法

openstack secret order get [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  URI

表55.40 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表55.41 位置引数

概要

URI

uri 参照の順序。

表55.42 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表55.43 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表55.44 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表55.45 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

55.11. secret order list

順序を一覧表示します。

使用方法

openstack secret order list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN] [--limit LIMIT]
                                   [--offset OFFSET]

表55.46 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表55.47 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表55.48 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表55.49 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表55.50 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit LIMIT, -l LIMIT

ページごとに表示する項目数に制限を指定します (デフォルト:10、最大: 100)。

--offset OFFSET, -o OFFSET

ページのオフセットを指定します (デフォルト:0)。

55.12. secret store

Barbican にシークレットを保存します。

使用方法

openstack secret store [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [--name NAME]
                              [--payload PAYLOAD] [--secret-type SECRET_TYPE]
                              [--payload-content-type PAYLOAD_CONTENT_TYPE]
                              [--payload-content-encoding PAYLOAD_CONTENT_ENCODING]
                              [--algorithm ALGORITHM]
                              [--bit-length BIT_LENGTH] [--mode MODE]
                              [--expiration EXPIRATION]

表55.51 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表55.52 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表55.53 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表55.54 その他の引数 (オプション):

概要

--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

提供されたシークレットデータの種別/フォーマット。"text/plain" は UTF-8 であると想定されます。--payload が指定されている場合は必須です。

--expiration EXPIRATION、-x EXPIRATION

iso 8601 形式のシークレットの有効期限

--secret-type SECRET_TYPE, -s SECRET_TYPE

シークレットの種別。symmetric、public、private、certificate、passphrase、opaque (デフォルト) のいずれかでなければなりません。

--payload-content-encoding PAYLOAD_CONTENT_ENCODING, -e PAYLOAD_CONTENT_ENCODING

--payload-content-type が "application/octet-stream" の場合は必須です。

--name NAME, -n NAME

人間に分かりやすい名前。

--bit-length BIT_LENGTH, -b BIT_LENGTH

ビットの長さ (デフォルト:256)。

--algorithm ALGORITHM、-a ALGORITHM

アルゴリズム (デフォルト:aes)

-h, --help

ヘルプメッセージを表示して終了します。

--mode MODE、-m MODE

アルゴリズムモード。参照用にのみ使用されます (デフォルト:cbc)

--payload PAYLOAD、-p PAYLOAD

暗号化されていないシークレット。提供されている場合は、payload_content_type も指定する必要があります。

表55.55 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

55.13. secret update

Barbican のペイロードなしでシークレットを更新します。

使用方法

openstack secret update [-h] URI payload

表55.56 位置引数

概要

URI

シークレットの uri 参照。

payload

暗号化されていないシークレット

表55.57 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

第56章 security

本章では、security コマンドに含まれるコマンドについて説明します。

56.1. security group create

新しいセキュリティーグループを作成します。

使用方法

openstack security group create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--description <description>]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       <name>

表56.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表56.2 位置引数

概要

<name>

新しいセキュリティーグループ名

表56.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表56.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表56.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

セキュリティーグループの説明

--project <project>

所有者のプロジェクト (名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表56.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

56.2. security group delete

セキュリティーグループを削除します。

使用方法

openstack security group delete [-h] <group> [<group> ...]

表56.7 位置引数

概要

<group>

削除するセキュリティーグループ (名前または ID)

表56.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

56.3. security group list

セキュリティーグループを一覧表示します。

使用方法

openstack security group list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--project <project>]
                                     [--project-domain <project-domain>]

表56.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表56.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表56.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表56.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表56.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

プロジェクトに従ってセキュリティーグループを一覧表示します (名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

56.4. security group rule create

新しいセキュリティーグループルールを作成します。

使用方法

openstack security group rule create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            [--remote-ip <ip-address> | --remote-group <group>]
                                            [--description <description>]
                                            [--dst-port <port-range>]
                                            [--icmp-type <icmp-type>]
                                            [--icmp-code <icmp-code>]
                                            [--protocol <protocol>]
                                            [--ingress | --egress]
                                            [--ethertype <ethertype>]
                                            [--project <project>]
                                            [--project-domain <project-domain>]
                                            <group>

表56.14 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表56.15 位置引数

概要

<group>

このセキュリティーグループにルールを作成します (名前または ID)。

表56.16 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表56.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表56.18 その他の引数 (オプション):

概要

--remote-ip <ip-address>

リモート IP アドレスブロック(cidr 表記を使用することができます。IPv4 ルールのデフォルト:0.0.0.0/0)

--remote-group <group>

リモートセキュリティーグループ (名前または ID)

--icmp-type <icmp-type>

icmp ip プロトコルの ICMP 種別

--icmp-code <icmp-code>

icmp ip プロトコルの ICMP コード

--ethertype <ethertype>

ネットワークトラフィックの ethertype(ipv4、ipv6。デフォルト: IP プロトコルに基づく)

--ingress

受信ネットワークトラフィックに適用されるルール (デフォルト)

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--protocol <protocol>

IP プロトコル (ah、dccp、egp、esp、gre、icmp、igmp、ipv6-encap、ipv6-frag、ipv6-icmp、ipv6-nonxt、ipv6-opts、ipv6-route、ospf、pgm、rsvp、sctp、tcp、udp、udplite、vrrp、および integer 表現 [0-255] または any。デフォルト: any (すべてのプロトコル))

--dst-port <port-range>

宛先ポート。単一ポートまたはポート範囲の始点および終点を指定できます: 137:139IP プロトコル TCP および UDP に必須です。ICMP IP プロトコルでは無視されます。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

セキュリティーグループルールの説明を設定します。

--project <project>

所有者のプロジェクト (名前または ID)

--egress

送信ネットワークトラフィックに適用されるルール

表56.19 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

56.5. security group rule delete

セキュリティーグループルールを削除します。

使用方法

openstack security group rule delete [-h] <rule> [<rule> ...]

表56.20 位置引数

概要

<rule>

削除するセキュリティーグループルール (id のみ)

表56.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

56.6. security group rule list

セキュリティーグループルールを一覧表示します。

使用方法

openstack security group rule list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN]
                                          [--protocol <protocol>]
                                          [--ingress | --egress] [--long]
                                          [<group>]

表56.22 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表56.23 位置引数

概要

<group>

このセキュリティーグループのすべてのルールを一覧表示します (名前または ID)。

表56.24 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表56.25 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表56.26 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表56.27 その他の引数 (オプション):

概要

--protocol <protocol>

ip プロトコル(ah、dhcp、egp、esp、gre、icmp、igmp、ipv6-encap、ipv6-frag、ipv6-icmp、ipv6-nonxt、ipv6-opts、ipv6-route、ospf、pgm、rsvp、sctp、tcp、udp、udplite、vrrp、および整数表現 [0-255])でルールを一覧表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--ingress

受信ネットワークトラフィックに適用されるルールを一覧表示します。

--egress

発信ネットワークトラフィックに適用されるルールを一覧表示します。

56.7. security group rule show

セキュリティーグループルールの詳細を表示します。

使用方法

openstack security group rule show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          <rule>

表56.28 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表56.29 位置引数

概要

<rule>

表示するセキュリティーグループルール (id のみ)

表56.30 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表56.31 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表56.32 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表56.33 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

56.8. security group set

セキュリティーグループの属性を設定します。

使用方法

openstack security group set [-h] [--name <new-name>]
                                    [--description <description>]
                                    <group>

表56.34 位置引数

概要

<group>

変更するセキュリティーグループ (名前または ID)

表56.35 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

新しいセキュリティーグループの説明

--name <new-name>

新しいセキュリティーグループ名

56.9. security group show

セキュリティーグループの詳細を表示します。

使用方法

openstack security group show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <group>

表56.36 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表56.37 位置引数

概要

<group>

表示するセキュリティーグループ (名前または ID)

表56.38 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表56.39 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表56.40 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表56.41 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第57章 server

本章では、server コマンドに含まれるコマンドについて説明します。

57.1. server add fixed ip

Fixed IP アドレスをサーバーに追加します。

使用方法

openstack server add fixed ip [-h] [--fixed-ip-address <ip-address>]
                                     <server> <network>

表57.1 位置引数

概要

<server>

Fixed IP アドレスを受信するサーバー (名前または ID)

<network>

Fixed IP アドレスの割り当て元となるネットワーク (名前または ID)

表57.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fixed-ip-address <ip-address>

要求された Fixed IP アドレス

57.2. server add floating ip

サーバーに Floating IP アドレスを追加します。

使用方法

openstack server add floating ip [-h] [--fixed-ip-address <ip-address>]
                                        <server> <ip-address>

表57.3 位置引数

概要

<server>

Floating IP アドレスを受信するサーバー (名前または ID)

<ip-address>

最初に利用可能なサーバーポートに割り当てる Floating IP アドレス (IP のみ)

表57.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fixed-ip-address <ip-address>

この Floating IP アドレスに関連付ける Fixed IP アドレスFixed IP アドレスが含まれる最初のサーバーポートが使用されます。

57.3. server add network

サーバーにネットワークを追加します。

使用方法

openstack server add network [-h] <server> <network>

表57.5 位置引数

概要

<server>

ネットワークを追加するサーバー (名前または ID)

<network>

サーバーに追加するネットワーク (名前または ID)

表57.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.4. server add port

サーバーにポートを追加します。

使用方法

openstack server add port [-h] <server> <port>

表57.7 位置引数

概要

<server>

ポートを追加するサーバー (名前または ID)

<port>

サーバーに追加するポート (名前または ID)

表57.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.5. server add security group

セキュリティーグループをサーバーに追加します。

使用方法

openstack server add security group [-h] <server> <group>

表57.9 位置引数

概要

<server>

サーバー (名前または ID)

<group>

追加するセキュリティーグループ (名前または ID)

表57.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.6. server add volume

サーバーにボリュームを追加します。

使用方法

openstack server add volume [-h] [--device <device>] <server> <volume>

表57.11 位置引数

概要

<volume>

追加するボリューム (名前または ID)

<server>

サーバー (名前または ID)

表57.12 その他の引数 (オプション):

概要

--device <device>

ボリュームのサーバーの内部デバイス名

-h, --help

ヘルプメッセージを表示して終了します。

57.7. server backup create

サーバーのバックアップイメージを作成します。

使用方法

openstack server backup create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--name <image-name>]
                                      [--type <backup-type>]
                                      [--rotate <count>] [--wait]
                                      <server>

表57.13 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表57.14 位置引数

概要

<server>

バックアップを作成するサーバー (名前または ID)

表57.15 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表57.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.17 その他の引数 (オプション):

概要

--type <backup-type>

バックアップイメージの backup_type 属性の設定に使用 (デフォルト: 空欄)

-h, --help

ヘルプメッセージを表示して終了します。

--wait

バックアップイメージの作成が完了するのを待ちます。

--rotate <count>

保持するバックアップ数 (デフォルト:1)

--name <image-name>

バックアップイメージの名前 (デフォルト: サーバー名)

表57.18 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

57.8. server create

新しいサーバーを作成します。

使用方法

openstack server create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]
                               (--image <image> | --volume <volume>) --flavor
                               <flavor> [--security-group <security-group>]
                               [--key-name <key-name>]
                               [--property <key=value>]
                               [--file <dest-filename=source-filename>]
                               [--user-data <user-data>]
                               [--availability-zone <zone-name>]
                               [--block-device-mapping <dev-name=mapping>]
                               [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none>]
                               [--network <network>] [--port <port>]
                               [--hint <key=value>]
                               [--config-drive <config-drive-volume>|True]
                               [--min <count>] [--max <count>] [--wait]
                               <server-name>

表57.19 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表57.20 位置引数

概要

<server-name>

新しいサーバー名

表57.21 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表57.22 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.23 その他の引数 (オプション):

概要

--port <port>

サーバーに nic を作成し、ポートに接続します。複数の NIC を作成するには、オプションを複数回指定します。これは、新しいサーバーを特定のポートに接続する標準ユースケースの簡単な構文を提供する--nic port-id=<port> パラメーターのラッパーです。高度なユースケースは、--nic パラメーターを参照してください。

--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none>

サーバーに nic を作成します。複数の NIC を作成するには、オプションを複数回指定します。net-id または port- id のどちらかを指定する必要がありますが、両方を指定することはできません。net-id: NIC をこの UUID が割り当てられたネットワークにアタッチします。port-id: NIC をこの UUID が割り当てられたポートにアタッチします。v4-fixed-ip: NIC 用 IPv4 固定アドレス (オプション)。v6-fixed-ip: NIC 用 IPv6 固定アドレス (オプション)。none: (v2.37 以上) ネットワークをアタッチしません。auto: (v2.37 以上) Compute サービスがネットワークを自動的に割り当てます。--nic に auto または none を指定すると、他の --nic の値とは併用できません。

--availability-zone <zone-name>

サーバーのアベイラビリティーゾーンを選択します。

--hint <key=value>

スケジューラーのヒント (オプションの機能拡張)

--wait

ビルドが完了するまで待ちます。

--max <count>

起動するサーバーの最大数 (デフォルトは 1)

--volume <volume>

このボリュームをブートディスクとして使用してサーバーを作成します (名前または ID)。このオプションは、ブートインデックス 0 でブロックデバイスマッピングを自動的に作成します。多くのハイパーバイザー (libvirt/kvm など) で、これはデバイス vda になります。--block-device- mapping を使用して、このデバイスに重複したマッピングを作成しないでください。

--config-drive <config-drive-volume>

True

指定されたボリュームをコンフィグドライブとして使用するか、true で一時ドライブを使用します。

--property <key=value>

このサーバーに属性を設定します (複数の値を設定する場合はオプションを繰り返し使用します)。

--file <dest-filename=source-filename>

ブート前にイメージに挿入するファイル (複数のファイルを設定する場合はオプションを繰り返し使用します)

--network <network>

サーバーに nic を作成し、ネットワークに接続します。複数の NIC を作成するには、オプションを複数回指定します。これは、新しいサーバーを特定のネットワークに接続する標準ユースケースの簡単な構文を提供する--nic net-id=<network> パラメーターのラッパーです。高度なユースケースは、-- nic パラメーターを参照してください。

--block-device-mapping <dev-name=mapping>

サーバーにブロックデバイスを作成します。<dev-name>=<id>:<type>:<size (GB)>:<delete-on- terminate> 形式のブロックデバイスマッピング。<dev-name>: vdb、xvdc (必須)<id>: ボリュームまたはスナップショットの UUID (必須)、<type>: ボリュームまたはスナップショット。デフォルト:volume (オプション)<size (GB)>: スナップショットから作成する場合はボリュームサイズ(オプション)<delete-on-terminate>: true または false。デフォルト:false (オプション)(オプション)(オプション)(オプション)

--security-group <security-group>

このサーバーに割り当てるセキュリティーグループ (名前または ID)(複数のグループを設定する場合はオプションを繰り返し使用します)

--min <count>

起動するサーバーの最小数 (デフォルトは 1)

--key-name <key-name>

このサーバーに挿入するキーペア (任意の拡張)

-h, --help

ヘルプメッセージを表示して終了します。

--user-data <user-data>

メタデータサーバーから提供されるユーザーデータファイル

--flavor <flavor>

このフレーバーを使用してサーバーを作成します (名前または ID)。

--image <image>

表57.24 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

57.9. server delete

サーバーを削除します。

使用方法

openstack server delete [-h] [--wait] <server> [<server> ...]

表57.25 位置引数

概要

<server>

削除するサーバー (名前または ID)

表57.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait

削除が完了するのを待ちます。

57.10. server dump create

ダンプファイルをサーバー内に作成します。Linux の kdump などの機能を使用して、サーバーでクラッシュダンプをトリガーします。サーバーのメモリーをダンプするサーバーにダンプファイルを作成し、さらにサーバーをクラッシュします。OSC は、リソースの 1 つとしてダンプファイル (サーバーダンプ) を確認します。

使用方法

openstack server dump create [-h] <server> [<server> ...]

表57.27 位置引数

概要

<server>

ダンプファイルを作成するサーバー (名前または ID)

表57.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.11. server event list

サーバーの最近のイベントを一覧表示します。

使用方法

openstack server event list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN] [--long]
                                   <server>

表57.29 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表57.30 位置引数

概要

<server>

イベントを一覧表示するサーバー (名前または ID)

表57.31 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表57.32 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表57.33 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.34 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

57.12. server event show

サーバーイベントの詳細を表示します。

使用方法

openstack server event show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   <server> <request-id>

表57.35 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表57.36 位置引数

概要

<server>

イベントの詳細を表示するサーバー (名前または ID)

<request-id>

表示するイベントの要求 ID(id のみ)

表57.37 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表57.38 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.39 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表57.40 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

57.13. server group create

新しいサーバーグループを作成します。

使用方法

openstack server group create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--policy <policy>]
                                     <name>

表57.41 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表57.42 位置引数

概要

<name>

新しいサーバーグループ名

表57.43 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表57.44 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.45 その他の引数 (オプション):

概要

--policy <policy>

<name> にポリシーを追加します (affinity または anti-affinity、デフォルトは affinity)。soft-affinity または soft-anti-affinity ポリシーの場合、--os-compute-api- version 2.15 以降を指定します。

-h, --help

ヘルプメッセージを表示して終了します。

表57.46 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

57.14. server group delete

既存のサーバーグループを削除します。

使用方法

openstack server group delete [-h] <server-group> [<server-group> ...]

表57.47 位置引数

概要

<server-group>

削除するサーバーグループ (名前または ID)

表57.48 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.15. server group list

すべてのサーバーグループを一覧表示します。

使用方法

openstack server group list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN]
                                   [--all-projects] [--long]

表57.49 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表57.50 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表57.51 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表57.52 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.53 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの情報を表示します (管理者のみ)。

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

57.16. server group show

サーバーグループの詳細を表示します。

使用方法

openstack server group show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   <server-group>

表57.54 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表57.55 位置引数

概要

<server-group>

表示するサーバーグループ (名前または ID)

表57.56 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表57.57 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.58 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表57.59 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

57.17. server image create

既存のサーバーから新規サーバーディスクイメージを作成します。

使用方法

openstack server image create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--name <image-name>] [--wait]
                                     <server>

表57.60 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表57.61 位置引数

概要

<server>

イメージを作成するサーバー (名前または ID)

表57.62 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表57.63 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.64 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait

動作が完了するまで待ちます。

--name <image-name>

新しいディスクイメージの名前 (デフォルト: サーバー名)

表57.65 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

57.18. server list

サーバーを一覧表示します。

使用方法

openstack server list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN]
                             [--reservation-id <reservation-id>]
                             [--ip <ip-address-regex>]
                             [--ip6 <ip-address-regex>] [--name <name-regex>]
                             [--instance-name <server-name>]
                             [--status <status>] [--flavor <flavor>]
                             [--image <image>] [--host <hostname>]
                             [--all-projects] [--project <project>]
                             [--project-domain <project-domain>]
                             [--user <user>] [--user-domain <user-domain>]
                             [--long] [-n] [--marker <server>]
                             [--limit <num-servers>] [--deleted]
                             [--changes-since <changes-since>]

表57.66 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表57.67 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表57.68 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表57.69 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.70 その他の引数 (オプション):

概要

--image <image>

イメージで検索します (名前または ID)。

--marker <server>

前のページにある最後のサーバー。マーカーの後にサーバーの一覧を表示します。指定されていない場合は、すべてのサーバーを表示します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--limit <num-servers>

表示するサーバーの最大数。制限が -1 の場合、すべてのサーバーが表示されます。上限が Nova API の osapi_max_limit オプションよりも大きい場合には、代わりに osapi_max_limit が使用されます。

--all-projects

すべてのプロジェクトを含めます (管理者のみ)。

--user <user>

ユーザーで検索します (管理者のみ)(名前または ID)

-n, --no-name-lookup

フレーバーおよびイメージ名の検索を省略します。

--changes-since <changes-since>

特定の時点より後に変更されたサーバーのみを一覧表示します。指定する時間は ISO 8061 形式の時刻 (例:2016-03-04T06:27:59Z) である必要があります。

--ip <ip-address-regex>

IP アドレスに一致する正規表現

--reservation-id <reservation-id>

予約に一致するインスタンスのみを返します。

--long

出力の追加フィールドを一覧表示します。

--project <project>

プロジェクトで検索します (管理者のみ)(名前または ID)

--status <status>

サーバーステータスで検索します。

--host <hostname>

ホスト名で検索します。

--deleted

削除されたサーバーのみを表示します (管理者のみ)。

--name <name-regex>

名前に一致する正規表現

--user-domain <user-domain>

ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

-h, --help

ヘルプメッセージを表示して終了します。

--ip6 <ip-address-regex>

ipv6 アドレスに一致する正規表現

--flavor <flavor>

フレーバーで検索します (名前または ID)。

--instance-name <server-name>

インスタンス名に一致する正規表現 (管理者のみ)

57.19. server lock

サーバーをロックします。管理者以外のユーザーはアクションを実行できなくなります。

使用方法

openstack server lock [-h] <server> [<server> ...]

表57.71 位置引数

概要

<server>

ロックするサーバー (名前または ID)

表57.72 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.20. server migrate

サーバーを異なるホストに移行します。

使用方法

openstack server migrate [-h] [--live <hostname>]
                                [--shared-migration | --block-migration]
                                [--disk-overcommit | --no-disk-overcommit]
                                [--wait]
                                <server>

表57.73 位置引数

概要

<server>

サーバー (名前または ID)

表57.74 その他の引数 (オプション):

概要

--wait

移行が完了するまで待ちます。

--disk-overcommit

移行先ホストでディスクのオーバーコミットを許可します。

--block-migration

ブロックライブマイグレーションを実行します。

--no-disk-overcommit

移行先ホストでディスクのオーバーコミットを行いません (デフォルト)。

-h, --help

ヘルプメッセージを表示して終了します。

--shared-migration

共有ライブマイグレーションを実行します (デフォルト)。

--live <hostname>

ターゲットホスト名

57.21. server pause

サーバーを一時停止します。

使用方法

openstack server pause [-h] <server> [<server> ...]

表57.75 位置引数

概要

<server>

一時停止するサーバー (名前または ID)

表57.76 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.22. server reboot

サーバーのハードまたはソフトリブートを実行します。

使用方法

openstack server reboot [-h] [--hard | --soft] [--wait] <server>

表57.77 位置引数

概要

<server>

サーバー (名前または ID)

表57.78 その他の引数 (オプション):

概要

--soft

ソフトリブートを実行します。

-h, --help

ヘルプメッセージを表示して終了します。

--hard

ハードリブートを実行します。

--wait

リブートが完了するまで待ちます。

57.23. server rebuild

サーバーを再ビルドします。

使用方法

openstack server rebuild [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX] [--image <image>]
                                [--password <password>] [--wait]
                                <server>

表57.79 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表57.80 位置引数

概要

<server>

サーバー (名前または ID)

表57.81 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表57.82 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.83 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait

再ビルドが完了するまで待ちます。

--image <image>

指定されたイメージからサーバーを再作成します (名前または ID)。デフォルトは現在使用中のイメージです。

--password <password>

再ビルドしたインスタンスのパスワードを設定します。

表57.84 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

57.24. server remove fixed ip

サーバーから Fixed IP アドレスを削除します。

使用方法

openstack server remove fixed ip [-h] <server> <ip-address>

表57.85 位置引数

概要

<server>

Fixed IP アドレスを削除するサーバー (名前または ID)

<ip-address>

サーバーから削除する Fixed IP アドレス (ip のみ)

表57.86 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.25. server remove floating ip

サーバーから Floating IP アドレスを削除します。

使用方法

openstack server remove floating ip [-h] <server> <ip-address>

表57.87 位置引数

概要

<server>

Floating IP アドレスを削除するサーバー (名前または ID)

<ip-address>

サーバーから削除する Floating IP アドレス (ip のみ)

表57.88 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.26. server remove network

サーバーからネットワークのポートをすべて削除します。

使用方法

openstack server remove network [-h] <server> <network>

表57.89 位置引数

概要

<server>

ポートを削除するサーバー (名前または ID)

<network>

サーバーから削除するネットワーク (名前または ID)

表57.90 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.27. server remove port

サーバーからポートを削除します。

使用方法

openstack server remove port [-h] <server> <port>

表57.91 位置引数

概要

<server>

ポートを削除するサーバー (名前または ID)

<port>

サーバーから削除するポート (名前または ID)

表57.92 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.28. server remove security group

サーバーからセキュリティーグループを削除します。

使用方法

openstack server remove security group [-h] <server> <group>

表57.93 位置引数

概要

<server>

使用するサーバーの名前または ID

<group>

サーバーから削除するセキュリティーグループの名前または ID

表57.94 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.29. server remove volume

サーバーからボリュームを削除します。

使用方法

openstack server remove volume [-h] <server> <volume>

表57.95 位置引数

概要

<volume>

削除するボリューム (名前または ID)

<server>

サーバー (名前または ID)

表57.96 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.30. server rescue

サーバーをレスキューモードに切り替えます。

使用方法

openstack server rescue [-h] [--image <image>] [--password <password>]
                               <server>

表57.97 位置引数

概要

<server>

サーバー (名前または ID)

表57.98 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--image <image>

レスキューモードに使用するイメージ (名前または ID)。デフォルトは現在使用中のイメージです。

--password <password>

レスキューインスタンスのパスワードを設定します。

57.31. server resize

サーバーを新規フレーバーにスケーリングします。サイズ変更操作は、新しいサーバーを作成して、元のディスクの内容を新しいディスクにコピーして実行されます。また、ユーザーにとっても 2 つのステップのプロセスです。1 つ目はサイズ変更の実行で、2 つ目は、成功を確認 (検証) して古いサーバーを解放するか、やり直しを宣言して新しいサーバーを解放して古いサーバーを再起動するかのどちらかです。

使用方法

openstack server resize [-h] [--flavor <flavor> | --confirm | --revert]
                               [--wait]
                               <server>

表57.99 位置引数

概要

<server>

サーバー (名前または ID)

表57.100 その他の引数 (オプション):

概要

--revert

サーバーの状態をサイズ変更前に復元します。

-h, --help

ヘルプメッセージを表示して終了します。

--confirm

サーバーのサイズ変更が完了したことを確認します。

--flavor <flavor>

サーバーを指定したフレーバーにサイズ変更します。

--wait

サイズ変更が完了するまで待ちます。

57.32. server restore

サーバーを復元します。

使用方法

openstack server restore [-h] <server> [<server> ...]

表57.101 位置引数

概要

<server>

復元するサーバー (名前または ID)

表57.102 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.33. server resume

サーバーを再開します。

使用方法

openstack server resume [-h] <server> [<server> ...]

表57.103 位置引数

概要

<server>

再開するサーバー (名前または ID)

表57.104 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.34. server set

サーバー属性を設定します。

使用方法

openstack server set [-h] [--name <new-name>] [--root-password]
                            [--property <key=value>] [--state <state>]
                            <server>

表57.105 位置引数

概要

<server>

サーバー (名前または ID)

表57.106 その他の引数 (オプション):

概要

--state <state>

新しいサーバーの状態 (有効な値:active、error)

-h, --help

ヘルプメッセージを表示して終了します。

--name <new-name>

新しいサーバー名

--property <key=value>

このサーバーに追加/変更する属性 (複数の属性を設定する場合はオプションを繰り返し使用します)

--root-password

新しい root パスワードを設定します (対話式のみ)。

57.35. server shelve

サーバーを退避します。

使用方法

openstack server shelve [-h] <server> [<server> ...]

表57.107 位置引数

概要

<server>

退避するサーバー (名前または ID)

表57.108 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.36. server show

サーバーの詳細を表示します。

使用方法

openstack server show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             [--diagnostics]
                             <server>

表57.109 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表57.110 位置引数

概要

<server>

サーバー (名前または ID)

表57.111 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表57.112 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.113 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--diagnostics

サーバーの診断情報を表示します。

表57.114 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

57.37. server ssh

サーバーに SSH 接続を行います。

使用方法

openstack server ssh [-h] [--login <login-name>] [--port <port>]
                            [--identity <keyfile>] [--option <config-options>]
                            [-4 | -6]
                            [--public | --private | --address-type <address-type>]
                            <server>

表57.115 位置引数

概要

<server>

サーバー (名前または ID)

表57.116 その他の引数 (オプション):

概要

--login <login-name>

ログイン名 (ssh -l オプション)

-6

ipv6 アドレスのみを使用します。

--public

パブリック IP アドレスを使用します。

--private

プライベート IP アドレスを使用します。

--address-type <address-type>

他の IP アドレス (パブリック、プライベートなど) を使用します。

-4

ipv4 アドレスのみを使用します。

--identity <keyfile>

秘密鍵ファイル (ssh -i オプション)

--port <port>

宛先ポート (ssh -p オプション)

--option <config-options>

ssh_config(5) 形式のオプション (ssh -o オプション)

-h, --help

ヘルプメッセージを表示して終了します。

57.38. server start

サーバーを起動します。

使用方法

openstack server start [-h] <server> [<server> ...]

表57.117 位置引数

概要

<server>

起動するサーバー (名前または ID)

表57.118 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.39. server stop

サーバーを停止します。

使用方法

openstack server stop [-h] <server> [<server> ...]

表57.119 位置引数

概要

<server>

停止するサーバー (名前または ID)

表57.120 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.40. server suspend

サーバーを一時停止します。

使用方法

openstack server suspend [-h] <server> [<server> ...]

表57.121 位置引数

概要

<server>

一時停止するサーバー (名前または ID)

表57.122 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.41. server unlock

サーバーのロックを解除します。

使用方法

openstack server unlock [-h] <server> [<server> ...]

表57.123 位置引数

概要

<server>

ロックを解除するサーバー (名前または ID)

表57.124 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.42. server unpause

サーバーの一時停止を解除します。

使用方法

openstack server unpause [-h] <server> [<server> ...]

表57.125 位置引数

概要

<server>

一時停止を解除するサーバー (名前または ID)

表57.126 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.43. server unrescue

レスキューモードからサーバーを復元します。

使用方法

openstack server unrescue [-h] <server>

表57.127 位置引数

概要

<server>

サーバー (名前または ID)

表57.128 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.44. server unset

サーバー属性の設定を解除します。

使用方法

openstack server unset [-h] [--property <key>] <server>

表57.129 位置引数

概要

<server>

サーバー (名前または ID)

表57.130 その他の引数 (オプション):

概要

--property <key>

サーバーから削除する属性キー (複数の値を削除する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

57.45. server unshelve

サーバーの退避を解除します

使用方法

openstack server unshelve [-h] <server> [<server> ...]

表57.131 位置引数

概要

<server>

退避を解除するサーバー (名前または ID)

表57.132 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

第58章 サービス

本章では、service コマンドに含まれるコマンドについて説明します。

58.1. service create

新規サービスを作成します。

使用方法

openstack service create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX] [--name <name>]
                                [--description <description>]
                                <type>

表58.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表58.2 位置引数

概要

<type>

新しいサービスの種別 (compute、image、identity、volume など)

表58.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表58.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表58.5 その他の引数 (オプション):

概要

--name <name>

新しいサービス名

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

新しいサービスの説明

表58.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

58.2. service delete

サービスを削除します。

使用方法

openstack service delete [-h] <service> [<service> ...]

表58.7 位置引数

概要

<service>

削除するサービス (タイプ、名前、または ID)

表58.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

58.3. service list

サービスを一覧表示します。

使用方法

openstack service list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN] [--long]

表58.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表58.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表58.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表58.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表58.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

58.4. service show

サービスの詳細を表示します。

使用方法

openstack service show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [--catalog]
                              <service>

表58.14 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表58.15 位置引数

概要

<service>

表示するサービス (タイプ、名前、または ID)

表58.16 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表58.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表58.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--catalog

サービスカタログ情報を表示します。

表58.19 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第59章 sfc

本章では、sfc コマンドに含まれるコマンドについて説明します。

59.1. sfc flow classifier create

フロー分類子を作成します。

使用方法

openstack sfc flow classifier create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            [--description <description>]
                                            [--protocol <protocol>]
                                            [--ethertype {IPv4,IPv6}]
                                            [--source-port <min-port>:<max-port>]
                                            [--destination-port <min-port>:<max-port>]
                                            [--source-ip-prefix <source-ip-prefix>]
                                            [--destination-ip-prefix <destination-ip-prefix>]
                                            [--logical-source-port <logical-source-port>]
                                            [--logical-destination-port <logical-destination-port>]
                                            [--l7-parameters L7_PARAMETERS]
                                            <name>

表59.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.2 位置引数

概要

<name>

フロー分類子の名前

表59.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表59.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.5 その他の引数 (オプション):

概要

--source-ip-prefix <source-ip-prefix>

cidr 表記のソース IP アドレス

--destination-port <min-port>:<max-port>

宛先プロトコルポート (指定できる範囲 [1,65535])。a:b の形で指定する必要があります。ここで、a は最小ポート、b は最大ポートです。

--logical-destination-port <logical-destination-port>

Neutron の宛先ポート (名前または ID)

--source-port <min-port>:<max-port>

許容範囲でのソースプロトコルポート (指定できる範囲 [1,65535]。a:b の形で指定する必要があります。ここで、a は最小ポート、b は最大ポートです)

--logical-source-port <logical-source-port>

neutron ソースポート (名前または ID)

--protocol <protocol>

IP プロトコル名。プロトコル名は、iana 標準に従って指定する必要があります。

--l7-parameters L7_PARAMETERS

l7 パラメーターのディクショナリー。現在、このオプションではいずれの値もサポートされません。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

フロー分類の説明

--destination-ip-prefix <destination-ip-prefix>

cidr 表記の宛先 IP アドレス

--ethertype {IPv4,IPv6}

L2 ethertype。デフォルトは ipv4 です。

表59.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

59.2. sfc flow classifier delete

指定のフロー分類子を削除します。

使用方法

openstack sfc flow classifier delete [-h] <flow-classifier>

表59.7 位置引数

概要

<flow-classifier>

削除するフロー分類子 (名前または ID)

表59.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

59.3. sfc flow classifier list

フロー分類子を一覧表示します。

使用方法

openstack sfc flow classifier list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN] [--long]

表59.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表59.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表59.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

59.4. sfc flow classifier set

フロー分類子の属性を設定します。

使用方法

openstack sfc flow classifier set [-h] [--name <name>]
                                         [--description <description>]
                                         <flow-classifier>

表59.14 位置引数

概要

<flow-classifier>

変更するフロー分類子 (名前または ID)

表59.15 その他の引数 (オプション):

概要

--name <name>

フロー分類子の名前

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

フロー分類の説明

59.5. sfc flow classifier show

フロー分類子の詳細を表示します。

使用方法

openstack sfc flow classifier show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          <flow-classifier>

表59.16 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.17 位置引数

概要

<flow-classifier>

表示するフロー分類子 (名前または ID)

表59.18 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表59.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表59.21 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

59.6. sfc port chain create

ポートチェーンを作成します。

使用方法

openstack sfc port chain create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--description <description>]
                                       [--flow-classifier <flow-classifier>]
                                       [--chain-parameters correlation=<correlation-type>,symmetric=<boolean>]
                                       --port-pair-group <port-pair-group>
                                       <name>

表59.22 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.23 位置引数

概要

<name>

ポートチェーンの名前

表59.24 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表59.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.26 その他の引数 (オプション):

概要

--chain-parameters correlation=<correlation-type>,symmetric=<boolean>

チェーンパラメーターのディクショナリー。correlation=(mpls)をサポートします。

nsh)(デフォルトは mpls)および symmetric=(true)

False

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ポートチェーンの説明

--port-pair-group <port-pair-group>

ポートペアのグループを追加します (名前または ID)。このオプションを繰り返すことができます。

--flow-classifier <flow-classifier>

フロー分類子を追加します (名前または id)。このオプションを繰り返すことができます。

表59.27 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

59.7. sfc port chain delete

特定のポートチェーンを削除します。

使用方法

openstack sfc port chain delete [-h] <port-chain>

表59.28 位置引数

概要

<port-chain>

削除するポートチェーン (名前または ID)

表59.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

59.8. sfc port chain list

ポートチェーンの一覧を表示します。

使用方法

openstack sfc port chain list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN] [--long]

表59.30 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.31 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表59.32 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表59.33 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.34 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

59.9. sfc port chain set

ポートチェーンの属性を設定します。

使用方法

openstack sfc port chain set [-h] [--name <name>]
                                    [--description <description>]
                                    [--flow-classifier <flow-classifier>]
                                    [--no-flow-classifier]
                                    [--port-pair-group <port-pair-group>]
                                    [--no-port-pair-group]
                                    <port-chain>

表59.35 位置引数

概要

<port-chain>

変更するポートチェーン (名前または ID)

表59.36 その他の引数 (オプション):

概要

--no-flow-classifier

ポートチェーンから関連するフロー分類子を削除します。

--name <name>

ポートチェーンの名前

--flow-classifier <flow-classifier>

フロー分類子を追加します (名前または id)。このオプションを繰り返すことができます。

--no-port-pair-group

ポートチェーンから関連付けられたポートペアグループを削除します。少なくとも 1 つの --port-pair-group を共に指定する必要があります。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ポートチェーンの説明

--port-pair-group <port-pair-group>

ポートペアのグループを追加します (名前または ID)。現在のポートペアグループの順番が保持され、追加されたポートペアグループはポートチェーンの最後に配置されます。このオプションを繰り返すことができます。

59.10. sfc port chain show

ポートチェーンの詳細を表示します。

使用方法

openstack sfc port chain show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <port-chain>

表59.37 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.38 位置引数

概要

<port-chain>

表示するポートチェーン (名前または ID)

表59.39 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表59.40 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.41 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表59.42 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

59.11. sfc port chain unset

ポートチェーン属性の設定を解除します。

使用方法

openstack sfc port chain unset [-h]
                                      [--flow-classifier <flow-classifier> | --all-flow-classifier]
                                      [--port-pair-group <port-pair-group>]
                                      <port-chain>

表59.43 位置引数

概要

<port-chain>

設定を解除するポートチェーン (名前または ID)

表59.44 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-flow-classifier

ポートチェーンからすべてのフロー分類子を削除します。

--port-pair-group <port-pair-group>

ポートチェーンからポートペアグループを削除します (名前または ID)。このオプションを繰り返すことができます。

--flow-classifier <flow-classifier>

ポートチェーンからフロー分類子を削除します (名前または ID)。このオプションを繰り返すことができます。

59.12. sfc port pair create

ポートペアを作成します。

使用方法

openstack sfc port pair create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--description <description>]
                                      [--service-function-parameters correlation=<correlation-type>,weight=<weight>]
                                      --ingress <ingress> --egress <egress>
                                      <name>

表59.45 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.46 位置引数

概要

<name>

ポートペアの名前

表59.47 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表59.48 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.49 その他の引数 (オプション):

概要

--ingress <ingress>

受信 neutron ポート (名前または ID)

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ポートペアの説明

--service-function-parameters correlation=<correlation-type>,weight=<weight>

サービス関数パラメーターのディクショナリー。現在 correlation=(None

mpls

nsh) および重みがサポートされます。重みは、フローのポートペアグループ内のポートペアの選択に影響を与える整数です。重みが高いほど、より多くのフローがポートペアにハッシュします。デフォルトの重みは 1 です。

--egress <egress>

送信 neutron ポート (名前または ID)

表59.50 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

59.13. sfc port pair delete

指定のポートペアを削除します。

使用方法

openstack sfc port pair delete [-h] <port-pair>

表59.51 位置引数

概要

<port-pair>

削除するポートペア (名前または ID)

表59.52 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

59.14. sfc port pair group create

ポートペアグループを作成します。

使用方法

openstack sfc port pair group create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            [--description <description>]
                                            [--port-pair <port-pair>]
                                            [--enable-tap | --disable-tap]
                                            [--port-pair-group-parameters lb-fields=<lb-fields>]
                                            <name>

表59.53 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.54 位置引数

概要

<name>

ポートペアグループの名前

表59.55 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表59.56 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.57 その他の引数 (オプション):

概要

--enable-tap

このポートペアグループのポートペアがパッシブタップサービス関数としてデプロイされます。

--port-pair <port-pair>

ポートのペア (名前または ID)。このオプションを繰り返すことができます。

--disable-tap

このポートペアグループのポートペアが l3 サービス関数としてデプロイされます (デフォルト)。

--port-pair-group-parameters lb-fields=<lb-fields>

ポートペアグループパラメーターのディクショナリー。現在、1 つのパラメーター lb-fields のみがサポートされます。<lb-fields> は負荷分散フィールドの & 区切りリストです。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ポートペアグループの説明

表59.58 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

59.15. sfc port pair group delete

指定されたポートペアグループを削除します。

使用方法

openstack sfc port pair group delete [-h] <port-pair-group>

表59.59 位置引数

概要

<port-pair-group>

削除するポートペアグループ (名前または ID)

表59.60 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

59.16. sfc port pair group list

ポートペアグループを一覧表示します。

使用方法

openstack sfc port pair group list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN] [--long]

表59.61 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.62 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表59.63 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表59.64 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.65 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

59.17. sfc port pair group set

ポートペアグループの属性を設定します。

使用方法

openstack sfc port pair group set [-h] [--name <name>]
                                         [--description <description>]
                                         [--port-pair <port-pair>]
                                         [--no-port-pair]
                                         <port-pair-group>

表59.66 位置引数

概要

<port-pair-group>

変更するポートペアグループ (名前または ID)

表59.67 その他の引数 (オプション):

概要

--no-port-pair

ポートペアグループからポートのペアをすべて削除します。

--name <name>

ポートペアグループの名前

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ポートペアグループの説明

--port-pair <port-pair>

ポートのペア (名前または ID)。このオプションを繰り返すことができます。

59.18. sfc port pair group show

ポートペアグループの詳細を表示します。

使用方法

openstack sfc port pair group show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          <port-pair-group>

表59.68 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.69 位置引数

概要

<port-pair-group>

表示するポートペアグループ (名前または ID)

表59.70 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表59.71 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.72 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表59.73 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

59.19. sfc port pair group unset

ポートペアグループからポートペアの設定を解除します。

使用方法

openstack sfc port pair group unset [-h]
                                           [--port-pair <port-pair> | --all-port-pair]
                                           <port-pair-group>

表59.74 位置引数

概要

<port-pair-group>

設定を解除するポートペアグループ (名前または ID)

表59.75 その他の引数 (オプション):

概要

--all-port-pair

ポートペアグループからポートのペアをすべて削除します。

-h, --help

ヘルプメッセージを表示して終了します。

--port-pair <port-pair>

ポートペアグループからポートのペアを削除します (名前または ID)。このオプションを繰り返すことができます。

59.20. sfc port pair list

ポートペアの一覧を表示します。

使用方法

openstack sfc port pair list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN] [--long]

表59.76 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.77 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表59.78 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表59.79 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.80 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

59.21. sfc port pair set

ポートペアの属性を設定します。

使用方法

openstack sfc port pair set [-h] [--name <name>]
                                   [--description <description>]
                                   <port-pair>

表59.81 位置引数

概要

<port-pair>

変更するポートペア (名前または ID)

表59.82 その他の引数 (オプション):

概要

--name <name>

ポートペアの名前

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ポートペアの説明

59.22. sfc port pair show

ポートペアの詳細を表示します。

使用方法

openstack sfc port pair show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    <port-pair>

表59.83 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.84 位置引数

概要

<port-pair>

表示するポートペア (名前または ID)

表59.85 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表59.86 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.87 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表59.88 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

59.23. sfc service graph create

サービスグラフを作成します。

使用方法

openstack sfc service graph create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [--description DESCRIPTION]
                                          --branching-point
                                          SRC_CHAIN:DST_CHAIN_1,DST_CHAIN_2,DST_CHAIN_N
                                          <name>

表59.89 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.90 位置引数

概要

<name>

サービスグラフの名前。

表59.91 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表59.92 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.93 その他の引数 (オプション):

概要

--branching-point SRC_CHAIN:DST_CHAIN_1,DST_CHAIN_2,DST_CHAIN_N

サービスグラフの分岐点: キーは、ソースポートチェーンで、値は宛先ポートチェーンのリストです。このオプションを繰り返すことができます。

-h, --help

ヘルプメッセージを表示して終了します。

--description DESCRIPTION

サービスグラフの説明。

表59.94 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

59.24. sfc service graph delete

特定のサービスグラフを削除します。

使用方法

openstack sfc service graph delete [-h] <service-graph>

表59.95 位置引数

概要

<service-graph>

削除するサービスグラフの ID または名前。

表59.96 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

59.25. sfc service graph list

サービスグラフの一覧を表示します。

使用方法

openstack sfc service graph list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN] [--long]

表59.97 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.98 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表59.99 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表59.100 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.101 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

59.26. sfc service graph set

サービスグラフの属性を設定します。

使用方法

openstack sfc service graph set [-h] [--name <name>]
                                       [--description <description>]
                                       <service-graph>

表59.102 位置引数

概要

<service-graph>

変更するサービスグラフ (名前または ID)

表59.103 その他の引数 (オプション):

概要

--name <name>

サービスグラフの名前

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

サービスグラフの説明

59.27. sfc service graph show

特定のサービスグラフの情報を表示します。

使用方法

openstack sfc service graph show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        <service-graph>

表59.104 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表59.105 位置引数

概要

<service-graph>

表示するサービスグラフの ID または名前。

表59.106 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表59.107 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.108 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表59.109 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第60章 snapshot

本章では、snapshot コマンドに含まれるコマンドについて説明します。

60.1. snapshot create

新規スナップショットの作成

使用方法

openstack snapshot create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX] [--name <name>]
                                 [--description <description>] [--force]
                                 [--property <key=value>]
                                 <volume>

表60.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表60.2 位置引数

概要

<volume>

スナップショットを作成するボリューム(名前または ID)

表60.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表60.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表60.5 その他の引数 (オプション):

概要

--force

インスタンスに割り当てられているスナップショットを作成します。デフォルトは False です。

--name <name>

スナップショットの名前

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

スナップショットの説明

--property <key=value>

属性をこのスナップショットに設定します (複数の属性を設定する場合はオプションを繰り返し使用します)。

表60.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

60.2. snapshot delete

ボリュームスナップショットを削除します。

使用方法

openstack snapshot delete [-h] <snapshot> [<snapshot> ...]

表60.7 位置引数

概要

<snapshot>

削除するスナップショット (名前または ID)

表60.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

60.3. snapshot list

スナップショットのリスト

使用方法

openstack snapshot list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--sort-column SORT_COLUMN] [--all-projects]
                               [--long] [--marker <snapshot>]
                               [--limit <num-snapshots>]

表60.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表60.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表60.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表60.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表60.13 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトを含めます (管理者のみ)。

--marker <snapshot>

前のページにある最後のスナップショット ID

-h, --help

ヘルプメッセージを表示して終了します。

--limit <num-snapshots>

表示するスナップショットの最大数。

--long

出力の追加フィールドを一覧表示します。

60.4. snapshot set

スナップショット属性を設定します。

使用方法

openstack snapshot set [-h] [--name <name>]
                              [--description <description>]
                              [--property <key=value>] [--state <state>]
                              <snapshot>

表60.14 位置引数

概要

<snapshot>

変更するスナップショット (名前または ID)

表60.15 その他の引数 (オプション):

概要

--name <name>

新しいスナップショット名

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

新しいスナップショットの説明

--property <key=value>

このスナップショットに追加/変更する属性 (複数の属性を設定する場合はオプションを繰り返し使用します)

--state <state>

新しいボリュームの状態 ("available"、"error"、"creating"、"deleting"、または "error_deleting") (管理者のみ) (このオプションは、実際のステータスに関係なくデータベースのスナップショットの状態を変更するだけで、使用時には注意が必要です)

60.5. snapshot show

スナップショットの詳細を表示します。

使用方法

openstack snapshot show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]
                               <snapshot>

表60.16 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表60.17 位置引数

概要

<snapshot>

表示するスナップショット (名前または ID)

表60.18 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表60.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表60.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表60.21 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

60.6. snapshot unset

スナップショット属性の設定を解除します。

使用方法

openstack snapshot unset [-h] [--property <key>] <snapshot>

表60.22 位置引数

概要

<snapshot>

変更するスナップショット (名前または ID)

表60.23 その他の引数 (オプション):

概要

--property <key>

スナップショットから削除する属性 (複数の属性を削除する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

第61章 ソフトウェア

本章では、software コマンドに含まれるコマンドについて説明します。

61.1. software config create

ソフトウェア設定を作成します。

使用方法

openstack software config create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--config-file <config-file>]
                                        [--definition-file <destination-file>]
                                        [--group <group>]
                                        <config-name>

表61.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表61.2 位置引数

概要

<config-name>

作成するソフトウェア設定の名前

表61.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは json です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表61.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表61.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--group=GROUP

ソフトウェア設定が必要とするツールのグループ名

--config-file <config-file>

<inputs>、<outputs>、および <options> を定義するマップが含まれる json/yaml へのパス

--definition-file <destination-file>

ソフトウェア設定スクリプト/データへのパス

表61.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

61.2. software config delete

ソフトウェア設定を削除します。

使用方法

openstack software config delete [-h] <config> [<config> ...]

表61.7 位置引数

概要

<config>

削除するソフトウェア設定の ID

表61.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

61.3. software config list

ソフトウェア設定の一覧を表示します。

使用方法

openstack software config list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--limit <limit>] [--marker <id>]

表61.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表61.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表61.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表61.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表61.13 その他の引数 (オプション):

概要

--limit <limit>

返される設定の数を制限します。

-h, --help

ヘルプメッセージを表示して終了します。

--marker <id>

指定された設定 ID の後に表示される設定を返します。

61.4. software config show

ソフトウェア設定の詳細を表示します。

使用方法

openstack software config show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--config-only]
                                      <config>

表61.14 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表61.15 位置引数

概要

<config>

設定の ID

表61.16 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表61.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表61.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--config-only

<config> 属性の値のみを表示します。

表61.19 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

61.5. software deployment create

ソフトウェアデプロイメントを作成します。

使用方法

openstack software deployment create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            [--input-value <key=value>]
                                            [--action <action>]
                                            [--config <config>]
                                            [--signal-transport <signal-transport>]
                                            [--container <container>]
                                            [--timeout <timeout>] --server
                                            <server>
                                            <deployment-name>

表61.20 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表61.21 位置引数

概要

<deployment-name>

このデプロイメントに関連する派生設定の名前。これは、サーバーに現在デプロイされている設定のリストにソート順序を適用するために使用されます。

表61.22 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表61.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表61.24 その他の引数 (オプション):

概要

--timeout <timeout>

デプロイメントのタイムアウト (分単位)

--signal-transport <signal-transport>

デプロイメント出力値を使用して、サーバーが heat にシグナルを送信する方法。TEMP_URL_SIGNAL は、HTTP PUT 経由でシグナル送信する Swift TempURL を作成します。ZAQAR_SIGNAL は、提供された keystone 認証情報を使用してシグラル送信する専用の zaqar キューを作成します。NO_SIGNAL は、シグナルを待たずにリソースを COMPLETE 状態にします。

--container <container>

temp_url_signal オブジェクトを保存するオプションのコンテナー名指定しない場合は、DEPLOY_NAME から派生した名前でコンテナーが作成されます。

--action <action>

このデプロイメントのアクションの名前。カスタムアクション、または CREATE、UPDATE、DELETE、SUSPEND、RESUME のいずれか。デフォルトは UPDATE です。

-h, --help

ヘルプメッセージを表示して終了します。

--server <server>

デプロイ先のサーバーの ID

--input-value <key=value>

デプロイメントに設定する入力値。これは複数回指定できます。

--config <config>

デプロイする設定の ID

表61.25 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

61.6. software deployment delete

ソフトウェアデプロイメントおよび依存関係にある設定を削除します。

使用方法

openstack software deployment delete [-h]
                                            <deployment> [<deployment> ...]

表61.26 位置引数

概要

<deployment>

削除するデプロイメントの ID。

表61.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

61.7. software deployment list

ソフトウェアデプロイメントを一覧表示します。

使用方法

openstack software deployment list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN]
                                          [--server <server>] [--long]

表61.28 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表61.29 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表61.30 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表61.31 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表61.32 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--server <server>

デプロイメントを取得するサーバーの ID

--long

出力でより多くのフィールドを一覧表示します。

61.8. software deployment metadata show

指定されたサーバーのデプロイメント設定のメタデータを取得します。

使用方法

openstack software deployment metadata show [-h] <server>

表61.33 位置引数

概要

<server>

デプロイメントを取得するサーバーの ID

表61.34 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

61.9. software deployment output show

特定のデプロイメント出力を表示します。

使用方法

openstack software deployment output show [-h] [--all] [--long]
                                                 <deployment> [<output-name>]

表61.35 位置引数

概要

<deployment>

出力を表示するデプロイメントの ID

<output-name>

表示する出力の名前

表61.36 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all

すべてのデプロイメント出力を表示します。

--long

完全なデプロイメントログを出力に表示します。

61.10. software deployment show

ソフトウェアデプロイメントの詳細を表示します。

使用方法

openstack software deployment show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [--long]
                                          <deployment>

表61.37 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表61.38 位置引数

概要

<deployment>

デプロイメントの ID

表61.39 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表61.40 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表61.41 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力により多くのフィールドを表示します。

表61.42 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第62章 stack

本章では、stack コマンドに含まれるコマンドについて説明します。

62.1. stack abandon

スタックおよび出力の結果を破棄します。

使用方法

openstack stack abandon [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] [--output-file <output-file>]
                               <stack>

表62.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.2 位置引数

概要

<stack>

破棄するスタックの名前または ID

表62.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは json です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--output-file <output-file>

破棄の結果を出力するファイル

表62.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

62.2. stack adopt

スタックを受け入れます。

使用方法

openstack stack adopt [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             [-e <environment>] [--timeout <timeout>]
                             [--enable-rollback] [--parameter <key=value>]
                             [--wait] --adopt-file <adopt-file>
                             <stack-name>

表62.7 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.8 位置引数

概要

<stack-name>

受け入れるスタックの名前

表62.9 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.10 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.11 その他の引数 (オプション):

概要

--timeout <timeout>

スタック作成のタイムアウト (分単位)

--wait

スタックの受け入れが完了するまで待ちます。

-e <environment>, --environment <environment>

環境へのパス。複数回指定できます。

--adopt-file <adopt-file>

受け入れスタックデータファイルへのパス

--parameter <key=value>

スタックの作成に使用するパラメーター値。複数回指定できます。

-h, --help

ヘルプメッセージを表示して終了します。

--enable-rollback

作成/更新失敗時のロールバックを有効にします。

表62.12 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

62.3. stack cancel

スタックの現在のタスクを取り消します。取り消しがサポートされるタスク:* 更新 * 作成

使用方法

openstack stack cancel [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN] [--wait]
                              [--no-rollback]
                              <stack> [<stack> ...]

表62.13 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.14 位置引数

概要

<stack>

取り消すスタック (名前または ID)

表62.15 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表62.16 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表62.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.18 その他の引数 (オプション):

概要

--no-rollback

ロールバックせずに取り消します。

-h, --help

ヘルプメッセージを表示して終了します。

--wait

取り消しが完了するまで待ちます。

62.4. stack check

スタックを確認します。

使用方法

openstack stack check [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--wait]
                             <stack> [<stack> ...]

表62.19 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.20 位置引数

概要

<stack>

更新を確認するスタック (名前または ID)

表62.21 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表62.22 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表62.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.24 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait

確認が完了するまで待ちます。

62.5. stack create

スタックを作成します。

使用方法

openstack stack create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [-e <environment>]
                              [--timeout <timeout>] [--pre-create <resource>]
                              [--enable-rollback] [--parameter <key=value>]
                              [--parameter-file <key=file>] [--wait]
                              [--tags <tag1,tag2...>] [--dry-run] -t
                              <template>
                              <stack-name>

表62.25 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.26 位置引数

概要

<stack-name>

作成するスタックの名前

表62.27 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.28 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.29 その他の引数 (オプション):

概要

--parameter-file <key=file>

スタックの作成に使用するファイルからのパラメーター値。これは複数回指定できます。パラメーター値は、ファイルのコンテンツです。

--timeout <timeout>

スタック作成のタイムアウト (分単位)

--wait

スタックが create_complete または CREATE_FAILED になるまで待機します。

-t <template>, --template <template>

テンプレートへのパス

--dry-run

実際にはスタックの作成を行わずに、何が作成されるかを表示します。

-e <environment>, --environment <environment>

環境へのパス。複数回指定できます。

--pre-create <resource>

作成前フックを設定するリソースの名前。入れ子状のスタックのリソースは、スラッシュを区切り文字として使用して設定できます (例: ``nested_stack/another/my_resource``)。ワイルドカードを使用すると、複数のスタックまたはリソースを照合できます (例:''nested_stack/an*/*_resource'')。これは複数回指定できます。

--parameter <key=value>

スタックの作成に使用するパラメーター値。これは複数回指定できます。

-h, --help

ヘルプメッセージを表示して終了します。

--tags <tag1,tag2…​>

スタックに関連付けるタグの一覧

--enable-rollback

作成/更新失敗時のロールバックを有効にします。

表62.30 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

62.6. stack delete

スタックを削除します。

使用方法

openstack stack delete [-h] [-y] [--wait] <stack> [<stack> ...]

表62.31 位置引数

概要

<stack>

削除するスタック (名前または ID)

表62.32 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-y、--yes

yes/no プロンプトを省略します (yes と仮定)。

--wait

スタックの削除が完了するまで待ちます。

62.7. stack environment show

スタックの環境を表示します。

使用方法

openstack stack environment show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        <NAME or ID>

表62.33 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.34 位置引数

概要

<NAME or ID>

クエリーを行うスタックの名前または ID

表62.35 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.36 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.37 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表62.38 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

62.8. stack event list

イベントを一覧表示します。

使用方法

openstack stack event list [-h] [-f {csv,json,log,table,value,yaml}]
                                  [-c COLUMN] [--noindent]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]
                                  [--resource <resource>]
                                  [--filter <key=value>] [--limit <limit>]
                                  [--marker <id>] [--nested-depth <depth>]
                                  [--sort <key>[:<direction>]] [--follow]
                                  <stack>

表62.39 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.40 位置引数

概要

<stack>

イベントを表示するスタックの名前または ID

表62.41 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表62.42 出力形式の設定

概要

output formatter options-f {csv,json,log,table,value,yaml}, --format {csv,json,log,table,value,yaml}

出力形式。デフォルトは log です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表62.43 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.44 その他の引数 (オプション):

概要

--filter <key=value>

返されたイベントに適用するフィルターパラメーター

--nested-depth <depth>

イベントを表示するネストされたスタックの深さ。注記: これは --resource と共に指定することはできません。

--follow

プロセスが停止するまでイベントを出力します。

--resource <resource>

イベントを表示するリソースの名前。注記:--nested-depth と共に指定することはできません。

--limit <limit>

返されるイベントの数を制限します。

--sort <key>[:<direction>]

選択した鍵と方向 (asc または desc、デフォルト:asc) で出力を並べ替えます。複数のキーでソートするには複数回指定します。ソート用のキーには、"event_time" (デフォルト)、"resource_name"、"links"、"logical_resource_id"、"resource_status"、"resource_status_reason"、"physical_resource_id"、または "id" を使用できます。キーは空のままにし、リバースタイムでソートするために:desc を指定できます。

-h, --help

ヘルプメッセージを表示して終了します。

--marker <id>

指定の id の後に表示されるイベントのみを返します。

62.9. stack event show

イベントの詳細を表示します。

使用方法

openstack stack event show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  <stack> <resource> <event>

表62.45 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.46 位置引数

概要

<resource>

イベントが属するリソースの名前

<stack>

イベントを表示するスタックの名前または ID

<event>

詳細を表示するイベントの ID

表62.47 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.48 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.49 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表62.50 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

62.10. stack export

スタックデータ json をエクスポートします。

使用方法

openstack stack export [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [--output-file <output-file>]
                              <stack>

表62.51 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.52 位置引数

概要

<stack>

エクスポートするスタックの名前または ID

表62.53 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは json です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.54 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.55 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--output-file <output-file>

エクスポートデータを出力するファイル

表62.56 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

62.11. stack failures list

障害が発生したスタックリソースに関する情報を表示します。

使用方法

openstack stack failures list [-h] [--long] <stack>

表62.57 位置引数

概要

<stack>

表示するスタック (名前または ID)

表62.58 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

完全なデプロイメントログを出力に表示します。

62.12. stack file list

スタックのファイルマップを表示します。

使用方法

openstack stack file list [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX]
                                 <NAME or ID>

表62.59 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.60 位置引数

概要

<NAME or ID>

クエリーを行うスタックの名前または ID

表62.61 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.62 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.63 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表62.64 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

62.13. stack hook clear

特定のスタックでリソースフックを消去します。

使用方法

openstack stack hook clear [-h] [--pre-create] [--pre-update]
                                  [--pre-delete]
                                  <stack> <resource> [<resource> ...]

表62.65 位置引数

概要

<resource>

消去するフックが設定されたリソース名。入れ子状のスタックのリソースは、スラッシュを区切り文字として使用して設定できます (例: ``nested_stack/another/my_resource``)。ワイルドカードを使用すると、複数のスタックまたはリソースを照合できます (例:''nested_stack/an*/*_resource'')。

<stack>

表示するスタック (名前または ID)

表62.66 その他の引数 (オプション):

概要

--pre-update

更新前のフックを消去します。

-h, --help

ヘルプメッセージを表示して終了します。

--pre-create

作成前フックを消去します。

--pre-delete

削除前フックを削除します。

62.14. stack hook poll

スタックの保留中のフックを持つリソースを一覧表示します。

使用方法

openstack stack hook poll [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN]
                                 [--nested-depth <nested-depth>]
                                 <stack>

表62.67 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.68 位置引数

概要

<stack>

表示するスタック (名前または ID)

表62.69 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表62.70 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表62.71 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.72 その他の引数 (オプション):

概要

--nested-depth <nested-depth>

フックを表示するネストされたスタックの深さ。

-h, --help

ヘルプメッセージを表示して終了します。

62.15. stack list

スタックを一覧表示します。

使用方法

openstack stack list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--sort-column SORT_COLUMN] [--deleted] [--nested]
                            [--hidden] [--property <key=value>]
                            [--tags <tag1,tag2...>] [--tag-mode <mode>]
                            [--limit <limit>] [--marker <id>]
                            [--sort <key>[:<direction>]] [--all-projects]
                            [--short] [--long]

表62.73 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.74 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表62.75 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表62.76 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.77 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトを含めます (管理者のみ)。

--hidden

スタック一覧に、非表示のスタックを含めます。

--property <key=value>

返されたスタックに適用するフィルター属性 (複数の属性で絞り込むには繰り返し指定します)

--short

出力でより少ないフィールドを一覧表示します。

--limit <limit>

返されるスタックの数

--long

出力の追加フィールドを一覧表示します。これは --all-projects によって暗示されます。

--nested

スタック一覧に、ネスティングされたスタックを含めます。

--deleted

スタック一覧に、ソフト削除されたスタックを含めます。

--marker <id>

指定の id の後に表示されるスタックのみを返します。

--sort <key>[:<direction>]

選択した鍵と方向 (asc または desc、デフォルト:asc) で出力を並べ替えます。複数の属性でソートするには複数回指定します。

-h, --help

ヘルプメッセージを表示して終了します。

--tags <tag1,tag2…​>

絞り込みに使用するタグの一覧。--tag- mode と組み合わせることで、タグのフィルター方法を指定できます。

--tag-mode <mode>

タグをフィルターリングする方法。any、not、または not-any のいずれかでなければなりません。指定しない場合、複数のタグをブール値 AND 式で組み合わせます。

62.16. stack output list

スタックの出力を一覧表示します。

使用方法

openstack stack output list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN]
                                   <stack>

表62.78 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.79 位置引数

概要

<stack>

クエリーを行うスタックの名前または ID

表62.80 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表62.81 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表62.82 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.83 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

62.17. stack output show

スタックの出力を表示します。

使用方法

openstack stack output show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX] [--all]
                                   <stack> [<output>]

表62.84 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.85 位置引数

概要

<stack>

クエリーを行うスタックの名前または ID

<output>

表示する出力の名前

表62.86 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.87 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.88 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all

すべてのスタック出力を表示します。

表62.89 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

62.18. stack resource list

スタックリソースを一覧表示します。

使用方法

openstack stack resource list [-h] [-f {csv,dot,json,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--max-width <integer>] [--fit-width]
                                     [--print-empty]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN] [--long]
                                     [-n <nested-depth>]
                                     [--filter <key=value>]
                                     <stack>

表62.90 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.91 位置引数

概要

<stack>

クエリーを行うスタックの名前または ID

表62.92 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表62.93 出力形式の設定

概要

output formatter options-f {csv,dot,json,table,value,yaml}, --format {csv,dot,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表62.94 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.95 その他の引数 (オプション):

概要

--filter <key=value>

リソースの名前、ステータス、種別、アクション、id、および physical_resource_id をもとに返されるリソースに適用するフィルターパラメーター

-h, --help

ヘルプメッセージを表示して終了します。

-n <nested-depth>, --nested-depth <nested-depth>

リソースを表示するネストされたスタックの深さ。

--long

リソース一覧の各リソースで提示される詳細情報を有効にする

62.19. stack resource mark unhealthy

リソースの健全性を設定します。

使用方法

openstack stack resource mark unhealthy [-h] [--reset]
                                               <stack> <resource> [reason]

表62.96 位置引数

概要

reason

状態変更の理由

<resource>

リソースの名前

<stack>

リソースが属するスタックの名前または ID

表62.97 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--reset

リソースを健全として設定します。

62.20. stack resource metadata

リソースメタデータを表示します。

使用方法

openstack stack resource metadata [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         <stack> <resource>

表62.98 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.99 位置引数

概要

<resource>

メタデータを表示するリソースの名前

<stack>

表示するスタック (名前または ID)

表62.100 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは json です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.101 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.102 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表62.103 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

62.21. stack resource show

スタックリソースを表示します。

使用方法

openstack stack resource show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--with-attr <attribute>]
                                     <stack> <resource>

表62.104 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.105 位置引数

概要

<resource>

リソースの名前

<stack>

クエリーを行うスタックの名前または ID

表62.106 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.107 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.108 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--with-attr <attribute>

表示する属性。複数回指定できます。

表62.109 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

62.22. stack resource signal

オプションのデータを持つリソースにシグナルを送ります。

使用方法

openstack stack resource signal [-h] [--data <data>]
                                       [--data-file <data-file>]
                                       <stack> <resource>

表62.110 位置引数

概要

<resource>

シグナルを送るリソースの名前

<stack>

リソースが属するスタックの名前または ID

表62.111 その他の引数 (オプション):

概要

--data <data>

シグナルハンドラーに送信する JSON データ

-h, --help

ヘルプメッセージを表示して終了します。

--data-file <data-file>

シグナルハンドラーに送信する json データが含まれるファイル

62.23. stack resume

スタックを再開します。

使用方法

openstack stack resume [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN] [--wait]
                              <stack> [<stack> ...]

表62.112 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.113 位置引数

概要

<stack>

再開するスタック (名前または ID)

表62.114 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表62.115 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表62.116 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.117 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait

再開が完了するまで待ちます。

62.24. stack show

スタックの詳細を表示します。

使用方法

openstack stack show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent] [--prefix PREFIX]
                            [--no-resolve-outputs]
                            <stack>

表62.118 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.119 位置引数

概要

<stack>

表示するスタック (名前または ID)

表62.120 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.121 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.122 その他の引数 (オプション):

概要

--no-resolve-outputs

スタックの出力を解決しません。

-h, --help

ヘルプメッセージを表示して終了します。

表62.123 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

62.25. stack snapshot create

スタックのスナップショットを作成します。

使用方法

openstack stack snapshot create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--name <name>]
                                       <stack>

表62.124 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.125 位置引数

概要

<stack>

スタックの名前または ID

表62.126 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.127 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.128 その他の引数 (オプション):

概要

--name <name>

スナップショットの名前

-h, --help

ヘルプメッセージを表示して終了します。

表62.129 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

62.26. stack snapshot delete

スタックのスナップショットを削除します。

使用方法

openstack stack snapshot delete [-h] [-y] <stack> <snapshot>

表62.130 位置引数

概要

<snapshot>

スタックスナップショットの ID

<stack>

スタックの名前または ID

表62.131 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-y、--yes

yes/no プロンプトを省略します (yes と仮定)。

62.27. stack snapshot list

スタックのスナップショットを一覧表示します。

使用方法

openstack stack snapshot list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     <stack>

表62.132 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.133 位置引数

概要

<stack>

スナップショットが含まれるスタックの名前または ID

表62.134 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表62.135 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表62.136 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.137 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

62.28. stack snapshot restore

スタックのスナップショットを復元します。

使用方法

openstack stack snapshot restore [-h] <stack> <snapshot>

表62.138 位置引数

概要

<snapshot>

復元するスナップショットの ID

<stack>

スナップショットが含まれるスタックの名前または ID

表62.139 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

62.29. stack snapshot show

スタックのスナップショットを表示します。

使用方法

openstack stack snapshot show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <stack> <snapshot>

表62.140 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.141 位置引数

概要

<snapshot>

表示するスナップショットの ID

<stack>

スナップショットが含まれるスタックの名前または ID

表62.142 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.143 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.144 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表62.145 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

62.30. stack suspend

スタックを中断します。

使用方法

openstack stack suspend [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--sort-column SORT_COLUMN] [--wait]
                               <stack> [<stack> ...]

表62.146 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.147 位置引数

概要

<stack>

中断するスタック (名前または ID)

表62.148 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表62.149 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表62.150 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.151 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait

中断が完了するまで待ちます。

62.31. stack template show

スタックのテンプレートを表示します。

使用方法

openstack stack template show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <stack>

表62.152 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.153 位置引数

概要

<stack>

クエリーを行うスタックの名前または ID

表62.154 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.155 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.156 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表62.157 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

62.32. stack update

スタックを更新します。

使用方法

openstack stack update [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [-t <template>]
                              [-e <environment>] [--pre-update <resource>]
                              [--timeout <timeout>] [--rollback <value>]
                              [--dry-run] [--show-nested]
                              [--parameter <key=value>]
                              [--parameter-file <key=file>] [--existing]
                              [--clear-parameter <parameter>]
                              [--tags <tag1,tag2...>] [--wait] [--converge]
                              <stack>

表62.158 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表62.159 位置引数

概要

<stack>

更新するスタックの名前または ID

表62.160 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.161 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.162 その他の引数 (オプション):

概要

--parameter <key=value>

スタックの作成に使用するパラメーター値。これは複数回指定できます。

--parameter-file <key=file>

スタックの作成に使用するファイルからのパラメーター値。これは複数回指定できます。パラメーター値は、ファイルのコンテンツです。

--timeout <timeout>

スタック更新のタイムアウト (分単位)

--wait

スタックが update_complete または UPDATE_FAILED になるまで待機します。

-t <template>, --template <template>

テンプレートへのパス

--pre-update <resource>

更新前フックを設定するリソースの名前。入れ子状のスタックのリソースは、スラッシュを区切り文字として使用して設定できます (例: ``nested_stack/another/my_resource``)。ワイルドカードを使用すると、複数のスタックまたはリソースを照合できます (例:''nested_stack/an*/*_resource'')。これは複数回指定できます。

-e <environment>, --environment <environment>

環境へのパス。複数回指定できます。

--rollback <value>

更新の失敗時にロールバックを設定します。値 "enabled" はロールバックを有効に設定します。値 "disabled" はロールバックを無効に設定します。値 keep は、更新する既存のスタックの値を使用します (デフォルト)。

--converge

現実性を観察しながらのスタック更新。

--dry-run

実際にはスタックの更新を行わずに、何が変更されるかを表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--clear-parameter <parameter>

スタックの更新用に、現在のスタックのパラメーターセットからパラメーターを削除します。テンプレートのデフォルト値が使用されます。これは複数回指定できます。

--tags <tag1,tag2…​>

スタックに関連付ける更新されたタグの一覧

--show-nested

--dry-run の実行時にネストされたスタックを表示します。

--existing

現在のスタックのテンプレート、パラメーター、および環境を再利用します。テンプレートの引数を省略すると、既存のテンプレートが使用されます。--environment を指定しないと、既存の環境が使用されます。--parameter で指定したパラメーターは、現在のスタックの既存の値にパッチを適用します。省略されたパラメーターは既存の値を維持します。

表62.163 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第63章 subnet

本章では、subnet コマンドに含まれるコマンドについて説明します。

63.1. subnet create

サブネットを作成します。

使用方法

openstack subnet create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] [--project <project>]
                               [--project-domain <project-domain>]
                               [--subnet-pool <subnet-pool> | --use-prefix-delegation USE_PREFIX_DELEGATION | --use-default-subnet-pool]
                               [--prefix-length <prefix-length>]
                               [--subnet-range <subnet-range>]
                               [--dhcp | --no-dhcp] [--gateway <gateway>]
                               [--ip-version {4,6}]
                               [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
                               [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
                               [--network-segment <network-segment>] --network
                               <network> [--description <description>]
                               [--allocation-pool start=<ip-address>,end=<ip-address>]
                               [--dns-nameserver <dns-nameserver>]
                               [--host-route destination=<subnet>,gateway=<ip-address>]
                               [--service-type <service-type>]
                               [--tag <tag> | --no-tag]
                               name

表63.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表63.2 位置引数

概要

name

新規サブネット名

表63.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表63.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表63.5 その他の引数 (オプション):

概要

--ip-version {4,6}

IP バージョン (デフォルトは 4)。サブネットプールが指定されている場合には、サブネットプールから IP バージョンが決定され、このオプションは無視されます。

--host-route destination=<subnet>,gateway=<ip-address>

このサブネットの追加のルート (例:destination=10.10.0.0/16,gateway=192.168.71.254、 destination: 宛先のサブネット (CIDR 表記)、gateway: 次のホップの IP アドレス)(複数のルートを追加する場合はオプションを繰り返し使用します)

--gateway <gateway>

サブネットのゲートウェイを指定します。3 つのオプションは、<ip-address>: ゲートウェイとして使用する特定の IP アドレス、auto: ゲートウェイのアドレスはサブネット自体から自動的に選択される、none: このサブネットはゲートウェイを使用しない、です (例:--gateway 192.168.9.1、--gateway auto、--gateway none(デフォルトは auto))。

--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}

Ipv6 ra(ルーター広告) モード。有効なモード:[dhcpv6-stateful、dhcpv6-stateless、slaac]

--service-type <service-type>

このサブネットのサービス種別 (例:network:floatingip_agent_gateway)。ネットワークポートの有効なデバイス所有者の値でなければなりません (複数のサービス種別を設定する場合はオプションを繰り返し使用します)。

--subnet-range <subnet-range>

cidr 表記のサブネット範囲 (--subnet- pool が指定されていない場合には必須、それ以外の場合はオプション)

--project <project>

所有者のプロジェクト (名前または ID)

--network <network>

このサブネットが属するネットワーク (名前または ID)

--prefix-length <prefix-length>

サブネットプールからのサブネット割り当ての接頭辞長

--use-prefix-delegation USE_PREFIX_DELEGATION

ip が ipv6 形式で、ip が外部に委譲される場合は prefix-delegation を使用します。

--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}

Ipv6 アドレスモード。有効なモード:[dhcpv6-stateful、dhcpv6-stateless、slaac]

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

サブネットの説明を設定します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--use-default-subnet-pool

--ip-version のデフォルトのサブネットプールを使用します。

--no-dhcp

dhcp を無効にします。

--dhcp

dhcp を有効にします (デフォルト)。

--no-tag

サブネットにタグを関連付けません。

--allocation-pool start=<ip-address>,end=<ip-address>

このサブネットの割り当てプール IP アドレス (例:start=192.168.199.2,end=192.168.199.254)(複数の IP アドレスを追加する場合はオプションを繰り返し使用します)

--subnet-pool <subnet-pool>

このサブネットが cidr を取得するサブネットプール (名前または ID)。

--tag <tag>

サブネットに追加されるタグ (複数のタグを設定する場合はオプションを繰り返し使用します)

--dns-nameserver <dns-nameserver>

このサブネットの DNS サーバー (複数の DNS サーバーを設定する場合はオプションを繰り返し使用します)

--network-segment <network-segment>

このサブネットに関連付けるネットワークセグメント (名前または ID)

表63.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

63.2. subnet delete

サブネットを削除します。

使用方法

openstack subnet delete [-h] <subnet> [<subnet> ...]

表63.7 位置引数

概要

<subnet>

削除するサブネット (名前または ID)

表63.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

63.3. subnet list

サブネットを一覧表示します。

使用方法

openstack subnet list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--long]
                             [--ip-version <ip-version>] [--dhcp | --no-dhcp]
                             [--service-type <service-type>]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--network <network>] [--gateway <gateway>]
                             [--name <name>] [--subnet-range <subnet-range>]
                             [--tags <tag>[,<tag>,...]]
                             [--any-tags <tag>[,<tag>,...]]
                             [--not-tags <tag>[,<tag>,...]]
                             [--not-any-tags <tag>[,<tag>,...]]

表63.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表63.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表63.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表63.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表63.13 その他の引数 (オプション):

概要

--no-dhcp

dhcp が無効になっているサブネットを一覧表示します。

--ip-version <ip-version>

出力に、指定の ip バージョンのサブネットのみを一覧表示します。IP バージョンの許可される値は 4 および 6 です。

--not-any-tags <tag>[,<tag>,…​]

指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたサブネットを除外します。

--name <name>

出力に、指定した名前のサブネットのみを一覧表示します。

--tags <tag>[,<tag>,…​]

指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたサブネットを一覧表示します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--subnet-range <subnet-range>

出力に、指定のサブネット範囲 (cidr 表記) のサブネットのみを一覧表示します (例:--subnet-range 10.10.0.0/16)。

--long

出力の追加フィールドを一覧表示します。

--project <project>

出力に、指定のプロジェクトに属するサブネットのみを一覧表示します (名前または ID)。

--any-tags <tag>[,<tag>,…​]

指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたサブネットを一覧表示します。

--network <network>

出力に、指定のネットワークに属するサブネットのみを一覧表示します (名前または ID)。

--not-tags <tag>[,<tag>,…​]

指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたサブネットを除外します。

--gateway <gateway>

出力に、指定したゲートウェイのサブネットのみを一覧表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--service-type <service-type>

出力に、指定のサービス種別のサブネットのみを一覧表示します (例:network:floatingip_agent_gateway)。ネットワークポートの有効なデバイス所有者の値でなければなりません (複数のサービス種別を一覧表示する場合はオプションを繰り返し使用します)。

--dhcp

dhcp が有効になっているサブネットを一覧表示します。

63.4. subnet pool create

サブネットプールを作成します。

使用方法

openstack subnet pool create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX] --pool-prefix
                                    <pool-prefix>
                                    [--default-prefix-length <default-prefix-length>]
                                    [--min-prefix-length <min-prefix-length>]
                                    [--max-prefix-length <max-prefix-length>]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--address-scope <address-scope>]
                                    [--default | --no-default]
                                    [--share | --no-share]
                                    [--description <description>]
                                    [--default-quota <num-ip-addresses>]
                                    [--tag <tag> | --no-tag]
                                    <name>

表63.14 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表63.15 位置引数

概要

<name>

新規サブネットプールの名前

表63.16 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表63.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表63.18 その他の引数 (オプション):

概要

--share

このサブネットプールを共有として設定します。

--no-share

このサブネットプールを非共有として設定します。

--min-prefix-length <min-prefix-length>

サブネットプールの最小接頭辞長を設定します。

--no-tag

サブネットプールにタグを関連付けません。

--default-quota <num-ip-addresses>

サブネットで許可されるip アドレスの数として、サブネットプールのデフォルトクォータを設定します。

--tag <tag>

サブネットプールに追加されるタグ (複数のタグを設定する場合はオプションを繰り返し使用します)

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--address-scope <address-scope>

サブネットプールに関連付けられたアドレススコープを設定します (名前または ID)。接頭辞は、アドレススコープ全体で一意でなければなりません。

--max-prefix-length <max-prefix-length>

サブネットプールの最大接頭辞長を設定します。

--pool-prefix <pool-prefix>

サブネットプールの接頭辞 (cidr 表記) を設定します (複数の接頭辞を設定する場合はオプションを繰り返し使用します)。

--no-default

これをデフォルト以外のサブネットプールとして設定します。

--default

これをデフォルトのサブネットプールとして設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

サブネットプールの説明を設定します。

--project <project>

所有者のプロジェクト (名前または ID)

--default-prefix-length <default-prefix-length>

サブネットプールのデフォルト接頭辞長を設定します。

表63.19 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

63.5. subnet pool delete

サブネットプールを削除します。

使用方法

openstack subnet pool delete [-h] <subnet-pool> [<subnet-pool> ...]

表63.20 位置引数

概要

<subnet-pool>

削除するサブネットプール (名前または ID)

表63.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

63.6. subnet pool list

サブネットプールを一覧表示します。

使用方法

openstack subnet pool list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN] [--long]
                                  [--share | --no-share]
                                  [--default | --no-default]
                                  [--project <project>]
                                  [--project-domain <project-domain>]
                                  [--name <name>]
                                  [--address-scope <address-scope>]
                                  [--tags <tag>[,<tag>,...]]
                                  [--any-tags <tag>[,<tag>,...]]
                                  [--not-tags <tag>[,<tag>,...]]
                                  [--not-any-tags <tag>[,<tag>,...]]

表63.22 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表63.23 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表63.24 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表63.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表63.26 その他の引数 (オプション):

概要

--share

プロジェクト間で共有されるサブネットプールを一覧表示します。

--not-any-tags <tag>[,<tag>,…​]

指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたサブネットプールを除外します。

--name <name>

出力に、指定した名前のサブネットプールのみを一覧表示します。

--tags <tag>[,<tag>,…​]

指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたサブネットプールを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--any-tags <tag>[,<tag>,…​]

指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたサブネットプールを一覧表示します。

--address-scope <address-scope>

出力に、指定したアドレススコープのサブネットプールのみを一覧表示します (名前または ID)。

--no-share

プロジェクト間で共有されないサブネットプールを一覧表示します。

--not-tags <tag>[,<tag>,…​]

指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたサブネットプールを除外します。

--no-default

デフォルトの外部サブネットプールとして使用されないサブネットプールを一覧表示します。

--default

デフォルトの外部サブネットプールとして使用されるサブネットプールを一覧表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

プロジェクトに従ってサブネットプールを一覧表示します (名前または ID)。

63.7. subnet pool set

サブネットプールの属性を設定します。

使用方法

openstack subnet pool set [-h] [--name <name>]
                                 [--pool-prefix <pool-prefix>]
                                 [--default-prefix-length <default-prefix-length>]
                                 [--min-prefix-length <min-prefix-length>]
                                 [--max-prefix-length <max-prefix-length>]
                                 [--address-scope <address-scope> | --no-address-scope]
                                 [--default | --no-default]
                                 [--description <description>]
                                 [--default-quota <num-ip-addresses>]
                                 [--tag <tag>] [--no-tag]
                                 <subnet-pool>

表63.27 位置引数

概要

<subnet-pool>

変更するサブネットプール (名前または ID)

表63.28 その他の引数 (オプション):

概要

--no-address-scope

サブネットプールに関連付けられたアドレススコープを削除します。

--min-prefix-length <min-prefix-length>

サブネットプールの最小接頭辞長を設定します。

--no-tag

サブネットプールに関連付けられたタグを消去します。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。

--name <name>

サブネットプールの名前を設定します。

--default-quota <num-ip-addresses>

サブネットで許可されるip アドレスの数として、サブネットプールのデフォルトクォータを設定します。

--tag <tag>

サブネットプールに追加されるタグ (複数のタグを設定する場合はオプションを繰り返し使用します)

--address-scope <address-scope>

サブネットプールに関連付けられたアドレススコープを設定します (名前または ID)。接頭辞は、アドレススコープ全体で一意でなければなりません。

--max-prefix-length <max-prefix-length>

サブネットプールの最大接頭辞長を設定します。

--pool-prefix <pool-prefix>

サブネットプールの接頭辞 (cidr 表記) を設定します (複数の接頭辞を設定する場合はオプションを繰り返し使用します)。

--no-default

これをデフォルト以外のサブネットプールとして設定します。

--default

これをデフォルトのサブネットプールとして設定します。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

サブネットプールの説明を設定します。

--default-prefix-length <default-prefix-length>

サブネットプールのデフォルト接頭辞長を設定します。

63.8. subnet pool show

サブネットプールの詳細を表示します。

使用方法

openstack subnet pool show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  <subnet-pool>

表63.29 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表63.30 位置引数

概要

<subnet-pool>

表示するサブネットプール (名前または ID)

表63.31 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表63.32 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表63.33 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表63.34 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

63.9. subnet pool unset

サブネットプール属性の設定を解除します。

使用方法

openstack subnet pool unset [-h] [--pool-prefix <pool-prefix>]
                                   [--tag <tag> | --all-tag]
                                   <subnet-pool>

表63.35 位置引数

概要

<subnet-pool>

変更するサブネットプール (名前または ID)

表63.36 その他の引数 (オプション):

概要

--all-tag

サブネットプールに関連付けられたすべてのタグを消去します。

-h, --help

ヘルプメッセージを表示して終了します。

--pool-prefix <pool-prefix>

サブネットプールの接頭辞を削除します(cidr 表記)。(複数の接頭辞の設定を解除する場合はオプションを繰り返し使用します)。

--tag <tag>

サブネットプールから削除するタグ (複数のタグを削除する場合はオプションを繰り返し使用します)

63.10. subnet set

サブネットの属性を設定します。

使用方法

openstack subnet set [-h] [--name <name>] [--dhcp | --no-dhcp]
                            [--gateway <gateway>]
                            [--description <description>] [--tag <tag>]
                            [--no-tag]
                            [--allocation-pool start=<ip-address>,end=<ip-address>]
                            [--no-allocation-pool]
                            [--dns-nameserver <dns-nameserver>]
                            [--no-dns-nameservers]
                            [--host-route destination=<subnet>,gateway=<ip-address>]
                            [--no-host-route] [--service-type <service-type>]
                            <subnet>

表63.37 位置引数

概要

<subnet>

変更するサブネット (名前または ID)

表63.38 その他の引数 (オプション):

概要

--no-allocation-pool

サブネットから、関連付けられた割り当てプールを消去します。現在の割り当てプール情報を上書きするには、--allocation-pool と --no-allocation- pool の両方を指定します。

--no-dhcp

dhcp を無効にします。

--dhcp

dhcp を有効にします。

--allocation-pool start=<ip-address>,end=<ip-address>

このサブネットの割り当てプール IP アドレス (例:start=192.168.199.2,end=192.168.199.254)(複数の IP アドレスを追加する場合はオプションを繰り返し使用します)

--no-tag

サブネットに関連付けられたタグを消去します。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。

--name <name>

サブネットの更新された名前

--no-host-route

サブネットから関連するホストルートを消去します。現在のホストルート情報を上書きするには、--host-route と --no-host-route の両方を指定します。

--host-route destination=<subnet>,gateway=<ip-address>

このサブネットの追加のルート (例:destination=10.10.0.0/16,gateway=192.168.71.254、 destination: 宛先のサブネット (CIDR 表記)、gateway: 次のホップの IP アドレス)(複数のルートを追加する場合はオプションを繰り返し使用します)

--dns-nameserver <dns-nameserver>

このサブネットの DNS サーバー (複数の DNS サーバーを設定する場合はオプションを繰り返し使用します)

--gateway <gateway>

サブネットのゲートウェイを指定します。オプションは、<ip-address>: ゲートウェイとして使用する特定の IP アドレス、none: このサブネットはゲートウェイを使用しない、です (例:--gateway 192.168.9.1、--gateway none)。

--no-dns-nameservers

dns ネームサーバーの既存の情報を消去します。現在の DNS ネームサーバーの情報を上書きするには、--dns-nameserver と --no-dns-nameserver の両方を指定します。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

サブネットの説明を設定します。

--service-type <service-type>

このサブネットのサービス種別 (例:network:floatingip_agent_gateway)。ネットワークポートの有効なデバイス所有者の値でなければなりません (複数のサービス種別を設定する場合はオプションを繰り返し使用します)。

--tag <tag>

サブネットに追加されるタグ (複数のタグを設定する場合はオプションを繰り返し使用します)

63.11. subnet show

サブネットの詳細を表示します。

使用方法

openstack subnet show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             <subnet>

表63.39 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表63.40 位置引数

概要

<subnet>

表示するサブネット (名前または ID)

表63.41 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表63.42 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表63.43 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表63.44 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

63.12. subnet unset

サブネット属性の設定を解除します。

使用方法

openstack subnet unset [-h]
                              [--allocation-pool start=<ip-address>,end=<ip-address>]
                              [--dns-nameserver <dns-nameserver>]
                              [--host-route destination=<subnet>,gateway=<ip-address>]
                              [--service-type <service-type>]
                              [--tag <tag> | --all-tag]
                              <subnet>

表63.45 位置引数

概要

<subnet>

変更するサブネット (名前または ID)

表63.46 その他の引数 (オプション):

概要

--allocation-pool start=<ip-address>,end=<ip-address>

このサブネットから削除する割り当てプール IP アドレス (例:start=192.168.199.2,end=192.168.199.254)(複数の割り当てプールの設定を解除する場合はオプションを繰り返し使用します)

--host-route destination=<subnet>,gateway=<ip-address>

このサブネットから削除するルート (例:destination=10.10.0.0/16,gateway=192.168.71.254、 destination: 宛先のサブネット (CIDR 表記)、gateway: 次のホップの IP アドレス)(複数のホストルートの設定を解除する場合はオプションを繰り返し使用します)

--dns-nameserver <dns-nameserver>

このサブネットから削除する DNS サーバー (複数の DNS サーバーの設定を解除する場合はオプションを繰り返し使用します)

--all-tag

サブネットに関連付けられたすべてのタグを消去します。

-h, --help

ヘルプメッセージを表示して終了します。

--service-type <service-type>

このサブネットから削除するサービス種別 (例:network:floatingip_agent_gateway)。ネットワークポートの有効なデバイス所有者の値でなければなりません (複数のサービス種別の設定を解除する場合はオプションを繰り返し使用します)。

--tag <tag>

サブネットから削除するタグ (複数のタグを削除する場合はオプションを繰り返し使用します)

第64章 task

本章では、task コマンドに含まれるコマンドについて説明します。

64.1. task execution list

全タスクを一覧表示します。

使用方法

openstack task execution list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--filter FILTERS] [--limit [LIMIT]]
                                     [workflow_execution]

表64.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表64.2 位置引数

概要

workflow_execution

タスクの一覧に関連付けられたワークフロー実行 ID。

表64.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表64.4 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表64.5 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表64.6 その他の引数 (オプション):

概要

--filter FILTERS

フィルター。繰り返し使用できます。

-h, --help

ヘルプメッセージを表示して終了します。

--limit [LIMIT]

1 つの結果で返すタスクの最大数。制限はデフォルトで 100 に設定されます。--limit -1 を使用して完全な結果セットを取得します。

64.2. task execution published show

タスクが公開した変数を表示します。

使用方法

openstack task execution published show [-h] id

表64.7 位置引数

概要

id

タスク ID

表64.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

64.3. task execution rerun

既存タスクを再度実行します。

使用方法

openstack task execution rerun [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--resume] [-e ENV]
                                      id

表64.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表64.10 位置引数

概要

id

タスクの識別子

表64.11 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表64.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表64.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resume

with-items タスクで失敗または開始されていないアクション実行だけを再実行します。

-e ENV、--env ENV

環境変数

表64.14 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

64.4. task execution result show

タスクの出力データを表示します。

使用方法

openstack task execution result show [-h] id

表64.15 位置引数

概要

id

タスク ID

表64.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

64.5. task execution show

特定のタスクを表示します。

使用方法

openstack task execution show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     task

表64.17 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表64.18 位置引数

概要

task

タスクの識別子

表64.19 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表64.20 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表64.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表64.22 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第65章 tld

本章では、tld コマンドに含まれるコマンドについて説明します。

65.1. tld create

新規 tld を作成します。

使用方法

openstack tld create [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent] [--prefix PREFIX]
                            --name NAME [--description DESCRIPTION]
                            [--all-projects] [--edit-managed]
                            [--sudo-project-id SUDO_PROJECT_ID]

表65.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表65.2 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表65.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表65.4 その他の引数 (オプション):

概要

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--name NAME

TLD 名

--description DESCRIPTION

説明

-h, --help

ヘルプメッセージを表示して終了します。

表65.5 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

65.2. tld delete

tld を削除します。

使用方法

openstack tld delete [-h] [--all-projects] [--edit-managed]
                            [--sudo-project-id SUDO_PROJECT_ID]
                            id

表65.6 位置引数

概要

id

TLD id

表65.7 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

65.3. tld list

tld を一覧表示します。

使用方法

openstack tld list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                          [--max-width <integer>] [--fit-width]
                          [--print-empty] [--noindent]
                          [--quote {all,minimal,none,nonnumeric}]
                          [--sort-column SORT_COLUMN] [--name NAME]
                          [--description DESCRIPTION] [--all-projects]
                          [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]

表65.8 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表65.9 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表65.10 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表65.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表65.12 その他の引数 (オプション):

概要

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--name NAME

TLD 名

--description DESCRIPTION

TLD の説明

-h, --help

ヘルプメッセージを表示して終了します。

65.4. tld set

tld の属性を設定します。

使用方法

openstack tld set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                         [--max-width <integer>] [--fit-width] [--print-empty]
                         [--noindent] [--prefix PREFIX] [--name NAME]
                         [--description DESCRIPTION | --no-description]
                         [--all-projects] [--edit-managed]
                         [--sudo-project-id SUDO_PROJECT_ID]
                         id

表65.13 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表65.14 位置引数

概要

id

TLD id

表65.15 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表65.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表65.17 その他の引数 (オプション):

概要

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--name NAME

TLD 名

--description DESCRIPTION

説明

-h, --help

ヘルプメッセージを表示して終了します。

--no-description—​all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

表65.18 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

65.5. tld show

tld の詳細を表示します。

使用方法

openstack tld show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                          [--max-width <integer>] [--fit-width]
                          [--print-empty] [--noindent] [--prefix PREFIX]
                          [--all-projects] [--edit-managed]
                          [--sudo-project-id SUDO_PROJECT_ID]
                          id

表65.19 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表65.20 位置引数

概要

id

TLD id

表65.21 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表65.22 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表65.23 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表65.24 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第66章 token

本章では、token コマンドに含まれるコマンドについて説明します。

66.1. token issue

新しいトークンを発行します。

使用方法

openstack token issue [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]

表66.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表66.2 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表66.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表66.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表66.5 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

66.2. token revoke

既存のトークンを取り消します。

使用方法

openstack token revoke [-h] <token>

表66.6 位置引数

概要

<token>

削除するトークン

表66.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

第67章 tsigkey

本章では、tsigkey コマンドに含まれるコマンドについて説明します。

67.1. tsigkey create

新規 tsigkey を作成します。

使用方法

openstack tsigkey create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX] --name NAME --algorithm
                                ALGORITHM --secret SECRET --scope SCOPE
                                --resource-id RESOURCE_ID [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]

表67.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表67.2 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表67.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表67.4 その他の引数 (オプション):

概要

--resource-id RESOURCE_ID

Tsigkey のリソース id

--scope SCOPE

Tsigkey スコープ

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--algorithm ALGORITHM

Tsigkey アルゴリズム

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--secret SECRET

Tsigkey シークレット

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--name NAME

Tsigkey 名

-h, --help

ヘルプメッセージを表示して終了します。

表67.5 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

67.2. tsigkey delete

tsigkey を削除します。

使用方法

openstack tsigkey delete [-h] [--all-projects] [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                id

表67.6 位置引数

概要

id

Tsigkey id

表67.7 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

67.3. tsigkey list

tsigkey を一覧表示します。

使用方法

openstack tsigkey list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN] [--name NAME]
                              [--algorithm ALGORITHM] [--scope SCOPE]
                              [--all-projects] [--edit-managed]
                              [--sudo-project-id SUDO_PROJECT_ID]

表67.8 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表67.9 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表67.10 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表67.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表67.12 その他の引数 (オプション):

概要

--scope SCOPE

Tsigkey スコープ

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--algorithm ALGORITHM

Tsigkey アルゴリズム

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--name NAME

Tsigkey 名

-h, --help

ヘルプメッセージを表示して終了します。

67.4. tsigkey set

tsigkey の属性を設定します。

使用方法

openstack tsigkey set [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             [--name NAME] [--algorithm ALGORITHM]
                             [--secret SECRET] [--scope SCOPE]
                             [--all-projects] [--edit-managed]
                             [--sudo-project-id SUDO_PROJECT_ID]
                             id

表67.13 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表67.14 位置引数

概要

id

Tsigkey id

表67.15 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表67.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表67.17 その他の引数 (オプション):

概要

--scope SCOPE

Tsigkey スコープ

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--algorithm ALGORITHM

Tsigkey アルゴリズム

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--secret SECRET

Tsigkey シークレット

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--name NAME

Tsigkey 名

-h, --help

ヘルプメッセージを表示して終了します。

表67.18 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

67.5. tsigkey show

tsigkey の詳細を表示します。

使用方法

openstack tsigkey show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [--all-projects]
                              [--edit-managed]
                              [--sudo-project-id SUDO_PROJECT_ID]
                              id

表67.19 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表67.20 位置引数

概要

id

Tsigkey id

表67.21 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表67.22 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表67.23 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表67.24 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第68章 undercloud

本章では、undercloud コマンドに含まれるコマンドについて説明します。

68.1. undercloud backup

アンダークラウドのバックアップを作成します。

使用方法

openstack undercloud backup [--add-path ADD_PATH]
                                   [--exclude-path EXCLUDE_PATH]

表68.1 その他の引数 (オプション):

概要

--exclude-path EXCLUDE_PATH

アンダークラウドのバックアップを実行する際の除外パス。このオプションは複数回指定することができます。デフォルト:none (例: --exclude-path /this/is/a/folder/ --exclude-path /this/is/a/texfile.txt)

--add-path ADD_PATH

バックアップに追加のファイルを追加します。デフォルトは /home/stack/ です (例: --add-path /this/is/a/folder/ --add- path /this/is/a/texfile.txt)。

68.2. undercloud deploy

アンダークラウドのデプロイ(実験的機能)

使用方法

openstack undercloud deploy [--templates [TEMPLATES]] [--stack STACK]
                                   [--output-dir OUTPUT_DIR] [-t <TIMEOUT>]
                                   [-e <HEAT ENVIRONMENT FILE>]
                                   [--roles-file ROLES_FILE]
                                   [--heat-api-port <HEAT_API_PORT>]
                                   [--heat-user <HEAT_USER>]
                                   [--heat-container-image <HEAT_CONTAINER_IMAGE>]
                                   [--heat-native] [--local-ip <LOCAL_IP>]
                                   [--local-domain <LOCAL_DOMAIN>] [-k]

表68.2 その他の引数 (オプション):

概要

-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--local-domain <LOCAL_DOMAIN>

アンダークラウドとその API エンドポイントのローカルドメイン

-k, --keep-running

デバッグのために、プロセスを障害時に実行し続けます。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data_undercloud.yaml を上書きします。

--local-ip <LOCAL_IP>

アンダークラウドトラフィックのローカルの ip/cidr (必須)

--heat-container-image <HEAT_CONTAINER_IMAGE>

heat-all プロセスの起動時に使用するコンテナーイメージデフォルトは tripleomaster/centos-binary- heat-all です。

--stack STACK

作成するスタック名

--output-dir OUTPUT_DIR

状態と Ansible デプロイメントファイルを出力するディレクトリー。

-t <TIMEOUT>, --timeout <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--heat-api-port <HEAT_API_PORT>

インストーラーのプライベート heat API インスタンスに使用する heat api ポートオプション。デフォルト: 8006。

heat_native

このホストで heat-all プロセスをネイティブに実行します。このオプションは、heat-all バイナリーをこのマシンにローカルにインストールすることを要求します。このオプションはデフォルトで有効になっています。したがって、heat-all はホスト OS 上で直接実行されます。

--heat-user <HEAT_USER>

非特権 heat-all プロセスを実行するユーザー。デフォルトは heat です。

68.3. undercloud install

アンダークラウドをインストールおよび設定します。

使用方法

openstack undercloud install [--use-heat] [--no-validations]

表68.3 その他の引数 (オプション):

概要

--use-heat

heat を使用したアンダークラウドのデプロイの実行

--no-validations

アンダークラウド設定の検証を実行しません。

68.4. undercloud upgrade

アンダークラウドをアップグレードします。

使用方法

openstack undercloud upgrade [--use-heat] [--no-validations] [--force]

表68.4 その他の引数 (オプション):

概要

--use-heat

heat を使用したアンダークラウドのデプロイの実行

--no-validations

アンダークラウド設定の検証を実行しません。

--force

No to use in normal update/upgrade! This can get out an error when the overcloud is in in an error and it need it need to work again.

第69章 使用方法

本章では、usage コマンドに含まれるコマンドについて説明します。

69.1. usage list

プロジェクトごとのリソース使用状況を一覧表示します。

使用方法

openstack usage list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--sort-column SORT_COLUMN] [--start <start>]
                            [--end <end>]

表69.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表69.2 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表69.3 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表69.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表69.5 その他の引数 (オプション):

概要

--end <end>

使用範囲の終了日 (例:2012-01-20)(デフォルト: 明日)

-h, --help

ヘルプメッセージを表示して終了します。

--start <start>

使用範囲の開始日 (例:2012-01-20)(デフォルト:4 週間前)

69.2. usage show

単一プロジェクトのリソース使用状況を表示します。

使用方法

openstack usage show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent] [--prefix PREFIX]
                            [--project <project>] [--start <start>]
                            [--end <end>]

表69.6 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表69.7 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表69.8 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表69.9 その他の引数 (オプション):

概要

--end <end>

使用範囲の終了日 (例:2012-01-20)(デフォルト: 明日)

-h, --help

ヘルプメッセージを表示して終了します。

--start <start>

使用範囲の開始日 (例:2012-01-20)(デフォルト:4 週間前)

--project <project>

使用状況を表示するプロジェクトの名前または ID

表69.10 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第70章 user

本章では、user コマンドに含まれるコマンドについて説明します。

70.1. user create

新規ユーザーを作成します。

使用方法

openstack user create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             [--project <project>] [--password <password>]
                             [--password-prompt] [--email <email-address>]
                             [--enable | --disable] [--or-show]
                             <name>

表70.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表70.2 位置引数

概要

<name>

新しいユーザー名

表70.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表70.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表70.5 その他の引数 (オプション):

概要

--enable

ユーザーを有効にします (デフォルト)。

--or-show

既存ユーザーを返します。

--password <password>

ユーザーのパスワードを設定します。

--email <email-address>

ユーザーのメールアドレスを設定します。

--password-prompt

パスワードを対話的に要求します。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

ユーザーを無効にします。

--project <project>

デフォルトプロジェクト (名前または ID)

表70.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

70.2. user delete

ユーザーを削除します。

使用方法

openstack user delete [-h] <user> [<user> ...]

表70.7 位置引数

概要

<user>

削除するユーザー (名前または ID)

表70.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

70.3. user list

ユーザーを一覧表示します。

使用方法

openstack user list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--sort-column SORT_COLUMN] [--project <project>]
                           [--long]

表70.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表70.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表70.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表70.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表70.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

<project>でユーザーをフィルターします (名前または id)。

--long

出力の追加フィールドを一覧表示します。

70.4. user role list

ユーザーロールの割り当てを一覧表示します。

使用方法

openstack user role list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--sort-column SORT_COLUMN]
                                [--project <project>]
                                [<user>]

表70.14 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表70.15 位置引数

概要

<user>

一覧表示するユーザー(名前または ID)

表70.16 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表70.17 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表70.18 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表70.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

<project>でユーザーをフィルターします (名前または id)。

70.5. user set

ユーザーの属性を設定します。

使用方法

openstack user set [-h] [--name <name>] [--project <project>]
                          [--password <user-password>] [--password-prompt]
                          [--email <email-address>] [--enable | --disable]
                          <user>

表70.20 位置引数

概要

<user>

変更するユーザー (名前または ID)

表70.21 その他の引数 (オプション):

概要

--password <user-password>

ユーザーのパスワードを設定します。

--enable

ユーザーを有効にします (デフォルト)。

--name <name>

ユーザー名を設定します。

--email <email-address>

ユーザーのメールアドレスを設定します。

--password-prompt

パスワードを対話的に要求します。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

ユーザーを無効にします。

--project <project>

デフォルトプロジェクトを設定します (名前または ID)。

70.6. user show

ユーザーの詳細を表示します。

使用方法

openstack user show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent] [--prefix PREFIX]
                           <user>

表70.22 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表70.23 位置引数

概要

<user>

表示するユーザー (名前または ID)

表70.24 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表70.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表70.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表70.27 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第71章 volume

本章では、volume コマンドに含まれるコマンドについて説明します。

71.1. volume backup create

新しいボリュームのバックアップを作成します。

使用方法

openstack volume backup create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--name <name>]
                                      [--description <description>]
                                      [--container <container>]
                                      [--snapshot <snapshot>] [--force]
                                      [--incremental]
                                      <volume>

表71.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.2 位置引数

概要

<volume>

バックアップするボリューム (名前または ID)

表71.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.5 その他の引数 (オプション):

概要

--force

使用中のボリュームのバックアップを許可します。

--incremental

増分バックアップを実行します。

--name <name>

バックアップの名前

--container <container>

オプションのバックアップコンテナー名

--snapshot <snapshot>

バックアップするスナップショット (名前または ID)

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

バックアップの説明

表71.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

71.2. volume backup delete

ボリュームバックアップを削除します。

使用方法

openstack volume backup delete [-h] [--force] <backup> [<backup> ...]

表71.7 位置引数

概要

<backup>

削除するバックアップ (名前または ID)

表71.8 その他の引数 (オプション):

概要

--force

Error または available 以外の状態で削除を可能にします。

-h, --help

ヘルプメッセージを表示して終了します。

71.3. volume backup list

ボリュームのバックアップを一覧表示します。

使用方法

openstack volume backup list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN] [--long]
                                    [--name <name>] [--status <status>]
                                    [--volume <volume>]
                                    [--marker <volume-backup>]
                                    [--limit <num-backups>] [--all-projects]

表71.9 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表71.11 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表71.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.13 その他の引数 (オプション):

概要

--marker <volume-backup>

前のページにある最後のバックアップ (名前または ID)

--limit <num-backups>

表示するバックアップの最大数。

--all-projects

すべてのプロジェクトを含めます (管理者のみ)。

--volume <volume>

バックアップするボリュームで結果をフィルターリングします (名前または ID)。

--long

出力の追加フィールドを一覧表示します。

--status <status>

バックアップのステータス (creatingavailabledeletingerrorrestoring、または error_restoring) で結果をフィルターリングします。

--name <name>

バックアップ名で結果をフィルターリングします。

-h, --help

ヘルプメッセージを表示して終了します。

71.4. volume backup restore

ボリュームのバックアップを復元します。

使用方法

openstack volume backup restore [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       <backup> <volume>

表71.14 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.15 位置引数

概要

<volume>

復元先のボリューム (名前または ID)

<backup>

復元するバックアップ (名前または ID)

表71.16 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表71.19 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

71.5. volume backup set

ボリュームのバックアップの属性を設定します。

使用方法

openstack volume backup set [-h] [--name <name>]
                                   [--description <description>]
                                   [--state <state>]
                                   <backup>

表71.20 位置引数

概要

<backup>

変更するバックアップ (名前または ID)

表71.21 その他の引数 (オプション):

概要

--name <name>

新しいバックアップ名

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

新しいバックアップの説明

--state <state>

新しいバックアップの状態 ("available" または "error")(管理者のみ)(このオプションは、実際のステータスに関係なくデータベースのバックアップの状態を変更するだけで、使用時には注意が必要です)

71.6. volume backup show

ボリュームのバックアップの詳細を表示します。

使用方法

openstack volume backup show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    <backup>

表71.22 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.23 位置引数

概要

<backup>

表示するバックアップ (名前または ID)

表71.24 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表71.27 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

71.7. volume create

新規ボリュームを作成します。

使用方法

openstack volume create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] [--size <size>]
                               [--type <volume-type>]
                               [--image <image> | --snapshot <snapshot> | --source <volume> | --source-replicated <replicated-volume>]
                               [--description <description>] [--user <user>]
                               [--project <project>]
                               [--availability-zone <availability-zone>]
                               [--consistency-group consistency-group>]
                               [--property <key=value>] [--hint <key=value>]
                               [--multi-attach] [--bootable | --non-bootable]
                               [--read-only | --read-write]
                               <name>

表71.28 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.29 位置引数

概要

<name>

ボリューム名

表71.30 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.31 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.32 その他の引数 (オプション):

概要

--property <key=value>

このボリュームに属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します)

--bootable

ボリュームをブート可能としてマークします。

--non-bootable

ボリュームをブート不可としてマークします (デフォルト)。

--type <volume-type>

ボリュームの種別を設定します。

--availability-zone <availability-zone>

<availability-zone> にボリュームを作成します。

--read-only

volume を読み取り専用モードに設定します。

--consistency-group consistency-group>

新しいボリュームが属する整合性グループ

--size <size>

GB 単位のボリュームサイズ(--snapshot または --source または --source-replicated が指定されていない場合必要)

--hint <key=value>

インスタンスのブートに役立つ任意のスケジューラーヒントのキーと値のペア (複数のヒントを設定する場合はオプションを繰り返し使用します)

--multi-attach

ボリュームを複数接続できるようにします(デフォルトは False)。

--read-write

volume を読み取り/書き込みアクセスモードに設定します (デフォルト)。

--image <image>

<image> をボリュームのソースとして使用します (名前または ID)。

--source <volume>

クローンを作成するボリューム (名前または ID)

--user <user>

代替ユーザー(名前または ID)を指定します。

--snapshot <snapshot>

<snapshot> をボリュームのソースとして使用します (名前または ID)。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ボリュームの説明

--project <project>

別のプロジェクトを指定します(名前または ID)。

--source-replicated <replicated-volume>

クローンを作成する複製ボリューム(名前または ID)

表71.33 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

71.8. volume delete

ボリュームを削除します。

使用方法

openstack volume delete [-h] [--force | --purge]
                               <volume> [<volume> ...]

表71.34 位置引数

概要

<volume>

削除するボリューム (名前または ID)

表71.35 その他の引数 (オプション):

概要

--force

状態に関係なく、ボリュームを強制的に削除しようとします (デフォルトは False)。

-h, --help

ヘルプメッセージを表示して終了します。

--purge

ボリュームと共にすべてのスナップショットを削除します (デフォルトは false)。

71.9. ボリュームホストのフェイルオーバー

異なるバックエンドへのボリュームホストのフェイルオーバー

使用方法

openstack volume host failover [-h] --volume-backend <backend-id>
                                      <host-name>

表71.36 位置引数

概要

<host-name>

ボリュームホスト名

表71.37 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--volume-backend <backend-id>

ホストがフェイルオーバーするボリュームバックエンドレプリケーションターゲットの ID (必須)

71.10. volume host set

ボリュームのホストの属性を設定します。

使用方法

openstack volume host set [-h] [--disable | --enable] <host-name>

表71.38 位置引数

概要

<host-name>

ボリュームホスト名

表71.39 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--disable

指定したボリュームホストをフリーズおよび無効化します。

--enable

指定されたボリュームホストをフリーズ解除および有効化します。

71.11. volume list

ボリュームを一覧表示します。

使用方法

openstack volume list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--project <project>]
                             [--project-domain <project-domain>]
                             [--user <user>] [--user-domain <user-domain>]
                             [--name <name>] [--status <status>]
                             [--all-projects] [--long] [--marker <volume>]
                             [--limit <num-volumes>]

表71.40 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.41 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表71.42 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表71.43 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.44 その他の引数 (オプション):

概要

--limit <num-volumes>

表示するボリュームの最大数。

--name <name>

ボリューム名で結果をフィルターリングします。

--all-projects

すべてのプロジェクトを含めます (管理者のみ)。

--user <user>

ユーザー (名前または ID) で結果をフィルターします (管理者のみ)。

--long

出力の追加フィールドを一覧表示します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--status <status>

ステータスで結果をフィルターリングします。

--marker <volume>

前のページにある最後のボリューム ID

--user-domain <user-domain>

ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

プロジェクト (名前または ID) で結果をフィルターします (管理者のみ)。

71.12. volume migrate

新規ホストにボリュームを移行します。

使用方法

openstack volume migrate [-h] --host <host> [--force-host-copy]
                                [--lock-volume | --unlock-volume]
                                <volume>

表71.45 位置引数

概要

<volume>

移行するボリューム (名前または ID)

表71.46 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--lock-volume

指定されている場合には、ボリュームの状態がロックされ、(別の操作で) 移行が中断されなくなります。

--host <host>

移行先ホスト (形式:host@backend-name#pool)

--unlock-volume

指定されている場合、ボリュームの状態はロックされず、移行を中断(デフォルト)できます(別の操作による可能性があります)。

--force-host-copy

汎用のホストベースの強制移行を有効にし、ドライバーの最適化をバイパスします。

71.13. volume qos associate

QoS 仕様をボリューム種別に関連付けます。

使用方法

openstack volume qos associate [-h] <qos-spec> <volume-type>

表71.47 位置引数

概要

<volume-type>

qos を関連付けるボリューム種別 (名前または id)

<qos-spec>

変更する QoS 仕様 (名前または ID)

表71.48 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

71.14. volume qos create

新規 QoS 仕様を作成します。

使用方法

openstack volume qos create [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX] [--consumer <consumer>]
                                   [--property <key=value>]
                                   <name>

表71.49 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.50 位置引数

概要

<name>

新しい qos 仕様の名前

表71.51 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.52 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.53 その他の引数 (オプション):

概要

--consumer <consumer>

qos のコンシューマー。有効なコンシューマー:back-end、both、front-end (デフォルトは both)

-h, --help

ヘルプメッセージを表示して終了します。

--property <key=value>

qos 仕様の属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します)

表71.54 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

71.15. volume qos delete

QoS 仕様を削除します。

使用方法

openstack volume qos delete [-h] [--force] <qos-spec> [<qos-spec> ...]

表71.55 位置引数

概要

<qos-spec>

削除する QoS 仕様 (名前または ID)

表71.56 その他の引数 (オプション):

概要

--force

使用中の qos 仕様の削除を許可します。

-h, --help

ヘルプメッセージを表示して終了します。

71.16. volume qos disassociate

ボリューム種別から QoS 仕様の関連付けを解除します。

使用方法

openstack volume qos disassociate [-h]
                                         [--volume-type <volume-type> | --all]
                                         <qos-spec>

表71.57 位置引数

概要

<qos-spec>

変更する QoS 仕様 (名前または ID)

表71.58 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--volume-type <volume-type>

qos の関連付けを解除するボリューム種別 (名前または ID)

--all

すべてのボリューム種別から qos の関連付けを解除します。

71.17. volume qos list

QoS 仕様の一覧を表示します。

使用方法

openstack volume qos list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN]

表71.59 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.60 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表71.61 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表71.62 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.63 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

71.18. volume qos set

QoS 仕様の属性を設定します。

使用方法

openstack volume qos set [-h] [--property <key=value>] <qos-spec>

表71.64 位置引数

概要

<qos-spec>

変更する QoS 仕様 (名前または ID)

表71.65 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key=value>

この qos 仕様に追加または変更する属性 (複数の属性を設定する場合はオプションを繰り返し使用します)

71.19. volume qos show

QoS 仕様の詳細を表示します。

使用方法

openstack volume qos show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX]
                                 <qos-spec>

表71.66 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.67 位置引数

概要

<qos-spec>

表示する QoS 仕様 (名前または ID)

表71.68 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.69 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.70 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表71.71 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

71.20. volume qos unset

QoS 仕様の属性の設定を解除します。

使用方法

openstack volume qos unset [-h] [--property <key>] <qos-spec>

表71.72 位置引数

概要

<qos-spec>

変更する QoS 仕様 (名前または ID)

表71.73 その他の引数 (オプション):

概要

--property <key>

qos 使用から削除する属性 (複数属性の設定を解除する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

71.21. volume service list

サービスを一覧表示するコマンド

使用方法

openstack volume service list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--host <host>] [--service <service>]
                                     [--long]

表71.74 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.75 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表71.76 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表71.77 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.78 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--host <host>

指定したホストでサービスを一覧表示します (名前のみ)。

--long

出力の追加フィールドを一覧表示します。

--service <service>

指定されたサービスのみを一覧表示します (名前のみ)。

71.22. volume service set

ボリュームサービスの属性を設定します。

使用方法

openstack volume service set [-h] [--enable | --disable]
                                    [--disable-reason <reason>]
                                    <host> <service>

表71.79 位置引数

概要

<service>

サービスの名前 (バイナリー名)

<host>

ホスト名

表71.80 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--disable

ボリュームサービスを無効にします。

--disable-reason <reason>

サービスを無効にする理由。--disable オプションと併用する必要があります。

--enable

ボリュームサービスを有効にします。

71.23. volume set

ボリュームの属性を設定します。

使用方法

openstack volume set [-h] [--name <name>] [--size <size>]
                            [--description <description>] [--no-property]
                            [--property <key=value>]
                            [--image-property <key=value>] [--state <state>]
                            [--type <volume-type>]
                            [--retype-policy <retype-policy>]
                            [--bootable | --non-bootable]
                            [--read-only | --read-write]
                            <volume>

表71.81 位置引数

概要

<volume>

変更するボリューム (名前または ID)

表71.82 その他の引数 (オプション):

概要

--bootable

ボリュームをブート可能としてマークします。

--non-bootable

ボリュームをブート不可としてマークします。

--state <state>

新しいボリュームの状態 ("available"、"error"、"creating"、"deleting"、"in-use"、"attaching"、"detaching"、"error_deleting"、または "maintenance") (管理者のみ) (このオプションは、実際のステータスに関係なくデータベースのボリュームの状態を変更するだけで、使用時には注意が必要です)

--name <name>

新規ボリューム名

--property <key=value>

このボリュームに属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します)

--size <size>

ボリュームサイズを拡張します (gb 単位)

--read-only

volume を読み取り専用モードに設定します。

--read-write

volume を読み取り/書き込みアクセスモードに設定します。

--no-property

<volume>からすべての属性を削除します (新しい属性を設定する前に現在の属性を削除するには --no-property と --property の両方を指定します)。

--type <volume-type>

新規ボリューム種別 (名前または ID)

--image-property <key=value>

このボリュームにイメージ属性を設定します (複数のイメージ属性を設定する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

新規ボリュームの説明

--retype-policy <retype-policy>

ボリューム種別の変更中の移行ポリシー (never または on-demand、デフォルトは never)(--type オプションが指定されている場合にのみ利用可能)

71.24. volume show

ボリュームの詳細を表示します。

使用方法

openstack volume show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             <volume>

表71.83 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.84 位置引数

概要

<volume>

表示するボリューム (名前または ID)

表71.85 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.86 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.87 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表71.88 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

71.25. volume snapshot create

新規ボリュームスナップショットを作成します。

使用方法

openstack volume snapshot create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--volume <volume>]
                                        [--description <description>]
                                        [--force] [--property <key=value>]
                                        [--remote-source <key=value>]
                                        <snapshot-name>

表71.89 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.90 位置引数

概要

<snapshot-name>

新規スナップショットの名前

表71.91 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.92 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.93 その他の引数 (オプション):

概要

--force

インスタンスに割り当てられているスナップショットを作成します。デフォルトは False です。

--volume <volume>

スナップショットを作成するボリューム (名前または id)(デフォルトは <snapshot- name>)

--property <key=value>

属性をこのスナップショットに設定します (複数の属性を設定する場合はオプションを繰り返し使用します)。

--remote-source <key=value>

既存のリモートボリュームスナップショットの属性 (管理者が必要)(複数属性を指定する場合はオプションを繰り返し使用します)(例: --remote-source source- name=test_name --remote-source source-id=test_id)

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

スナップショットの説明

表71.94 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

71.26. volume snapshot delete

ボリュームスナップショットを削除します。

使用方法

openstack volume snapshot delete [-h] [--force]
                                        <snapshot> [<snapshot> ...]

表71.95 位置引数

概要

<snapshot>

削除するスナップショット (名前または ID)

表71.96 その他の引数 (オプション):

概要

--force

状態に関係なく、スナップショットの強制的な削除を試行します (デフォルトは False)。

-h, --help

ヘルプメッセージを表示して終了します。

71.27. volume snapshot list

ボリュームスナップショットの一覧を表示します。

使用方法

openstack volume snapshot list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--all-projects] [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--long] [--marker <volume-snapshot>]
                                      [--limit <num-snapshots>]
                                      [--name <name>] [--status <status>]
                                      [--volume <volume>]

表71.97 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.98 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表71.99 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表71.100 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.101 その他の引数 (オプション):

概要

--status <status>

ステータス (availableerrorcreatingdeleting、または error-deleting) で結果をフィルターリングします。

--all-projects

すべてのプロジェクトを含めます (管理者のみ)。

--name <name>

名前で結果をフィルターリングします。

--long

出力の追加フィールドを一覧表示します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--marker <volume-snapshot>

前のページにある最後のスナップショット ID

--limit <num-snapshots>

表示するスナップショットの最大数。

--volume <volume>

ボリュームで結果をフィルターリングします (名前または ID)。

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

プロジェクト (名前または ID) で結果をフィルターします (管理者のみ)。

71.28. volume snapshot set

ボリュームスナップショットの属性を設定します。

使用方法

openstack volume snapshot set [-h] [--name <name>]
                                     [--description <description>]
                                     [--no-property] [--property <key=value>]
                                     [--state <state>]
                                     <snapshot>

表71.102 位置引数

概要

<snapshot>

変更するスナップショット (名前または ID)

表71.103 その他の引数 (オプション):

概要

--name <name>

新しいスナップショット名

--property <key=value>

このスナップショットに追加/変更する属性 (複数の属性を設定する場合はオプションを繰り返し使用します)

--state <state>

新しいボリュームの状態 ("available"、"error"、"creating"、"deleting"、または "error_deleting") (管理者のみ) (このオプションは、実際のステータスに関係なくデータベースのスナップショットの状態を変更するだけで、使用時には注意が必要です)

--no-property

<snapshot>からすべての属性を削除します (新しい属性を設定する前に現在の属性を削除するには --no-property と --property の両方を指定します)。

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

新しいスナップショットの説明

71.29. volume snapshot show

ボリュームスナップショットの詳細を表示します。

使用方法

openstack volume snapshot show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      <snapshot>

表71.104 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.105 位置引数

概要

<snapshot>

表示するスナップショット (名前または ID)

表71.106 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.107 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.108 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表71.109 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

71.30. volume snapshot unset

ボリュームスナップショット属性の設定を解除します。

使用方法

openstack volume snapshot unset [-h] [--property <key>] <snapshot>

表71.110 位置引数

概要

<snapshot>

変更するスナップショット (名前または ID)

表71.111 その他の引数 (オプション):

概要

--property <key>

スナップショットから削除する属性 (複数の属性を削除する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

71.31. volume transfer request accept

ボリュームの譲渡要求を受け入れます。

使用方法

openstack volume transfer request accept [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                [--auth-key <key>]
                                                <transfer-request-id>

表71.112 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.113 位置引数

概要

<transfer-request-id>

受け入れるボリュームの譲渡要求 (id のみ)

表71.114 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.115 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.116 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--auth-key <key>

ボリュームの転送要求の認証キー

表71.117 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

71.32. volume transfer request create

ボリュームの譲渡要求を作成します。

使用方法

openstack volume transfer request create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                [--name <name>]
                                                <volume>

表71.118 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.119 位置引数

概要

<volume>

譲渡するボリューム (名前または ID)

表71.120 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.121 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.122 その他の引数 (オプション):

概要

--name <name>

新規譲渡要求の名前 (デフォルトは none)

-h, --help

ヘルプメッセージを表示して終了します。

表71.123 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

71.33. volume transfer request delete

ボリュームの譲渡要求を削除します。

使用方法

openstack volume transfer request delete [-h]
                                                <transfer-request>
                                                [<transfer-request> ...]

表71.124 位置引数

概要

<transfer-request>

削除するボリュームの譲渡要求 (名前または ID)

表71.125 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

71.34. volume transfer request list

すべてのボリュームの譲渡要求を一覧表示します。

使用方法

openstack volume transfer request list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]
                                              [--all-projects]

表71.126 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.127 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表71.128 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表71.129 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.130 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトを含めます (管理者のみ)。

-h, --help

ヘルプメッセージを表示して終了します。

71.35. volume transfer request show

ボリュームの譲渡要求の詳細を表示します。

使用方法

openstack volume transfer request show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              <transfer-request>

表71.131 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.132 位置引数

概要

<transfer-request>

表示するボリュームの譲渡要求 (名前または ID)

表71.133 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.134 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.135 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表71.136 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

71.36. volume type create

新規ボリューム種別を作成します。

使用方法

openstack volume type create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    [--description <description>]
                                    [--public | --private]
                                    [--property <key=value>]
                                    [--project <project>]
                                    [--encryption-provider <provider>]
                                    [--encryption-cipher <cipher>]
                                    [--encryption-key-size <key-size>]
                                    [--encryption-control-location <control-location>]
                                    [--project-domain <project-domain>]
                                    <name>

表71.137 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.138 位置引数

概要

<name>

ボリューム種別名

表71.139 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.140 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.141 その他の引数 (オプション):

概要

--public

ボリューム種別にパブリックからアクセスできる。

--private

ボリューム種別にパブリックからアクセスできない。

--encryption-key-size <key-size>

このボリューム種別の暗号化キーのサイズを設定します (例:128 または 256)。(管理者のみ)

--property <key=value>

このボリューム種別に属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します)

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--encryption-control-location <control-location>

暗号化が実施される想定サービス ("front-end" または "back-end") を設定します (管理者のみ)。(ボリュームの暗号化種別を設定する際のこのオプションのデフォルト値は、"front-end"です。--encryption- cipher、--encryption-key-size、および--encryption- provider などの他の暗号化オプションの使用を検討してください。)

--encryption-provider <provider>

このボリューム種別の暗号化サポートを提供するクラス(例:LuksEncryptor)を設定します(このオプションは、ボリュームの暗号化タイプを設定する場合に必要です)。--encryption-cipher、--encryption- key-size、および--encryption-control-location などの他の暗号化オプションの使用を検討してください。

--encryption-cipher <cipher>

このボリューム種別の暗号化アルゴリズムまたはモードを設定します (例:aes-xts-plain64)。(管理者のみ)

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ボリューム種別の説明

--project <project>

<project>(名前または ID) がプライベート種別にアクセスできるようにします (--private オプションと併せて使用する必要があります)。

表71.142 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

71.37. volume type delete

ボリューム種別を削除します。

使用方法

openstack volume type delete [-h] <volume-type> [<volume-type> ...]

表71.143 位置引数

概要

<volume-type>

削除するボリューム種別 (名前または ID)

表71.144 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

71.38. volume type list

ボリューム種別を一覧表示します。

使用方法

openstack volume type list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN] [--long]
                                  [--default | --public | --private]
                                  [--encryption-type]

表71.145 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.146 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表71.147 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表71.148 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.149 その他の引数 (オプション):

概要

--public

パブリック種別のみを一覧表示します。

--private

プライベート種別のみを一覧表示します (管理者のみ)。

--long

出力の追加フィールドを一覧表示します。

--default

デフォルトのボリューム種別を一覧表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--encryption-type

各ボリューム種別の暗号化情報を表示します (管理者のみ)。

71.39. volume type set

ボリューム種別の属性を設定します。

使用方法

openstack volume type set [-h] [--name <name>]
                                 [--description <description>]
                                 [--property <key=value>]
                                 [--project <project>]
                                 [--project-domain <project-domain>]
                                 [--encryption-provider <provider>]
                                 [--encryption-cipher <cipher>]
                                 [--encryption-key-size <key-size>]
                                 [--encryption-control-location <control-location>]
                                 <volume-type>

表71.150 位置引数

概要

<volume-type>

変更するボリューム種別 (名前または ID)

表71.151 その他の引数 (オプション):

概要

--encryption-key-size <key-size>

このボリューム種別の暗号化キーのサイズを設定します (例:128 または 256)。(管理者のみ)

--name <name>

ボリューム種別名を設定します。

--property <key=value>

このボリューム種別に属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します)

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--encryption-control-location <control-location>

暗号化が実施される想定サービス ("front-end" または "back-end") を設定します (管理者のみ)。(ボリュームの暗号化種別を初めて設定する際のこのオプションのデフォルト値は、"front-end"です。--encryption-cipher、--encryption-key-size、および-- encryption-provider などの他の暗号化オプションの使用を検討してください。)

--encryption-provider <provider>

このボリューム種別の暗号化サポートを提供するクラス(例:LuksEncryptor)(管理者のみ)を設定します(このオプションは、ボリュームの暗号化タイプを初めて設定する際に必要です)。--encryption-cipher、--encryption- key-size、および--encryption-control-location などの他の暗号化オプションの使用を検討してください。

--encryption-cipher <cipher>

このボリューム種別の暗号化アルゴリズムまたはモードを設定します (例:aes-xts-plain64)。(管理者のみ)

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ボリューム種別の説明を設定します。

--project <project>

プロジェクト (名前または ID) へのボリューム種別アクセスを設定します (管理者のみ)。

71.40. volume type show

ボリューム種別の詳細を表示します。

使用方法

openstack volume type show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX] [--encryption-type]
                                  <volume-type>

表71.152 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表71.153 位置引数

概要

<volume-type>

表示するボリューム種別 (名前または ID)

表71.154 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.155 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.156 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--encryption-type

このボリューム種別の暗号化情報を表示します (管理者のみ)。

表71.157 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

71.41. volume type unset

ボリューム種別の属性の設定を解除します。

使用方法

openstack volume type unset [-h] [--property <key>]
                                   [--project <project>]
                                   [--project-domain <project-domain>]
                                   [--encryption-type]
                                   <volume-type>

表71.158 位置引数

概要

<volume-type>

変更するボリューム種別 (名前または ID)

表71.159 その他の引数 (オプション):

概要

--property <key>

このボリューム種別から属性を削除します (複数の属性を削除する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

--encryption-type

このボリューム種別の暗号化種別を削除します (管理者のみ)。

--project <project>

プロジェクト (名前または ID) へのボリューム種別アクセスを削除します (管理者のみ)。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

71.42. volume unset

ボリューム属性の設定を解除します。

使用方法

openstack volume unset [-h] [--property <key>] [--image-property <key>]
                              <volume>

表71.160 位置引数

概要

<volume>

変更するボリューム (名前または ID)

表71.161 その他の引数 (オプション):

概要

--property <key>

ボリュームから属性を削除します (複数の属性を削除する場合はオプションを繰り返し使用します)

-h, --help

ヘルプメッセージを表示して終了します。

--image-property <key>

ボリュームからイメージ属性を削除します (複数のイメージ属性を削除する場合はオプションを繰り返し使用します)

第72章 workbook

本章では、workbook コマンドに含まれるコマンドについて説明します。

72.1. workbook create

新規のワークブックを作成します。

使用方法

openstack workbook create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX]
                                 definition

表72.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表72.2 位置引数

概要

定義

ワークブックの定義ファイル

表72.3 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表72.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表72.6 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

72.2. workbook definition show

ワークブックの定義を表示します。

使用方法

openstack workbook definition show [-h] name

表72.7 位置引数

概要

name

ワークブック名

表72.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.3. workbook delete

ワークブックを削除します。

使用方法

openstack workbook delete [-h] workbook [workbook ...]

表72.9 位置引数

概要

workbook

ワークブックの名前。

表72.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.4. workbook list

すべてのワークブックを一覧表示します。

使用方法

openstack workbook list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--sort-column SORT_COLUMN]

表72.11 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表72.12 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表72.13 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表72.14 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.5. workbook show

特定のワークブックを表示します。

使用方法

openstack workbook show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]
                               workbook

表72.16 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表72.17 位置引数

概要

workbook

ワークブック名

表72.18 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表72.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表72.21 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

72.6. workbook update

ワークブックを更新します。

使用方法

openstack workbook update [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX]
                                 definition

表72.22 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表72.23 位置引数

概要

定義

ワークブックの定義ファイル

表72.24 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表72.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表72.27 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

72.7. workbook validate

ワークブックを検証します。

使用方法

openstack workbook validate [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   definition

表72.28 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表72.29 位置引数

概要

定義

ワークブックの定義ファイル

表72.30 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表72.31 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.32 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表72.33 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第73章 workflow

本章では、workflow コマンドに含まれるコマンドについて説明します。

73.1. workflow create

新規ワークフローを作成します。

使用方法

openstack workflow create [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN]
                                 [--namespace [NAMESPACE]] [--public]
                                 definition

表73.1 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表73.2 位置引数

概要

定義

ワークフローの定義ファイル。

表73.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表73.4 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表73.5 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.6 その他の引数 (オプション):

概要

--namespace [NAMESPACE]

ワークフローを作成する名前空間

-h, --help

ヘルプメッセージを表示して終了します。

--public

このフラグを使用した場合には、ワークフローにはパブリックのマークが付けられます。

73.2. workflow definition show

ワークフローの定義を表示します。

使用方法

openstack workflow definition show [-h] identifier

表73.7 位置引数

概要

identifier

ワークフローの ID または名前。

表73.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

73.3. workflow delete

ワークフローを削除します。

使用方法

openstack workflow delete [-h] [--namespace [NAMESPACE]]
                                 workflow [workflow ...]

表73.9 位置引数

概要

workflow

ワークフローの名前または ID。

表73.10 その他の引数 (オプション):

概要

--namespace [NAMESPACE]

ワークフロー実行一覧に関連付けられた親タスク実行 ID。

-h, --help

ヘルプメッセージを表示して終了します。

73.4. workflow engine service list

全サービスを一覧表示します。

使用方法

openstack workflow engine service list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]

表73.11 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表73.12 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表73.13 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表73.14 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

73.5. workflow env create

新規環境を作成します。

使用方法

openstack workflow env create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     file

表73.16 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表73.17 位置引数

概要

file

json または yaml の環境設定ファイル

表73.18 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表73.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表73.21 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

73.6. workflow env delete

環境を削除します。

使用方法

openstack workflow env delete [-h] environment [environment ...]

表73.22 位置引数

概要

environment

環境の名前

表73.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

73.7. workflow env list

すべての環境を一覧表示します。

使用方法

openstack workflow env list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN]

表73.24 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表73.25 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表73.26 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表73.27 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

73.8. workflow env show

特定の環境を表示します。

使用方法

openstack workflow env show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   environment

表73.29 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表73.30 位置引数

概要

environment

環境名

表73.31 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表73.32 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.33 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表73.34 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

73.9. workflow env update

環境を更新します。

使用方法

openstack workflow env update [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     file

表73.35 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表73.36 位置引数

概要

file

json または yaml の環境設定ファイル

表73.37 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表73.38 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.39 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表73.40 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

73.10. workflow execution create

新規実行を作成します。

使用方法

openstack workflow execution create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--namespace [NAMESPACE]]
                                           [-d DESCRIPTION]
                                           [-s [SOURCE_EXECUTION_ID]]
                                           [workflow_identifier]
                                           [workflow_input] [params]

表73.41 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表73.42 位置引数

概要

workflow_input

ワークフロー入力

params

ワークフローの追加パラメーター

workflow_identifier

ワークフローの ID または名前。ワークフロー名は、Mitaka 以降は非推奨になります。

表73.43 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表73.44 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.45 その他の引数 (オプション):

概要

--namespace [NAMESPACE]

ワークフローの名前空間。

-h, --help

ヘルプメッセージを表示して終了します。

-d DESCRIPTION、--description DESCRIPTION

実行の説明

-s [SOURCE_EXECUTION_ID]

ワークフローの実行 ID。これにより、オペレーターは以前に正常に実行されたワークフローに基づいて新しいワークフロー実行を作成できます。例:mistral execution-create -s 123e4567-e89b-12d3-a456-426655440000

表73.46 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

73.11. workflow execution delete

実行を削除します。

使用方法

openstack workflow execution delete [-h] execution [execution ...]

表73.47 位置引数

概要

execution

実行識別子の ID。

表73.48 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

73.12. workflow execution input show

実行の入力データを表示します。

使用方法

openstack workflow execution input show [-h] id

表73.49 位置引数

概要

id

実行 ID

表73.50 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

73.13. workflow execution list

すべての実行を一覧表示します。

使用方法

openstack workflow execution list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         [--task [TASK]] [--marker [MARKER]]
                                         [--limit [LIMIT]]
                                         [--sort_keys [SORT_KEYS]]
                                         [--sort_dirs [SORT_DIRS]]
                                         [--filter FILTERS]

表73.51 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表73.52 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表73.53 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表73.54 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.55 その他の引数 (オプション):

概要

--marker [MARKER]

前のページで最後に実行した UUID。マーカーの後の実行を一覧表示します。

--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

--limit [LIMIT]

単一の結果で返す実行の最大数。制限はデフォルトで 100 に設定されます。--limit -1 を使用して完全な結果セットを取得します。

--filter FILTERS

フィルター。繰り返し使用できます。

-h, --help

ヘルプメッセージを表示して終了します。

--task [TASK]

ワークフロー実行一覧に関連付けられた親タスク実行 ID。

73.14. workflow execution output show

実行の出力データを表示します。

使用方法

openstack workflow execution output show [-h] id

表73.56 位置引数

概要

id

実行 ID

表73.57 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

73.15. workflow execution show

特定の実行を表示します。

使用方法

openstack workflow execution show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         execution

表73.58 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表73.59 位置引数

概要

execution

実行の識別子

表73.60 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表73.61 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.62 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表73.63 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

73.16. workflow execution update

実行を更新します。

使用方法

openstack workflow execution update [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}]
                                           [-e ENV] [-d DESCRIPTION]
                                           id

表73.64 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表73.65 位置引数

概要

id

実行の識別子

表73.66 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表73.67 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.68 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-d DESCRIPTION、--description DESCRIPTION

実行の説明

-e ENV、--env ENV

環境変数

-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}、--state {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}

実行の状態

表73.69 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

73.17. workflow list

すべてのワークフローを一覧表示します。

使用方法

openstack workflow list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--sort-column SORT_COLUMN] [--filter FILTERS]

表73.70 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表73.71 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表73.72 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表73.73 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.74 その他の引数 (オプション):

概要

--filter FILTERS

フィルター。繰り返し使用できます。

-h, --help

ヘルプメッセージを表示して終了します。

73.18. workflow show

特定のワークフローを表示します。

使用方法

openstack workflow show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]
                               workflow

表73.75 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表73.76 位置引数

概要

workflow

ワークフローの ID または名前。

表73.77 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表73.78 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.79 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表73.80 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

73.19. workflow update

ワークフローを更新します。

使用方法

openstack workflow update [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN] [--id ID]
                                 [--namespace [NAMESPACE]] [--public]
                                 definition

表73.81 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表73.82 位置引数

概要

定義

ワークフローの定義

表73.83 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表73.84 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表73.85 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.86 その他の引数 (オプション):

概要

--namespace [NAMESPACE]

ワークフロー実行一覧に関連付けられた親タスク実行 ID。

-h, --help

ヘルプメッセージを表示して終了します。

--id ID

ワークフローの ID

--public

このフラグを使用した場合には、ワークフローにはパブリックのマークが付けられます。

73.20. workflow validate

ワークフローを検証します。

使用方法

openstack workflow validate [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   definition

表73.87 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表73.88 位置引数

概要

定義

ワークフローの定義ファイル

表73.89 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表73.90 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.91 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表73.92 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第74章 zone

本章では、zone コマンドに含まれるコマンドについて説明します。

74.1. zone abandon

ゾーンを破棄します。

使用方法

openstack zone abandon [-h] [--all-projects] [--edit-managed]
                              [--sudo-project-id SUDO_PROJECT_ID]
                              id

表74.1 位置引数

概要

id

ゾーンの id

表74.2 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

74.2. zone axfr

ゾーンの自動ゾーン転送を行います。

使用方法

openstack zone axfr [-h] [--all-projects] [--edit-managed]
                           [--sudo-project-id SUDO_PROJECT_ID]
                           id

表74.3 位置引数

概要

id

ゾーンの id

表74.4 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

74.3. zone blacklist create

新規ブラックリストを作成します。

使用方法

openstack zone blacklist create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       --pattern PATTERN
                                       [--description DESCRIPTION]
                                       [--all-projects] [--edit-managed]
                                       [--sudo-project-id SUDO_PROJECT_ID]

表74.5 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.6 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.7 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.8 その他の引数 (オプション):

概要

--pattern PATTERN

ブラックリストのパターン

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--description DESCRIPTION

説明

-h, --help

ヘルプメッセージを表示して終了します。

表74.9 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.4. zone blacklist delete

ブラックリストを削除します。

使用方法

openstack zone blacklist delete [-h] [--all-projects] [--edit-managed]
                                       [--sudo-project-id SUDO_PROJECT_ID]
                                       id

表74.10 位置引数

概要

id

ブラックリストの id

表74.11 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

74.5. zone blacklist list

ブラックリストを一覧表示します。

使用方法

openstack zone blacklist list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--all-projects] [--edit-managed]
                                     [--sudo-project-id SUDO_PROJECT_ID]

表74.12 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.13 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表74.14 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表74.15 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.16 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

74.6. zone blacklist set

ブラックリストの属性を設定します。

使用方法

openstack zone blacklist set [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX] [--pattern PATTERN]
                                    [--description DESCRIPTION | --no-description]
                                    [--all-projects] [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    id

表74.17 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.18 位置引数

概要

id

ブラックリストの id

表74.19 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.20 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.21 その他の引数 (オプション):

概要

--pattern PATTERN

ブラックリストのパターン

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--description DESCRIPTION

説明

-h, --help

ヘルプメッセージを表示して終了します。

--no-description—​all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

表74.22 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.7. zone blacklist show

ブラックリストの詳細を表示します。

使用方法

openstack zone blacklist show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--all-projects] [--edit-managed]
                                     [--sudo-project-id SUDO_PROJECT_ID]
                                     id

表74.23 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.24 位置引数

概要

id

ブラックリストの id

表74.25 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.26 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.27 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表74.28 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.8. zone create

新しいゾーンを作成します。

使用方法

openstack zone create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             [--email EMAIL] [--type TYPE] [--ttl TTL]
                             [--description DESCRIPTION]
                             [--masters MASTERS [MASTERS ...]]
                             [--attributes ATTRIBUTES [ATTRIBUTES ...]]
                             [--all-projects] [--edit-managed]
                             [--sudo-project-id SUDO_PROJECT_ID]
                             name

表74.29 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.30 位置引数

概要

name

ゾーン名

表74.31 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.32 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.33 その他の引数 (オプション):

概要

--email EMAIL

ゾーンのメール

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--ttl TTL

存続期間 (秒)

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--attributes ATTRIBUTES [ATTRIBUTES …​]

ゾーンの属性

--type TYPE

ゾーンの種別

--description DESCRIPTION

説明

-h, --help

ヘルプメッセージを表示して終了します。

--masters MASTERS [MASTERS …​]

ゾーンのマスター

表74.34 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.9. zone delete

ゾーンを削除します。

使用方法

openstack zone delete [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             [--all-projects] [--edit-managed]
                             [--sudo-project-id SUDO_PROJECT_ID]
                             id

表74.35 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.36 位置引数

概要

id

ゾーンの id

表74.37 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.38 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.39 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表74.40 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.10. zone export create

ゾーンをエクスポートします。

使用方法

openstack zone export create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX] [--all-projects]
                                    [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_id

表74.41 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.42 位置引数

概要

zone_id

ゾーンの id

表74.43 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.44 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.45 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表74.46 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.11. zone export delete

ゾーンのエクスポートを削除します。

使用方法

openstack zone export delete [-h] [--all-projects] [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_export_id

表74.47 位置引数

概要

zone_export_id

ゾーンエクスポート ID

表74.48 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

74.12. zone export list

ゾーンのエクスポートを一覧表示します。

使用方法

openstack zone export list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]

表74.49 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.50 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表74.51 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表74.52 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.53 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

74.13. zone export show

ゾーンのエクスポートを表示します。

使用方法

openstack zone export show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_export_id

表74.54 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.55 位置引数

概要

zone_export_id

ゾーンエクスポート ID

表74.56 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.57 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.58 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表74.59 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.14. zone export showfile

ゾーンエクスポートのゾーンファイルを表示します。

使用方法

openstack zone export showfile [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--all-projects] [--edit-managed]
                                      [--sudo-project-id SUDO_PROJECT_ID]
                                      zone_export_id

表74.60 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.61 位置引数

概要

zone_export_id

ゾーンエクスポート ID

表74.62 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.63 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.64 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表74.65 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.15. zone import create

ファイルシステムのファイルからゾーンをインポートします。

使用方法

openstack zone import create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX] [--all-projects]
                                    [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_file_path

表74.66 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.67 位置引数

概要

zone_file_path

ゾーンファイルへのパス

表74.68 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.69 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.70 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表74.71 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.16. zone import delete

ゾーンのインポートを削除します。

使用方法

openstack zone import delete [-h] [--all-projects] [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_import_id

表74.72 位置引数

概要

zone_import_id

ゾーンインポート id

表74.73 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

74.17. zone import list

ゾーンのインポートを一覧表示します。

使用方法

openstack zone import list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]

表74.74 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.75 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表74.76 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表74.77 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.78 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

74.18. zone import show

ゾーンのインポートを表示します。

使用方法

openstack zone import show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_import_id

表74.79 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.80 位置引数

概要

zone_import_id

ゾーンインポート id

表74.81 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.82 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.83 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表74.84 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.19. zone list

ゾーンの一覧を表示します。

使用方法

openstack zone list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--sort-column SORT_COLUMN] [--name NAME]
                           [--email EMAIL] [--type TYPE] [--ttl TTL]
                           [--description DESCRIPTION] [--status STATUS]
                           [--all-projects] [--edit-managed]
                           [--sudo-project-id SUDO_PROJECT_ID]

表74.85 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.86 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表74.87 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表74.88 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.89 その他の引数 (オプション):

概要

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--email EMAIL

ゾーンのメール

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--ttl TTL

存続期間 (秒)

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--name NAME

ゾーン名

--type TYPE

ゾーンの種別

--description DESCRIPTION

説明

--status STATUS

ゾーンのステータス

-h, --help

ヘルプメッセージを表示して終了します。

74.20. zone set

ゾーンの属性を設定します。

使用方法

openstack zone set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                          [--max-width <integer>] [--fit-width]
                          [--print-empty] [--noindent] [--prefix PREFIX]
                          [--email EMAIL] [--ttl TTL]
                          [--description DESCRIPTION | --no-description]
                          [--masters MASTERS [MASTERS ...]] [--all-projects]
                          [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
                          id

表74.90 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.91 位置引数

概要

id

ゾーンの id

表74.92 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.93 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.94 その他の引数 (オプション):

概要

--email EMAIL

ゾーンのメール

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--ttl TTL

存続期間 (秒)

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--description DESCRIPTION

説明

--no-description—​masters MASTERS [MASTERS …​]

ゾーンのマスター

-h, --help

ヘルプメッセージを表示して終了します。

表74.95 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.21. zone show

ゾーンの詳細を表示します。

使用方法

openstack zone show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent] [--prefix PREFIX]
                           [--all-projects] [--edit-managed]
                           [--sudo-project-id SUDO_PROJECT_ID]
                           id

表74.96 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.97 位置引数

概要

id

ゾーンの id

表74.98 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.99 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.100 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表74.101 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.22. zone transfer accept list

ゾーン転送の受理を一覧表示します。

使用方法

openstack zone transfer accept list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           [--all-projects] [--edit-managed]
                                           [--sudo-project-id SUDO_PROJECT_ID]

表74.102 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.103 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表74.104 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表74.105 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.106 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

74.23. zone transfer accept request

ゾーン転送リクエストを許可します。

使用方法

openstack zone transfer accept request [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              --transfer-id TRANSFER_ID --key
                                              KEY [--all-projects]
                                              [--edit-managed]
                                              [--sudo-project-id SUDO_PROJECT_ID]

表74.107 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.108 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.109 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.110 その他の引数 (オプション):

概要

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--key KEY

転送キー

--transfer-id TRANSFER_ID

転送 id

-h, --help

ヘルプメッセージを表示して終了します。

表74.111 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.24. zone transfer accept show

ゾーン転送の受理を表示します。

使用方法

openstack zone transfer accept show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--all-projects] [--edit-managed]
                                           [--sudo-project-id SUDO_PROJECT_ID]
                                           id

表74.112 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.113 位置引数

概要

id

ゾーン転送受理 ID

表74.114 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.115 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.116 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表74.117 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.25. zone transfer request create

新しいゾーン転送リクエストを作成します。

使用方法

openstack zone transfer request create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--target-project-id TARGET_PROJECT_ID]
                                              [--description DESCRIPTION]
                                              [--all-projects]
                                              [--edit-managed]
                                              [--sudo-project-id SUDO_PROJECT_ID]
                                              zone_id

表74.118 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.119 位置引数

概要

zone_id

転送するゾーン ID。

表74.120 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.121 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.122 その他の引数 (オプション):

概要

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--description DESCRIPTION

説明

-h, --help

ヘルプメッセージを表示して終了します。

--target-project-id TARGET_PROJECT_ID

転送先のターゲットプロジェクト ID。

表74.123 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.26. zone transfer request delete

ゾーン転送リクエストを削除します。

使用方法

openstack zone transfer request delete [-h] [--all-projects]
                                              [--edit-managed]
                                              [--sudo-project-id SUDO_PROJECT_ID]
                                              id

表74.124 位置引数

概要

id

ゾーン転送リクエスト ID

表74.125 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

74.27. zone transfer request list

ゾーン転送リクエストの一覧を表示します。

使用方法

openstack zone transfer request list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]
                                            [--all-projects] [--edit-managed]
                                            [--sudo-project-id SUDO_PROJECT_ID]

表74.126 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.127 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表74.128 出力形式の設定

概要

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

表74.129 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.130 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

74.28. zone transfer request set

ゾーン転送リクエストを設定します。

使用方法

openstack zone transfer request set [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--description DESCRIPTION | --no-description]
                                           [--all-projects] [--edit-managed]
                                           [--sudo-project-id SUDO_PROJECT_ID]
                                           id

表74.131 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.132 位置引数

概要

id

ゾーン転送リクエスト ID

表74.133 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.134 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.135 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--no-description—​all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--description DESCRIPTION

説明

表74.136 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

74.29. zone transfer request show

ゾーン転送リクエストの詳細を表示します。

使用方法

openstack zone transfer request show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            [--all-projects] [--edit-managed]
                                            [--sudo-project-id SUDO_PROJECT_ID]
                                            id

表74.137 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表74.138 位置引数

概要

id

ゾーン転送リクエスト ID

表74.139 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.140 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.141 その他の引数 (オプション):

概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表74.142 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。