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


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>]
Copy to Clipboard Toggle word wrap

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表2.1 位置引数
概要

URI

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

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表2.3 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表2.4 位置引数
概要

URI

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

Expand
表2.5 CSV 書式設定
概要

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

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

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

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

Expand
表2.7 JSON 書式設定
概要

--noindent

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

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表2.9 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表2.10 位置引数
概要

URI

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

Expand
表2.11 CSV 書式設定
概要

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

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

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

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

Expand
表2.13 JSON 書式設定
概要

--noindent

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

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表2.15 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表2.16 位置引数
概要

URI

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

Expand
表2.17 CSV 書式設定
概要

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

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

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

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

Expand
表2.19 JSON 書式設定
概要

--noindent

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

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表2.21 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表2.22 位置引数
概要

URI

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

Expand
表2.23 CSV 書式設定
概要

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

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

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

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

Expand
表2.25 JSON 書式設定
概要

--noindent

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

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表3.1 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表3.2 位置引数
概要

定義

アクション定義ファイル

Expand
表3.3 CSV 書式設定
概要

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

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

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

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

Expand
表3.5 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

--public

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

3.2. action definition definition show

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

使用方法

openstack action definition definition show [-h] name
Copy to Clipboard Toggle word wrap

Expand
表3.7 位置引数
概要

name

アクション名

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

-h, --help

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

3.3. action definition delete

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

使用方法

openstack action definition delete [-h] action [action ...]
Copy to Clipboard Toggle word wrap

Expand
表3.9 位置引数
概要

action

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

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表3.11 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表3.12 CSV 書式設定
概要

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

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

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

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

Expand
表3.14 JSON 書式設定
概要

--noindent

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

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表3.16 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表3.17 位置引数
概要

action

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表3.19 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表3.22 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表3.23 位置引数
概要

定義

アクション定義ファイル

Expand
表3.24 CSV 書式設定
概要

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

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

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

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

Expand
表3.26 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

--id ID

アクション ID。

--public

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

3.7. action execution delete

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

使用方法

openstack action execution delete [-h]
                                         action_execution
                                         [action_execution ...]
Copy to Clipboard Toggle word wrap

Expand
表3.28 位置引数
概要

action_execution

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

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

-h, --help

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

3.8. action execution input show

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

使用方法

openstack action execution input show [-h] id
Copy to Clipboard Toggle word wrap

Expand
表3.30 位置引数
概要

id

アクション実行 ID。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表3.32 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表3.33 位置引数
概要

task_execution_id

タスクの実行 ID。

Expand
表3.34 CSV 書式設定
概要

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

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

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

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

Expand
表3.36 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

--limit [LIMIT]

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

3.10. action execution output show

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

使用方法

openstack action execution output show [-h] id
Copy to Clipboard Toggle word wrap

Expand
表3.38 位置引数
概要

id

アクション実行 ID。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表3.40 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表3.41 位置引数
概要

input

アクション入力。

name

実行するアクション名。

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表3.43 JSON 書式設定
概要

--noindent

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

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

-s, --save-result

結果を db に保存します。

-t TARGET, --target TARGET

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

-h, --help

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

--run-sync

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

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表3.46 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表3.47 位置引数
概要

action_execution

アクション実行 ID。

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表3.49 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表3.52 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表3.53 位置引数
概要

id

アクション実行 ID。

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表3.55 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

--output OUTPUT

アクション実行の出力

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

アクション実行の状態

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表4.1 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表4.2 位置引数
概要

<name>

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表4.4 JSON 書式設定
概要

--noindent

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

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

--share

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

--ip-version {4,6}

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

--project-domain <project-domain>

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

--no-share

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

-h, --help

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

--project <project>

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

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

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

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

4.2. address scope delete

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

使用方法

openstack address scope delete [-h]
                                      <address-scope> [<address-scope> ...]
Copy to Clipboard Toggle word wrap

Expand
表4.7 位置引数
概要

<address-scope>

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

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表4.9 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表4.10 CSV 書式設定
概要

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

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

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

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

Expand
表4.12 JSON 書式設定
概要

--noindent

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表4.14 位置引数
概要

<address-scope>

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表4.16 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表4.17 位置引数
概要

<address-scope>

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表4.19 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表5.1 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表5.2 位置引数
概要

<aggregate>

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

<host>

<aggregate> に追加するホスト

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表5.4 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表5.7 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表5.8 位置引数
概要

<name>

新しいアグリゲート名

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表5.10 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

--zone <availability-zone>

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

--property <key=value>

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

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

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

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

5.3. aggregate delete

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

使用方法

openstack aggregate delete [-h] <aggregate> [<aggregate> ...]
Copy to Clipboard Toggle word wrap

Expand
表5.13 位置引数
概要

<aggregate>

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

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表5.15 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表5.16 CSV 書式設定
概要

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

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

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

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

Expand
表5.18 JSON 書式設定
概要

--noindent

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表5.20 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表5.21 位置引数
概要

<aggregate>

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

<host>

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表5.23 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表5.26 位置引数
概要

<aggregate>

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表5.28 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表5.29 位置引数
概要

<aggregate>

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表5.31 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

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

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

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

5.8. aggregate unset

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

使用方法

openstack aggregate unset [-h] [--property <key>] <aggregate>
Copy to Clipboard Toggle word wrap

Expand
表5.34 位置引数
概要

<aggregate>

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

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表6.1 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表6.3 common gnocchi alarm rules
概要

--aggregation-method <AGGR_METHOD>

しきい値と比較する aggregation_method

--granularity <GRANULARITY>

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

Expand
表6.4 event alarm
概要

--event-type <EVENT_TYPE>

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

Expand
表6.5 gnocchi resource threshold alarm
概要

--resource-id <RESOURCE_ID>

リソースの ID。

--resource-type <RESOURCE_TYPE>

リソースのタイプ。

Expand
表6.6 JSON 書式設定
概要

--noindent

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

Expand
表6.7 composite alarm
概要

--composite-rule <COMPOSITE_RULE>

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

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

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

評価するしきい値。

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

--metrics <METRICS>

メトリクス ID の一覧。

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

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

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

6.2. alarm delete

アラームを削除します。

使用方法

openstack alarm delete [-h] [--name <NAME>] [<ALARM ID or NAME>]
Copy to Clipboard Toggle word wrap

Expand
表6.12 位置引数
概要

<ALARM ID または NAME>

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

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表6.19 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表6.20 位置引数
概要

<alarm-id>

アラームの ID

Expand
表6.21 CSV 書式設定
概要

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

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

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

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

Expand
表6.23 JSON 書式設定
概要

--noindent

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

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表6.25 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表6.26 CSV 書式設定
概要

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

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

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

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

Expand
表6.28 JSON 書式設定
概要

--noindent

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

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表6.30 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表6.31 位置引数
概要

<ALARM ID または NAME>

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表6.33 JSON 書式設定
概要

--noindent

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

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

--name <NAME>

アラームの名前

-h, --help

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

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表6.36 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表6.37 位置引数
概要

<ALARM ID または NAME>

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表6.39 JSON 書式設定
概要

--noindent

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

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

--name <NAME>

アラームの名前

-h, --help

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

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表6.42 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表6.43 位置引数
概要

<ALARM ID または NAME>

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表6.45 JSON 書式設定
概要

--noindent

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

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

--name <NAME>

アラームの名前

-h, --help

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

--state <STATE>

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

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表6.48 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表6.49 位置引数
概要

<ALARM ID または NAME>

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表6.51 common gnocchi alarm rules
概要

--aggregation-method <AGGR_METHOD>

しきい値と比較する aggregation_method

--granularity <GRANULARITY>

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

Expand
表6.52 event alarm
概要

--event-type <EVENT_TYPE>

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

Expand
表6.53 gnocchi resource threshold alarm
概要

--resource-id <RESOURCE_ID>

リソースの ID。

--resource-type <RESOURCE_TYPE>

リソースのタイプ。

Expand
表6.54 JSON 書式設定
概要

--noindent

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

Expand
表6.55 composite alarm
概要

--composite-rule <COMPOSITE_RULE>

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

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

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

評価するしきい値。

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

--metrics <METRICS>

メトリクス ID の一覧。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表7.1 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表7.3 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表8.1 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表8.2 CSV 書式設定
概要

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

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

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

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

Expand
表8.4 JSON 書式設定
概要

--noindent

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

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表9.1 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.3 JSON 書式設定
概要

--noindent

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

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

--uuid <uuid>

シャーシの一意の UUID

-h, --help

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

--description <description>

シャーシの説明

--extra <key=value>

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

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

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

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

9.2. baremetal chassis delete

シャーシを削除します。

使用方法

openstack baremetal chassis delete [-h] <chassis> [<chassis> ...]
Copy to Clipboard Toggle word wrap

Expand
表9.6 位置引数
概要

<chassis>

削除するシャーシの UUID

Expand
表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>]]
Copy to Clipboard Toggle word wrap

Expand
表9.8 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.9 CSV 書式設定
概要

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

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

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

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

Expand
表9.11 JSON 書式設定
概要

--noindent

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.13 位置引数
概要

<chassis>

シャーシの UUID

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.15 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.16 位置引数
概要

<chassis>

シャーシの UUID

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.18 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

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

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

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

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

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

9.6. baremetal chassis unset

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

使用方法

openstack baremetal chassis unset [-h] [--description] [--extra <key>]
                                         <chassis>
Copy to Clipboard Toggle word wrap

Expand
表9.21 位置引数
概要

<chassis>

シャーシの UUID

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

-h, --help

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

--extra <key>

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

--description

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

9.7. baremetal create

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

使用方法

openstack baremetal create [-h] <file> [<file> ...]
Copy to Clipboard Toggle word wrap

Expand
表9.23 位置引数
概要

<file>

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

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表9.25 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.26 CSV 書式設定
概要

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

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

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

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

Expand
表9.28 JSON 書式設定
概要

--noindent

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.30 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.31 位置引数
概要

<method>

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

<driver>

ドライバーの名前。

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.33 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

--http-method <http-method>

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

--arg <key=value>

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.36 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.37 位置引数
概要

<driver>

ドライバーの名前。

Expand
表9.38 CSV 書式設定
概要

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

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

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

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

Expand
表9.40 JSON 書式設定
概要

--noindent

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.42 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.43 位置引数
概要

<driver>

ドライバーの名前。

Expand
表9.44 CSV 書式設定
概要

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

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

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

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

Expand
表9.46 JSON 書式設定
概要

--noindent

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.48 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.49 位置引数
概要

<driver>

ドライバーの名前。

Expand
表9.50 CSV 書式設定
概要

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

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

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

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

Expand
表9.52 JSON 書式設定
概要

--noindent

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.54 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.55 位置引数
概要

<driver>

ドライバーの名前。

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.57 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

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

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

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

9.14. baremetal introspection abort

ノードのイントロスペクションの実行を中止します。

使用方法

openstack baremetal introspection abort [-h] node
Copy to Clipboard Toggle word wrap

Expand
表9.60 位置引数
概要

node

ベアメタルノードの uuid または名前

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

-h, --help

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

9.15. baremetal introspection data save

未加工のイントロスペクションデータを保存または表示します。

使用方法

openstack baremetal introspection data save [-h] [--file <filename>]
                                                   node
Copy to Clipboard Toggle word wrap

Expand
表9.62 位置引数
概要

node

ベアメタルノードの uuid または名前

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表9.64 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.65 位置引数
概要

node_ident

ベアメタルノードの uuid または名前

Expand
表9.66 CSV 書式設定
概要

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

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

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

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

Expand
表9.68 JSON 書式設定
概要

--noindent

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

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表9.70 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.71 位置引数
概要

interface

インターフェイス名

node_ident

ベアメタルノードの uuid または名前

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.73 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

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

1 つ以上のフィールドを表示します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表9.76 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.77 CSV 書式設定
概要

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

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

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

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

Expand
表9.79 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

--limit LIMIT

返す項目数

--marker MARKER

前のページにある最後の項目の UUID

9.19. baremetal introspection reprocess

保存されたイントロスペクションデータを再処理します。

使用方法

openstack baremetal introspection reprocess [-h] node
Copy to Clipboard Toggle word wrap

Expand
表9.81 位置引数
概要

node

ベアメタルノードの uuid または名前

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

-h, --help

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

9.20. baremetal introspection rule delete

イントロスペクションルールを削除します。

使用方法

openstack baremetal introspection rule delete [-h] uuid
Copy to Clipboard Toggle word wrap

Expand
表9.83 位置引数
概要

uuid

ルールの uuid

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表9.85 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.86 位置引数
概要

file

インポートする JSON ファイル。1 つまたは複数のルールを含めることができます。

Expand
表9.87 CSV 書式設定
概要

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

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

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

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

Expand
表9.89 JSON 書式設定
概要

--noindent

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

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表9.91 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.92 CSV 書式設定
概要

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

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

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

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

Expand
表9.94 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

9.23. baremetal introspection rule purge

すべてのイントロスペクションルールを破棄します。

使用方法

openstack baremetal introspection rule purge [-h]
Copy to Clipboard Toggle word wrap

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表9.97 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.98 位置引数
概要

uuid

ルールの uuid

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.100 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

Expand
表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 ...]
Copy to Clipboard Toggle word wrap

Expand
表9.103 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.104 位置引数
概要

node

ベアメタルノードの uuid または名前

Expand
表9.105 CSV 書式設定
概要

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

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

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

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

Expand
表9.107 JSON 書式設定
概要

--noindent

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

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表9.109 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.110 位置引数
概要

node

ベアメタルノードの uuid または名前

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.112 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

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

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

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

9.27. baremetal node abort

ベアメタルノードのプロビジョニング状態を abort に設定します。

使用方法

openstack baremetal node abort [-h] <node>
Copy to Clipboard Toggle word wrap

Expand
表9.115 位置引数
概要

<node>

ノードの名前または UUID。

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

-h, --help

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

9.28. baremetal node add trait

ノードに特性を追加します。

使用方法

openstack baremetal node add trait [-h] <node> <trait> [<trait> ...]
Copy to Clipboard Toggle word wrap

Expand
表9.117 位置引数
概要

<node>

ノードの名前または UUID

<trait>

追加する特性

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

-h, --help

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

9.29. baremetal node adopt

ベアメタルノードのプロビジョニング状態を adopt に設定します。

使用方法

openstack baremetal node adopt [-h] [--wait [<time-out>]] <node>
Copy to Clipboard Toggle word wrap

Expand
表9.119 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.121 位置引数
概要

<node>

ノードの名前または UUID

<device>

Bios、cdrom、disk、pxe、safe、wanboot のいずれか

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.123 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.124 位置引数
概要

<node>

ノードの名前または UUID

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.126 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

--supported

サポート対象のブートデバイスを表示します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.129 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.131 位置引数
概要

<node>

ノードの名前または UUID

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

-h, --help

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

9.34. baremetal node console enable

ノードのコンソールアクセスを有効化します。

使用方法

openstack baremetal node console enable [-h] <node>
Copy to Clipboard Toggle word wrap

Expand
表9.133 位置引数
概要

<node>

ノードの名前または UUID

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.135 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.136 位置引数
概要

<node>

ノードの名前または UUID

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.138 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表9.141 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.143 JSON 書式設定
概要

--noindent

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

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

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

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

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

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

9.37. baremetal node delete

ベアメタルノードの登録を解除します。

使用方法

openstack baremetal node delete [-h] <node> [<node> ...]
Copy to Clipboard Toggle word wrap

Expand
表9.146 位置引数
概要

<node>

削除するノード (名前または uuid)

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

-h, --help

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

9.38. baremetal node deploy

ベアメタルノードのプロビジョニングの状態を deploy に設定します。

使用方法

openstack baremetal node deploy [-h] [--wait [<time-out>]]
                                       [--config-drive <config-drive>]
                                       <node>
Copy to Clipboard Toggle word wrap

Expand
表9.148 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.150 位置引数
概要

<node>

ノードの名前または UUID。

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

-h, --help

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

9.40. baremetal node inspect

ベアメタルノードのプロビジョニング状態を inspect に設定します。

使用方法

openstack baremetal node inspect [-h] [--wait [<time-out>]] <node>
Copy to Clipboard Toggle word wrap

Expand
表9.152 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表9.154 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.155 CSV 書式設定
概要

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

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

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

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

Expand
表9.157 JSON 書式設定
概要

--noindent

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.159 位置引数
概要

<node>

ノードの名前または UUID。

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

-h, --help

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

--reason <reason>

メンテナーンスモードを設定する理由。

9.43. baremetal node maintenance unset

メンテナーンスモードのベアメタルノードの設定を解除します。

使用方法

openstack baremetal node maintenance unset [-h] <node>
Copy to Clipboard Toggle word wrap

Expand
表9.161 位置引数
概要

<node>

ノードの名前または UUID。

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

-h, --help

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

9.44. baremetal node manage

ベアメタルノードのプロビジョニングの状態を manage に設定します。

使用方法

openstack baremetal node manage [-h] [--wait [<time-out>]] <node>
Copy to Clipboard Toggle word wrap

Expand
表9.163 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.165 位置引数
概要

<node>

ノードの名前または UUID

<method>

実行するベンダーパススルーメソッド

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.167 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.168 位置引数
概要

<node>

ノードの名前または UUID

Expand
表9.169 CSV 書式設定
概要

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

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

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

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

Expand
表9.171 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

9.47. baremetal node power off

ノードの電源をオフにします。

使用方法

openstack baremetal node power off [-h]
                                          [--power-timeout <power-timeout>]
                                          [--soft]
                                          <node>
Copy to Clipboard Toggle word wrap

Expand
表9.173 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.175 位置引数
概要

<node>

ノードの名前または UUID。

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

-h, --help

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

--power-timeout <power-timeout>

エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間 (秒単位、正の整数)。

9.49. baremetal node provide

ベアメタルノードのプロビジョニングの状態を provide に設定します。

使用方法

openstack baremetal node provide [-h] [--wait [<time-out>]] <node>
Copy to Clipboard Toggle word wrap

Expand
表9.177 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.179 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.181 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表9.183 位置引数
概要

<node>

ノードの名前または UUID

<trait>

削除する特性

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.185 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.187 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.188 位置引数
概要

<node>

ノードの名前または uuid(または --instance が指定されている場合のインスタンスの uuid)

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.190 JSON 書式設定
概要

--noindent

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

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

--instance

<node> はインスタンスの uuid です。

-h, --help

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

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

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.193 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.194 位置引数
概要

<node>

ノードの名前または UUID

Expand
表9.195 CSV 書式設定
概要

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

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

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

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

Expand
表9.197 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

9.56. baremetal node undeploy

ベアメタルノードのプロビジョニングの状態を deleted に設定します。

使用方法

openstack baremetal node undeploy [-h] [--wait [<time-out>]] <node>
Copy to Clipboard Toggle word wrap

Expand
表9.199 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.201 位置引数
概要

<node>

ノードの名前または UUID。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.203 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.204 位置引数
概要

<node>

ノードの名前または UUID

Expand
表9.205 CSV 書式設定
概要

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

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

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

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

Expand
表9.207 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

9.59. baremetal node vif attach

VIF を指定ノードに接続します。

使用方法

openstack baremetal node vif attach [-h] [--vif-info <key=value>]
                                           <node> <vif-id>
Copy to Clipboard Toggle word wrap

Expand
表9.209 位置引数
概要

<node>

ノードの名前または UUID

<vif-id>

ノードに割り当てる vif の名前または UUID。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.211 位置引数
概要

<node>

ノードの名前または UUID

<vif-id>

ノードから切り離す vif の名前または UUID。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.213 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.214 位置引数
概要

<node>

ノードの名前または UUID

Expand
表9.215 CSV 書式設定
概要

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

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

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

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

Expand
表9.217 JSON 書式設定
概要

--noindent

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.219 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.220 位置引数
概要

<address>

このポートの MAC アドレス。

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.222 JSON 書式設定
概要

--noindent

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

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

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

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

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

9.63. baremetal port delete

ポートを削除します。

使用方法

openstack baremetal port delete [-h] <port> [<port> ...]
Copy to Clipboard Toggle word wrap

Expand
表9.225 位置引数
概要

<port>

削除するポートの UUID

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表9.227 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.229 JSON 書式設定
概要

--noindent

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

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

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

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

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

9.65. baremetal port group delete

ベアメタルポートグループの登録を解除します。

使用方法

openstack baremetal port group delete [-h]
                                             <port group> [<port group> ...]
Copy to Clipboard Toggle word wrap

Expand
表9.232 位置引数
概要

<port group>

削除するポートグループ (名前または UUID)。

Expand
表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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表9.234 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.235 CSV 書式設定
概要

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

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

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

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

Expand
表9.237 JSON 書式設定
概要

--noindent

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.239 位置引数
概要

<port group>

ポートグループの名前または UUID。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.241 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.242 位置引数
概要

<id>

ポートグループの UUID または名前 (または --address が指定されている場合は mac アドレス)。

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.244 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

--address

<id> は、ポートグループの mac アドレス (uuid または name ではなく) です。

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

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.247 位置引数
概要

<port group>

ポートグループの名前または UUID。

Expand
表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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表9.249 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.250 CSV 書式設定
概要

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

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

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

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

Expand
表9.252 JSON 書式設定
概要

--noindent

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.254 位置引数
概要

<port>

ポートの UUID

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.256 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.257 位置引数
概要

<id>

ポートの UUID(--address が指定されている場合は mac アドレス)。

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.259 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

--address

<id> はポートの (uuid ではなく)mac アドレスです。

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

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.262 位置引数
概要

<port>

ポートの UUID

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表9.264 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.266 JSON 書式設定
概要

--noindent

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

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

--node <uuid>

このボリュームコネクターが属するノードの UUID。

--uuid <uuid>

ボリュームコネクターの UUID。

--type <type>

ボリュームコネクターの種類。iqnipmacwwnnwwpnportportgroup

--extra <key=value>

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

-h, --help

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

--connector-id <connector id>

指定のタイプのボリュームコネクター ID。たとえば、タイプが iqn の場合は、ノードの iSCSI イニシエーター IQN。

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

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

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

9.75. baremetal volume connector delete

ベアメタルボリュームコネクターの登録を解除します。

使用方法

openstack baremetal volume connector delete [-h]
                                                   <volume connector>
                                                   [<volume connector> ...]
Copy to Clipboard Toggle word wrap

Expand
表9.269 位置引数
概要

<volume connector>

削除するボリュームコネクターの UUID

Expand
表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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表9.271 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.272 CSV 書式設定
概要

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

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

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

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

Expand
表9.274 JSON 書式設定
概要

--noindent

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.276 位置引数
概要

<volume connector>

ボリュームコネクターの UUID。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.278 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.279 位置引数
概要

<id>

ボリュームコネクターの UUID。

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.281 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

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

1 つ以上のボリュームコネクターフィールド。これらのフィールドのみがサーバーから取得されます。

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

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

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

9.79. baremetal volume connector unset

ベアメタルボリュームコネクタープロパティーの設定を解除します。

使用方法

openstack baremetal volume connector unset [-h] [--extra <key>]
                                                  <volume connector>
Copy to Clipboard Toggle word wrap

Expand
表9.284 位置引数
概要

<volume connector>

ボリュームコネクターの UUID。

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表9.286 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.288 JSON 書式設定
概要

--noindent

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

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

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

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

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

9.81. baremetal volume target delete

ベアメタルボリュームのターゲットの登録を解除します。

使用方法

openstack baremetal volume target delete [-h]
                                                <volume target>
                                                [<volume target> ...]
Copy to Clipboard Toggle word wrap

Expand
表9.291 位置引数
概要

<volume target>

削除するボリュームターゲットの UUID。

Expand
表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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表9.293 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.294 CSV 書式設定
概要

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

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

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

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

Expand
表9.296 JSON 書式設定
概要

--noindent

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

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.298 位置引数
概要

<volume target>

ボリュームターゲットの UUID

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.300 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表9.301 位置引数
概要

<id>

ボリュームターゲットの UUID

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表9.303 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

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

1 つ以上のボリュームターゲットフィールド。これらのフィールドのみがサーバーから取得されます。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表9.306 位置引数
概要

<volume target>

ボリュームターゲットの UUID

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表10.1 位置引数
概要

<agent-id>

動的ルーティングエージェントの ID

<bgp-speaker>

bgp スピーカーの ID または名前

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

-h, --help

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

10.2. bgp dragent remove speaker

動的ルーティングエージェントから BGP スピーカーを削除します。

使用方法

openstack bgp dragent remove speaker [-h] <agent-id> <bgp-speaker>
Copy to Clipboard Toggle word wrap

Expand
表10.3 位置引数
概要

<agent-id>

動的ルーティングエージェントの ID

<bgp-speaker>

bgp スピーカーの ID または名前

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表10.5 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表10.6 位置引数
概要

<name>

作成する bgp ピアの名前

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表10.8 JSON 書式設定
概要

--noindent

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

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

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

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

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

10.4. bgp peer delete

BGP ピアを削除します。

使用方法

openstack bgp peer delete [-h] <bgp-peer>
Copy to Clipboard Toggle word wrap

Expand
表10.11 位置引数
概要

<bgp-peer>

削除する BGP ピア (名前または ID)

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表10.13 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表10.14 CSV 書式設定
概要

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

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

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

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

Expand
表10.16 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

10.6. bgp peer set

BGP ピアを更新します。

使用方法

openstack bgp peer set [-h] [--name NAME] [--password <auth-password>]
                              <bgp-peer>
Copy to Clipboard Toggle word wrap

Expand
表10.18 位置引数
概要

<bgp-peer>

更新する BGP ピア (名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表10.20 表の書式設定
概要

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表10.21 位置引数
概要

<bgp-peer>

表示する BGP ピア (名前または ID)

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

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

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

-c COLUMN, --column COLUMN

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

Expand
表10.23 JSON 書式設定
概要

--noindent

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

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

-h, --help

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

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

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

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

10.8. bgp speaker add network

BGP スピーカーにネットワークを追加します。

使用方法

openstack bgp speaker add network [-h] <bgp-speaker> <network>
Copy to Clipboard Toggle word wrap

Expand
表10.26 位置引数
概要

<bgp-speaker>

BGP スピーカー (名前または ID)

<network>

追加するネットワーク (名前または ID)

Expand
表10.27 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

10.9. bgp speaker add peer

BGP スピーカーにピアを追加します。

使用方法

openstack bgp speaker add peer [-h] <bgp-speaker> <bgp-peer>
Copy to Clipboard Toggle word wrap

Expand
表10.28 位置引数
概要

<bgp-peer>

追加する BGP ピア (名前または ID)

<bgp-speaker>

BGP スピーカー (名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表10.30 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表10.31 位置引数
概要

<name>

作成する bgp スピーカーの名前

Expand
表10.32 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表10.33 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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)

Expand
表10.35 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

10.11. bgp speaker delete

BGP スピーカーを削除します。

使用方法

openstack bgp speaker delete [-h] <bgp-speaker>
Copy to Clipboard Toggle word wrap

Expand
表10.36 位置引数
概要

<bgp-speaker>

削除する BGP スピーカー (名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表10.38 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表10.39 位置引数
概要

<bgp-speaker>

BGP スピーカー (名前または ID)

Expand
表10.40 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表10.42 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表10.44 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表10.45 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表10.47 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表10.49 位置引数
概要

<bgp-speaker>

BGP スピーカー (名前または ID)

<network>

削除するネットワーク (名前または ID)

Expand
表10.50 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

10.15. bgp speaker remove peer

BGP スピーカーからのピアを削除します。

使用方法

openstack bgp speaker remove peer [-h] <bgp-speaker> <bgp-peer>
Copy to Clipboard Toggle word wrap

Expand
表10.51 位置引数
概要

<bgp-peer>

削除する BGP ピア (名前または ID)

<bgp-speaker>

BGP スピーカー (名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表10.53 位置引数
概要

<bgp-speaker>

更新する BGP スピーカー (名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表10.55 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表10.56 位置引数
概要

<bgp-speaker>

bgp スピーカーの ID または名前

Expand
表10.57 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表10.59 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表10.61 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表10.62 位置引数
概要

<bgp-speaker>

表示する BGP スピーカー (名前または ID)

Expand
表10.63 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表10.64 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表10.65 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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}]
Copy to Clipboard Toggle word wrap

Expand
表11.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表11.2 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表11.3 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表11.4 その他の引数 (オプション):
概要

--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)

Expand
表11.5 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

11.2. bgpvpn delete

BGP VPN リソースを削除します。

使用方法

openstack bgpvpn delete [-h] <bgpvpn> [<bgpvpn> ...]
Copy to Clipboard Toggle word wrap

Expand
表11.6 位置引数
概要

<bgpvpn>

削除する BGP vpn (名前または ID)

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表11.8 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表11.9 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表11.11 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.13 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表11.14 位置引数
概要

<bgpvpn>

ネットワークの関連付け (名前または ID) を適用する BGP vpn

<network>

Bgp vpn(名前または ID) を関連付けるネットワーク

Expand
表11.15 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表11.16 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表11.17 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト (名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.19 位置引数
概要

<network association ID>

削除するネットワークの関連付け ID

<bgpvpn>

ネットワークの関連付けが所属する BGP vpn(名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.21 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表11.22 位置引数
概要

<bgpvpn>

記載の関連付けが (名前または ID) 所属する bgp vpn

Expand
表11.23 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表11.25 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.27 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表11.28 位置引数
概要

<network association ID>

検索するネットワークの関連付け ID

<bgpvpn>

この関連付けが所属する BGP vpn(名前または ID)

Expand
表11.29 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表11.30 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表11.31 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.33 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表11.34 位置引数
概要

<bgpvpn>

ポートの関連付け (名前または ID) を適用する BGP vpn

<port>

Bgp vpn(名前または ID) を関連付けるポート

Expand
表11.35 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表11.36 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表11.37 その他の引数 (オプション):
概要

--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)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.39 位置引数
概要

<bgpvpn>

ポートの関連付けが属する bgp vpn(名前または ID)

<port association ID>

削除するポート関連 ID

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.41 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表11.42 位置引数
概要

<bgpvpn>

記載の関連付けが (名前または ID) 所属する bgp vpn

Expand
表11.43 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表11.45 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.47 位置引数
概要

<bgpvpn>

ポートの関連付けが属する bgp vpn(名前または ID)

<port association ID>

更新するポート関連付け ID

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.49 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表11.50 位置引数
概要

<bgpvpn>

この関連付けが所属する BGP vpn(名前または ID)

<port association ID>

検索対象のポートの関連付け ID

Expand
表11.51 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表11.52 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表11.53 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.55 位置引数
概要

<bgpvpn>

ポートの関連付けが属する bgp vpn(名前または ID)

<port association ID>

更新するポート関連付け ID

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.57 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表11.58 位置引数
概要

<bgpvpn>

ルーターの関連付け (名前または ID) を適用する BGP vpn

<router>

Bgp vpn(名前または ID) を関連付けるルーター

Expand
表11.59 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表11.60 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表11.61 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト (名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.63 位置引数
概要

<bgpvpn>

ルーターの関連付けが所属する bgp vpn(名前または ID)

<router association ID>

削除するルーターの関連付け ID

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.65 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表11.66 位置引数
概要

<bgpvpn>

記載の関連付けが (名前または ID) 所属する bgp vpn

Expand
表11.67 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表11.69 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.71 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表11.72 位置引数
概要

<bgpvpn>

この関連付けが所属する BGP vpn(名前または ID)

<router association ID>

検索するルーターの関連付け ID

Expand
表11.73 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表11.74 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表11.75 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.77 位置引数
概要

<bgpvpn>

更新する BGP vpn(名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.79 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表11.80 位置引数
概要

<bgpvpn>

表示する BGP vpn(名前または ID)

Expand
表11.81 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表11.82 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表11.83 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表11.85 位置引数
概要

<bgpvpn>

更新する BGP vpn(名前または ID)

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表12.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表12.2 位置引数
概要

URI

Ca の URI 参照。

Expand
表12.3 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表12.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表12.5 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表12.7 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表12.8 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表12.10 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表13.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表13.2 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表13.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表13.6 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表13.7 位置引数
概要

<service>

表示するサービス (タイプまたは名前)

Expand
表13.8 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表13.9 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表13.10 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表13.11 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

第14章 coe

本章では、coe コマンドに含まれるコマンドについて説明します。

14.1. coe ca rotate

クラスターがアクセスを取り消すために CA 証明書をローテーションします。

使用方法

openstack coe ca rotate [-h] <cluster>
Copy to Clipboard Toggle word wrap

Expand
表14.1 位置引数
概要

<cluster>

クラスターの ID または名前

Expand
表14.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

14.2. coe ca show

クラスターの CA 証明書の詳細を表示します。

使用方法

openstack coe ca show [-h] <cluster>
Copy to Clipboard Toggle word wrap

Expand
表14.3 位置引数
概要

<cluster>

クラスターの ID または名前

Expand
表14.4 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

14.3. coe ca sign

クラスターの CA 証明書を生成します。

使用方法

openstack coe ca sign [-h] <cluster> <csr>
Copy to Clipboard Toggle word wrap

Expand
表14.5 位置引数
概要

<cluster>

クラスターの ID または名前

<csr>

署名を取得するために magnum に送信する csr ファイルのファイルパス。

Expand
表14.6 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

14.4. coe cluster config

クラスターの設定を取得します。

使用方法

openstack coe cluster config [-h] [--dir <dir>] [--force] <cluster>
Copy to Clipboard Toggle word wrap

Expand
表14.7 位置引数
概要

<cluster>

更新するクラスターの名前または UUID

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表14.9 位置引数
概要

<name>

作成するクラスターの名前。

Expand
表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> ...]
Copy to Clipboard Toggle word wrap

Expand
表14.11 位置引数
概要

<cluster>

削除するクラスターの ID または名前。

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表14.13 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表14.14 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表14.16 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表14.18 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表14.19 位置引数
概要

<cluster>

表示するクラスターの ID または名前。

Expand
表14.20 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表14.21 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表14.22 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表14.24 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表14.25 位置引数
概要

<name>

作成するクラスターテンプレートの名前。

Expand
表14.26 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表14.27 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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 作成を無効にします。

Expand
表14.29 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

14.10. coe cluster template delete

クラスターテンプレートを削除します。

使用方法

openstack coe cluster template delete [-h]
                                             <cluster-templates>
                                             [<cluster-templates> ...]
Copy to Clipboard Toggle word wrap

Expand
表14.30 位置引数
概要

<cluster-templates>

削除するクラスターテンプレートの ID または名前

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表14.32 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表14.33 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表14.35 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表14.37 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表14.38 位置引数
概要

<cluster-template>

表示するクラスターテンプレートの ID または名前。

Expand
表14.39 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表14.40 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表14.41 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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> ...]
Copy to Clipboard Toggle word wrap

Expand
表14.43 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表14.44 位置引数
概要

<op>

操作:addreplace、または remove のいずれか

<cluster-template>

更新するクラスターテンプレートの名前または UUID

<path=value>

追加/置換または削除する属性 (削除時にパスのみが必要)

Expand
表14.45 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表14.46 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表14.47 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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> ...]
Copy to Clipboard Toggle word wrap

Expand
表14.49 位置引数
概要

<cluster>

更新するクラスターの名前または UUID

<path=value>

追加/置換または削除する属性 (削除時にパスのみが必要)

<op>

操作:addreplace、または remove のいずれか

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表14.56 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表14.57 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表14.59 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表14.60 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

14.21. coe stats list

指定の project_id の統計を表示します。

使用方法

openstack coe stats list [-h] <project>
Copy to Clipboard Toggle word wrap

Expand
表14.61 位置引数
概要

<project>

プロジェクト ID

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表15.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表15.2 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表15.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表17.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表17.2 位置引数
概要

<url>

Url

<architecture>

アーキテクチャーのタイプ

<version>

バージョン

<hypervisor>

ハイパーバイザーの種別

<os>

OS のタイプ

<md5hash>

Md5 ハッシュ

Expand
表17.3 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表17.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表17.5 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表17.6 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

17.2. Compute agent delete

コンピュートエージェントを削除します。

使用方法

openstack compute agent delete [-h] <id> [<id> ...]
Copy to Clipboard Toggle word wrap

Expand
表17.7 位置引数
概要

<id>

削除するエージェントの ID

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表17.9 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表17.10 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表17.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表17.13 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--hypervisor <hypervisor>

ハイパーバイザーの種別

17.4. compute agent set

コンピュートエージェントのプロパティーを設定します。

使用方法

openstack compute agent set [-h] [--agent-version <version>]
                                   [--url <url>] [--md5hash <md5hash>]
                                   <id>
Copy to Clipboard Toggle word wrap

Expand
表17.14 位置引数
概要

<id>

エージェントの ID

Expand
表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> ...]
Copy to Clipboard Toggle word wrap

Expand
表17.16 位置引数
概要

<service>

削除する Compute サービス(id のみ)

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表17.18 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表17.19 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表17.21 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表17.23 位置引数
概要

<service>

サービスの名前 (バイナリー名)

<host>

ホスト名

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表18.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表18.2 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表18.3 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表18.4 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--unmask

パスワードをクリアテキストで表示します。

--mask

パスワードのマスクを試行します (デフォルト)

Expand
表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> ...]
Copy to Clipboard Toggle word wrap

Expand
表19.1 位置引数
概要

<volume>

<consistency-group> (名前または id) に追加するボリューム (複数のボリュームを追加する場合はオプションを繰り返し使用します)

<consistency-group>

<volume> を含む整合性グループ (名前または id)

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表19.3 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表19.4 位置引数
概要

<name>

新規整合性グループの名前 (デフォルトは none)

Expand
表19.5 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表19.6 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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)

Expand
表19.8 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

19.3. consistency group delete

整合性グループを削除します。

使用方法

openstack consistency group delete [-h] [--force]
                                          <consistency-group>
                                          [<consistency-group> ...]
Copy to Clipboard Toggle word wrap

Expand
表19.9 位置引数
概要

<consistency-group>

削除する整合性グループ (名前または ID)

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表19.11 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表19.12 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表19.14 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表19.15 その他の引数 (オプション):
概要

--all-projects

すべてのプロジェクトの詳細を表示します。管理者のみ (デフォルトは False)

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

19.5. consistency group remove volume

整合性グループからボリュームを削除します。

使用方法

openstack consistency group remove volume [-h]
                                                 <consistency-group> <volume>
                                                 [<volume> ...]
Copy to Clipboard Toggle word wrap

Expand
表19.16 位置引数
概要

<volume>

<consistency-group> (名前または id) から削除するボリューム (複数のボリュームを削除する場合はオプションを繰り返し使用します)

<consistency-group>

<volume>(名前または ID) を含む整合性グループ

Expand
表19.17 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

19.6. consistency group set

整合性グループのプロパティーを設定します。

使用方法

openstack consistency group set [-h] [--name <name>]
                                       [--description <description>]
                                       <consistency-group>
Copy to Clipboard Toggle word wrap

Expand
表19.18 位置引数
概要

<consistency-group>

変更する整合性グループ (名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表19.20 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表19.21 位置引数
概要

<consistency-group>

表示する整合性グループ (名前または ID)

Expand
表19.22 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表19.23 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表19.24 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表19.26 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表19.27 位置引数
概要

<snapshot-name>

新規整合性グループのスナップショット名 (デフォルトは None)

Expand
表19.28 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表19.29 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表19.30 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--consistency-group <consistency-group>

スナップショット (名前または ID) を作成する整合性グループ (デフォルトは <snapshot-name> と同じ)

--description <description>

この整合性グループのスナップショットの説明

Expand
表19.31 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

19.9. consistency group snapshot delete

<consistency-group-snapshot>
[<consistency-group-snapshot> ...]
Copy to Clipboard Toggle word wrap

整合性グループのスナップショットを削除します。

使用方法

openstack consistency group snapshot delete [-h]
Copy to Clipboard Toggle word wrap

Expand
表19.32 位置引数
概要

<consistency-group-snapshot>

削除する整合性グループのスナップショット (名前または ID)

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表19.34 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表19.35 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表19.37 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表19.39 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表19.40 位置引数
概要

<consistency-group-snapshot>

表示する整合性グループのスナップショット (名前または ID)

Expand
表19.41 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表19.42 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表19.43 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表20.1 位置引数
概要

<server>

コンソールログ (名前または ID) を表示するサーバー

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表20.3 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表20.4 位置引数
概要

<server>

URL(名前または ID) を表示するサーバー

Expand
表20.5 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表20.6 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表20.7 その他の引数 (オプション):
概要

--mks

Webmks コンソールの URL を表示します。

--novnc

Novnc コンソール URL を表示します (デフォルト)

--xvpvnc

Xvpvnc コンソール URL を表示します。

--rdp

Rdp コンソールの URL を表示します。

--spice

Spice コンソールの URL を表示します。

-h, --help

ヘルプメッセージを表示して終了します。

--serial

シリアルコンソールの URL を表示します。

Expand
表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> ...]
Copy to Clipboard Toggle word wrap

Expand
表21.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表21.2 位置引数
概要

<container-name>

新しいコンテナー名

Expand
表21.3 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表21.5 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表21.6 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

21.2. container delete

コンテナーを削除します。

使用方法

openstack container delete [-h] [--recursive]
                                  <container> [<container> ...]
Copy to Clipboard Toggle word wrap

Expand
表21.7 位置引数
概要

<container>

削除するコンテナー

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表21.9 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表21.10 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表21.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表21.14 位置引数
概要

<container>

保存するコンテナー

Expand
表21.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

21.5. container set

コンテナープロパティーを設定します。

使用方法

openstack container set [-h] --property <key=value> <container>
Copy to Clipboard Toggle word wrap

Expand
表21.16 位置引数
概要

<container>

変更するコンテナー

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表21.18 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表21.19 位置引数
概要

<container>

表示するコンテナー

Expand
表21.20 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表21.21 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表21.22 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表21.23 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

21.7. container unset

コンテナーのプロパティーの設定を解除します。

使用方法

openstack container unset [-h] --property <key> <container>
Copy to Clipboard Toggle word wrap

Expand
表21.24 位置引数
概要

<container>

変更するコンテナー

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表22.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表22.2 位置引数
概要

workflow_input

ワークフロー入力

workflow_identifier

ワークフローの名前または ID

name

Cron trigger の名前

Expand
表22.3 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表22.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表22.5 その他の引数 (オプション):
概要

--count <integer>

任意の実行数

--first-time <YYYY-MM-DD HH:MM>

最初の実行日時。時間は、--utc も併せて指定されていない場合にローカル時間として処理されます。

--params PARAMS

ワークフローパラメーター

--utc

指定した時間はすべて utc として処理する必要があります。

-h, --help

ヘルプメッセージを表示して終了します。

--pattern <* * * * *>

Cron trigger のパターン

Expand
表22.6 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

22.2. cron trigger delete

トリガーを削除します。

使用方法

openstack cron trigger delete [-h] cron_trigger [cron_trigger ...]
Copy to Clipboard Toggle word wrap

Expand
表22.7 位置引数
概要

cron_trigger

Cron トリガーの名前。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表22.9 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表22.10 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表22.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表22.14 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表22.15 位置引数
概要

cron_trigger

Cron trigger の名前

Expand
表22.16 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表22.17 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表22.18 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表23.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表23.2 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表23.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表23.6 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表23.7 位置引数
概要

<datastore>

データストアの ID

Expand
表23.8 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表23.9 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表23.10 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表23.12 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表23.13 位置引数
概要

<datastore>

データストアの ID または名前

Expand
表23.14 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表23.16 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表23.18 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表23.19 位置引数
概要

<datastore_version>

データストアバージョンの ID または名前。

Expand
表23.20 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表23.21 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表23.22 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--datastore <datastore>

データストアの ID または名前。Datastore_version の ID が指定されている場合はオプションになります。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表24.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表24.2 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表24.3 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表24.4 その他の引数 (オプション):
概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--project-id PROJECT_ID

プロジェクト ID のデフォルト: 現在のプロジェクト

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表24.7 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表24.8 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表24.9 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>

ゾーンクォータの新しい値

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表24.12 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表24.13 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表24.15 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表24.17 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表24.18 位置引数
概要

id

サービスのステータス ID

Expand
表24.19 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表24.20 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表24.21 その他の引数 (オプション):
概要

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

-h, --help

ヘルプメッセージを表示して終了します。

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表25.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表25.2 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表25.3 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表25.4 その他の引数 (オプション):
概要

--user <user>

ユーザーの認証情報を作成します (名前または ID、デフォルト: 現在の認証ユーザー)。

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

プロジェクトで認証情報を作成します (名前または ID、デフォルト: 現在の認証プロジェクト)。

Expand
表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> ...]
Copy to Clipboard Toggle word wrap

Expand
表25.6 位置引数
概要

<access-key>

認証情報アクセスキー

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表25.8 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表25.9 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表25.11 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表25.13 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表25.14 位置引数
概要

<access-key>

認証情報アクセスキー

Expand
表25.15 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表25.16 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表25.17 その他の引数 (オプション):
概要

--user <user>

ユーザーの認証情報 (名前または ID) を表示します。

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表26.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表26.2 位置引数
概要

<service>

新しいエンドポイント (名前または ID) に関連付けるサービス

Expand
表26.3 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表26.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表26.5 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--region <region-id>

新規エンドポイントのリージョン ID

--internalurl <url>

新規エンドポイントの内部 URL

--publicurl <url>

新規エンドポイントのパブリック URL (必須)

--adminurl <url>

新規エンドポイント管理 URL

Expand
表26.6 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

26.2. endpoint delete

エンドポイントを削除します。

使用方法

openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]
Copy to Clipboard Toggle word wrap

Expand
表26.7 位置引数
概要

<endpoint-id>

削除するエンドポイント (id のみ)

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表26.9 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表26.10 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表26.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表26.14 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表26.15 位置引数
概要

<endpoint>

表示するエンドポイント (エンドポイント id、サービス ID、サービス名、サービスタイプ)

Expand
表26.16 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表26.17 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表26.18 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表27.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表27.2 位置引数
概要

workflow_input

ワークフロー入力

name

イベントトリガー名

exchange

イベントトリガーの交換

topic

イベントトリガートピック

workflow_id

ワークフロー id

event

イベントトリガーイベント名

Expand
表27.3 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表27.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表27.5 その他の引数 (オプション):
概要

--params PARAMS

ワークフローパラメーター

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表27.6 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

27.2. event trigger delete

トリガーを削除します。

使用方法

openstack event trigger delete [-h]
                                      event_trigger_id [event_trigger_id ...]
Copy to Clipboard Toggle word wrap

Expand
表27.7 位置引数
概要

event_trigger_id

イベントトリガーの ID。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表27.9 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表27.10 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表27.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表27.14 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表27.15 位置引数
概要

event_trigger

イベントトリガー ID

Expand
表27.16 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表27.17 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表27.18 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表28.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表28.2 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表28.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表28.6 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表28.7 位置引数
概要

<extension>

表示する拡張機能。現在、ネットワーク拡張機能のみがサポートされます。(名前またはエイリアス)

Expand
表28.8 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表28.9 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表28.10 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表29.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表29.2 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表29.3 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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)

Expand
表29.5 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

29.2. firewall group delete

ファイアウォールグループを削除します。

使用方法

openstack firewall group delete [-h]
                                       <firewall-group> [<firewall-group> ...]
Copy to Clipboard Toggle word wrap

Expand
表29.6 位置引数
概要

<firewall-group>

削除するファイアウォールのグループ(名前または ID)

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表29.8 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表29.9 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表29.11 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表29.13 位置引数
概要

<firewall-policy>

ルールを挿入するためのファイアウォールポリシー(名前または ID)

<firewall-rule>

挿入するファイアウォールルール(名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表29.15 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表29.16 位置引数
概要

<name>

ファイアウォールポリシーの名前

Expand
表29.17 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表29.18 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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)

Expand
表29.20 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

29.6. ファイアウォールグループポリシーの削除

ファイアウォールポリシーを削除します。

使用方法

openstack firewall group policy delete [-h]
                                              <firewall-policy>
                                              [<firewall-policy> ...]
Copy to Clipboard Toggle word wrap

Expand
表29.21 位置引数
概要

<firewall-policy>

削除するファイアウォールポリシー(名前または ID)

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表29.23 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表29.24 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表29.26 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表29.27 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

29.8. firewall group policy remove rule

特定のファイアウォールポリシーからルールを削除します。

使用方法

openstack firewall group policy remove rule [-h]
                                                   <firewall-policy>
                                                   <firewall-rule>
Copy to Clipboard Toggle word wrap

Expand
表29.28 位置引数
概要

<firewall-policy>

ルールを削除するファイアウォールポリシー(名前または ID)

<firewall-rule>

ポリシーから削除するファイアウォールルール(名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表29.30 位置引数
概要

<firewall-policy>

更新するファイアウォールポリシー(名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表29.32 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表29.33 位置引数
概要

<firewall-policy>

表示するファイアウォールポリシー(名前または ID)

Expand
表29.34 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表29.35 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表29.36 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表29.38 位置引数
概要

<firewall-policy>

設定を解除するファイアウォールポリシー(名前または ID)

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表29.40 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表29.41 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表29.42 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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}

ファイアウォールルールのプロトコル

Expand
表29.44 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

29.13. firewall group rule delete

ファイアウォールルールを削除します。

使用方法

openstack firewall group rule delete [-h]
                                            <firewall-rule>
                                            [<firewall-rule> ...]
Copy to Clipboard Toggle word wrap

Expand
表29.45 位置引数
概要

<firewall-rule>

削除するファイアウォールルール(名前または ID)

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表29.47 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表29.48 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表29.50 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表29.52 位置引数
概要

<firewall-rule>

設定するファイアウォールルール(名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表29.54 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表29.55 位置引数
概要

<firewall-rule>

表示するファイアウォールルール(名前または ID)

Expand
表29.56 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表29.57 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表29.58 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表29.60 位置引数
概要

<firewall-rule>

設定を解除するファイアウォールルール(名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表29.62 位置引数
概要

<firewall-group>

更新するファイアウォールグループ(名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表29.64 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表29.65 位置引数
概要

<firewall-group>

表示するファイアウォールグループ(名前または ID)

Expand
表29.66 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表29.67 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表29.68 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表29.70 位置引数
概要

<firewall-group>

設定を解除するファイアウォールグループ(名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表30.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表30.2 位置引数
概要

<flavor-name>

新規フレーバー名

Expand
表30.3 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表30.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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

他のプロジェクトでフレーバーが利用できます (デフォルト)

Expand
表30.6 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

30.2. flavor delete

フレーバーを削除します。

使用方法

openstack flavor delete [-h] <flavor> [<flavor> ...]
Copy to Clipboard Toggle word wrap

Expand
表30.7 位置引数
概要

<flavor>

削除するフレーバー (名前または ID)

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表30.9 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表30.10 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表30.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表30.14 位置引数
概要

<flavor>

変更するフレーバー (名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表30.16 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表30.17 位置引数
概要

<flavor>

表示するフレーバー (名前または ID)

Expand
表30.18 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表30.19 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表30.20 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表30.22 位置引数
概要

<flavor>

変更するフレーバー (名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表31.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表31.2 位置引数
概要

<network>

Floating IP の割り当て元のネットワーク (名前または ID)

Expand
表31.3 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表31.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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) を作成するサブネット

Expand
表31.6 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

31.2. floating ip delete

Floating IP を削除します。

使用方法

openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]
Copy to Clipboard Toggle word wrap

Expand
表31.7 位置引数
概要

<floating-ip>

削除する Floating IP(IP アドレスまたは ID)

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表31.9 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表31.10 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表31.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表31.14 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表31.15 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表31.17 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表31.19 位置引数
概要

<floating-ip>

変更する Floating IP(IP アドレスまたは ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表31.21 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表31.22 位置引数
概要

<floating-ip>

表示する Floating IP(IP アドレスまたは ID)

Expand
表31.23 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表31.24 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表31.25 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表31.27 位置引数
概要

<floating-ip>

関連付けを解除する Floating IP(IP アドレスまたは ID)

Expand
表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 ...]]
Copy to Clipboard Toggle word wrap

Expand
表32.1 位置引数
概要

cmd

コマンドの名前

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表33.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表33.2 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表33.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表33.5 その他の引数 (オプション):
概要

--zone <zone>

アベイラビリティーゾーン内のホストのみを返します。

-h, --help

ヘルプメッセージを表示して終了します。

33.2. host set

ホスト属性を設定します。

使用方法

openstack host set [-h] [--enable | --disable]
                          [--enable-maintenance | --disable-maintenance]
                          <host>
Copy to Clipboard Toggle word wrap

Expand
表33.6 位置引数
概要

<host>

変更するホスト (名前のみ)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表33.8 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表33.9 位置引数
概要

<host>

ホスト名

Expand
表33.10 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表33.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表34.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表34.2 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表34.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表34.6 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表34.7 位置引数
概要

<hypervisor>

表示するハイパーバイザー (名前または ID)

Expand
表34.8 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表34.9 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表34.10 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表34.12 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表34.13 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表34.14 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表34.15 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表35.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表35.2 位置引数
概要

<image>

共有するイメージ (名前または ID)

<project>

イメージに関連付けるプロジェクト(名前または ID)

Expand
表35.3 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表35.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表35.5 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表35.7 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表35.8 位置引数
概要

<image-name>

新しいイメージ名

Expand
表35.9 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表35.10 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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

イメージが削除されないようにします。

Expand
表35.12 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

35.3. image delete

イメージを削除します。

使用方法

openstack image delete [-h] <image> [<image> ...]
Copy to Clipboard Toggle word wrap

Expand
表35.13 位置引数
概要

<image>

削除するイメージ (名前または ID)

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表35.15 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表35.16 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表35.18 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表35.20 位置引数
概要

<image>

共有を解除するイメージ (名前または ID)

<project>

イメージとの関連付けを解除するプロジェクト (名前または ID)

Expand
表35.21 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

35.6. image save

イメージをローカルに保存します。

使用方法

openstack image save [-h] [--file <filename>] <image>
Copy to Clipboard Toggle word wrap

Expand
表35.22 位置引数
概要

<image>

保存するイメージ (名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表35.24 位置引数
概要

<image>

変更するイメージ (名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表35.26 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表35.27 位置引数
概要

<image>

表示するイメージ (名前または ID)

Expand
表35.28 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表35.29 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表35.30 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--human-readable

人間が解読しやすい形式でイメージサイズを出力します。

Expand
表35.31 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

35.9. image unset

イメージタグおよび属性の設定を解除します。

使用方法

openstack image unset [-h] [--tag <tag>] [--property <property-key>]
                             <image>
Copy to Clipboard Toggle word wrap

Expand
表35.32 位置引数
概要

<image>

変更するイメージ (名前または ID)

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表36.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表36.2 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表36.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表36.6 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表36.7 位置引数
概要

<network>

特定のネットワークの ip 可用性を表示します (名前または ID)。

Expand
表36.8 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表36.9 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表36.10 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表37.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表37.2 位置引数
概要

<name>

新しい公開鍵または秘密鍵名

Expand
表37.3 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表37.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表37.5 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--public-key <file>

追加する公開鍵のファイル名。使用されていない場合は、秘密鍵を作成します。

--private-key <file>

保存する秘密鍵のファイル名。使用されていない場合は、秘密鍵をコンソールに出力します。

Expand
表37.6 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

37.2. keypair delete

公開鍵または秘密鍵を削除します。

使用方法

openstack keypair delete [-h] <key> [<key> ...]
Copy to Clipboard Toggle word wrap

Expand
表37.7 位置引数
概要

<key>

削除する鍵の名前 (名前のみ)

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表37.9 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表37.10 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表37.12 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表37.14 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表37.15 位置引数
概要

<key>

表示する公開鍵または秘密鍵 (名前のみ)

Expand
表37.16 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表37.17 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表37.18 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--public-key

生成された鍵とペアになったベア公開鍵のみを表示します。

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表38.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表38.2 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表38.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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}]
Copy to Clipboard Toggle word wrap

Expand
表39.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.2 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表39.4 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.6 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.7 位置引数
概要

<amphora-id>

amphora の UUID

Expand
表39.8 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.9 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.10 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表39.12 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.13 VIP ネットワーク
概要

--vip-network-id <vip_network_id>

ロードバランサーにネットワークを設定します (名前または id)。

--vip-subnet-id <vip_subnet_id>

ロードバランサーにサブネットを設定します (名前または ID)。

少なくとも以下の引数のいずれかが必要です。--vip-port-id <vip_port_id>

ロードバランサーのポートを設定します (名前または id)。

Expand
表39.14 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.15 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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)。

Expand
表39.17 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.4. loadbalancer delete

ロードバランサーを削除します。

使用方法

openstack loadbalancer delete [-h] [--cascade] <load_balancer>
Copy to Clipboard Toggle word wrap

Expand
表39.18 位置引数
概要

<load_balancer>

削除するロードバランサー (名前または ID)

Expand
表39.19 その他の引数 (オプション):
概要

--cascade

削除をロードバランサーのすべての子要素に適用します。

-h, --help

ヘルプメッセージを表示して終了します。

39.5. loadbalancer failover

ロードバランサーのフェイルオーバーをトリガーします。

使用方法

openstack loadbalancer failover [-h] <load_balancer>
Copy to Clipboard Toggle word wrap

Expand
表39.20 位置引数
概要

<load_balancer>

ロードバランサーの名前または uuid

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.22 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.23 位置引数
概要

<pool>

ヘルスモニターのプールを設定します (名前または ID)。

Expand
表39.24 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.25 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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 パスを設定します。

Expand
表39.27 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.7. loadbalancer healthmonitor delete

ヘルスモニターを削除します。

使用方法

openstack loadbalancer healthmonitor delete [-h] <health_monitor>
Copy to Clipboard Toggle word wrap

Expand
表39.28 位置引数
概要

<health_monitor>

削除するヘルスモニター (名前または ID)

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表39.30 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.31 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表39.33 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.35 位置引数
概要

<health_monitor>

更新するヘルスモニター (名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.37 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.38 位置引数
概要

<health_monitor>

ヘルスモニターの名前または uuid。

Expand
表39.39 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.40 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.41 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.43 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.44 位置引数
概要

<listener>

l7policy をに追加するリスナー (名前または id)。

Expand
表39.45 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.46 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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 の説明を設定します。

Expand
表39.48 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.12. loadbalancer l7policy delete

l7policy を削除します。

使用方法

openstack loadbalancer l7policy delete [-h] <policy>
Copy to Clipboard Toggle word wrap

Expand
表39.49 位置引数
概要

<policy>

削除する L7policy(名前または ID)。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表39.51 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.52 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表39.54 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.56 位置引数
概要

<policy>

更新する L7policy(名前または ID)。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.58 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.59 位置引数
概要

<policy>

l7policy の名前または uuid

Expand
表39.60 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.61 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.62 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.64 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.65 位置引数
概要

<l7policy>

l7rule を追加する L7policy(名前または ID)。

Expand
表39.66 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.67 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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 の比較タイプを設定します。

Expand
表39.69 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.17. loadbalancer l7rule delete

l7rule を削除します。

使用方法

openstack loadbalancer l7rule delete [-h] <l7policy> <rule_id>
Copy to Clipboard Toggle word wrap

Expand
表39.70 位置引数
概要

<l7policy>

ルールを削除する L7policy(名前または ID)

<rule_id>

削除する L7rule。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.72 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.73 位置引数
概要

<l7policy>

ルールを一覧表示する L7policy(名前または ID)

Expand
表39.74 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表39.76 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.78 位置引数
概要

<l7policy>

l7rule を更新する l7policy(名前または id)

<l7rule_id>

更新する L7rule。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.80 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.81 位置引数
概要

<l7policy>

ルールを表示する L7policy(名前または ID)。

<l7rule_id>

表示する L7rule。

Expand
表39.82 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.83 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.84 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表39.86 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.87 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表39.89 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.91 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.92 位置引数
概要

<loadbalancer>

リスナーのロードバランサー (名前または id)

Expand
表39.93 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.94 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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。

Expand
表39.96 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.23. loadbalancer listener delete

リスナーを削除します。

使用方法

openstack loadbalancer listener delete [-h] <listener>
Copy to Clipboard Toggle word wrap

Expand
表39.97 位置引数
概要

<listener>

削除するリスナー (名前または ID)

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表39.99 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.100 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表39.102 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.104 位置引数
概要

<listener>

変更するリスナー (名前または ID)。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.106 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.107 位置引数
概要

<listener>

リスナーの名前または uuid

Expand
表39.108 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.109 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.110 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.112 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.113 位置引数
概要

<listener>

リスナーの名前または uuid

Expand
表39.114 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.115 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.116 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.118 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.119 位置引数
概要

<pool>

メンバーを作成するプールの ID または名前。

Expand
表39.120 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.121 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>

プールの他のメンバーと比較して、提供する要求または接続の部分を決定するメンバーの重み。

Expand
表39.123 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.29. loadbalancer member delete

プールからメンバーを削除します。

使用方法

openstack loadbalancer member delete [-h] <pool> <member>
Copy to Clipboard Toggle word wrap

Expand
表39.124 位置引数
概要

<member>

削除するメンバーの名前または ID。

<pool>

メンバーを削除するプール名または id。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.126 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.127 位置引数
概要

<pool>

メンバーを一覧表示するプール名または id。

Expand
表39.128 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表39.130 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.132 位置引数
概要

<member>

更新するメンバーの名前または ID

<pool>

更新するメンバーが属するプール (名前または ID)。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.134 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.135 位置引数
概要

<member>

表示するメンバーの名前または ID。

<pool>

メンバーを表示するプール名または id。

Expand
表39.136 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.137 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.138 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表39.140 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.141 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.142 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>

プールの説明を設定します。

Expand
表39.144 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

39.34. loadbalancer pool delete

プールを削除します。

使用方法

openstack loadbalancer pool delete [-h] <pool>
Copy to Clipboard Toggle word wrap

Expand
表39.145 位置引数
概要

<pool>

削除するプール (名前または ID)

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表39.147 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.148 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表39.150 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.152 位置引数
概要

<pool>

更新するプール (名前または ID)。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.154 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.155 位置引数
概要

<pool>

プールの名前または uuid。

Expand
表39.156 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.157 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.158 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表39.160 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.161 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.162 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.163 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表39.165 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.166 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表39.168 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.169 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project-id>

プロジェクトの名前または uuid。

39.40. loadbalancer quota reset

クォータをデフォルトのクォータにリセットします。

使用方法

openstack loadbalancer quota reset [-h] <project>
Copy to Clipboard Toggle word wrap

Expand
表39.170 位置引数
概要

<project>

クォータをリセットするプロジェクト (名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.172 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.173 位置引数
概要

<project>

プロジェクトの名前または uuid。

Expand
表39.174 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.175 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.176 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表39.177 クォータの制限
概要

--member <member>

メンバークォータ制限の新しい値。値が -1 の場合は無制限を意味します。

以下の引数のいずれかが必要です。--healthmonitor <health_monitor>

ヘルスモニタークォータの新しい値。値が -1 の場合は無制限を意味します。

--loadbalancer <load_balancer>

ロードバランサークォータ制限の新しい値。値が -1 の場合は無制限を意味します。

--pool <pool>

プールクォータ制限の新しい値。値が -1 の場合は無制限を意味します。

--listener <listener>

リスナークォータの新しい値。値が -1 の場合は無制限を意味します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.179 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.180 位置引数
概要

<project>

プロジェクトの名前または uuid。

Expand
表39.181 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.182 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.183 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.185 位置引数
概要

<load_balancer>

更新するロードバランサーの名前または uuid

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.187 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.188 位置引数
概要

<load_balancer>

ロードバランサーの名前または uuid

Expand
表39.189 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.190 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.191 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表39.193 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表39.194 位置引数
概要

<load_balancer>

ロードバランサーの名前または uuid

Expand
表39.195 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表39.196 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表39.197 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.2 位置引数
概要

<queue_name>

要求するキューの名前

Expand
表40.3 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表40.5 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.7 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.8 位置引数
概要

<claim_id>

要求の ID

<queue_name>

要求されたキューの名前

Expand
表40.9 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表40.11 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.12 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

40.3. messaging claim release

要求を削除します。

使用方法

openstack messaging claim release [-h] <queue_name> <claim_id>
Copy to Clipboard Toggle word wrap

Expand
表40.13 位置引数
概要

<claim_id>

削除する要求 ID

<queue_name>

要求されたキューの名前

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.15 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.16 位置引数
概要

<claim_id>

要求 ID

<queue_name>

要求されたキューの名前

Expand
表40.17 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表40.19 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.21 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.22 位置引数
概要

<pool_group>

フレーバーのプールグループ

<flavor_name>

フレーバーの名前

Expand
表40.23 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.24 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.25 その他の引数 (オプション):
概要

--capabilities <capabilities>

フレーバー固有の機能を記述します。このオプションはクライアント api バージョン が 2 より前の場合のみ利用可能です。

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表40.26 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.6. messaging flavor delete

プールのフレーバーを削除します。

使用方法

openstack messaging flavor delete [-h] <flavor_name>
Copy to Clipboard Toggle word wrap

Expand
表40.27 位置引数
概要

<flavor_name>

フレーバーの名前

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表40.29 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.30 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表40.32 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.34 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.35 位置引数
概要

<flavor_name>

表示するフレーバー (名前)

Expand
表40.36 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.37 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.38 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.40 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.41 位置引数
概要

<flavor_name>

フレーバーの名前

Expand
表40.42 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.43 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.44 その他の引数 (オプション):
概要

--pool_group <pool_group>

フレーバーが存在するプールグループ

-h, --help

ヘルプメッセージを表示して終了します。

--capabilities <capabilities>

フレーバー固有の機能を説明します。

Expand
表40.45 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.10. messaging health

Zaqar サーバーの詳細なヘルスステータスを表示します。

使用方法

openstack messaging health [-h]
Copy to Clipboard Toggle word wrap

Expand
表40.46 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

40.11. messaging homedoc

Zaqar サーバーの詳細なリソースドキュメントを表示します。

使用方法

openstack messaging homedoc [-h]
Copy to Clipboard Toggle word wrap

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.48 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.49 位置引数
概要

<queue_name>

キューの名前

Expand
表40.50 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表40.52 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.54 位置引数
概要

<messages>

投稿されるメッセージ。

<queue_name>

キューの名前

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表40.56 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.57 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.58 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.59 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.61 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.62 位置引数
概要

<pool_weight>

プールの重み

<pool_name>

プールの名前

<pool_uri>

ストレージエンジン URI

Expand
表40.63 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.64 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.65 その他の引数 (オプション):
概要

--pool_group <pool_group>

プールのグループ

-h, --help

ヘルプメッセージを表示して終了します。

--pool_options <pool_options>

ストレージ固有のオプションに関連するオプションの要求コンポーネント

Expand
表40.66 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.16. messaging pool delete

プールを削除します。

使用方法

openstack messaging pool delete [-h] <pool_name>
Copy to Clipboard Toggle word wrap

Expand
表40.67 位置引数
概要

<pool_name>

プールの名前

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表40.69 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.70 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表40.72 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.74 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.75 位置引数
概要

<pool_name>

表示するプール (名前)

Expand
表40.76 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.77 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.78 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.80 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.81 位置引数
概要

<pool_name>

プールの名前

Expand
表40.82 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.83 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.84 その他の引数 (オプション):
概要

--pool_group <pool_group>

プールのグループ

-h, --help

ヘルプメッセージを表示して終了します。

--pool_options <pool_options>

ストレージ固有のオプションに関連するオプションの要求コンポーネント

--pool_uri <pool_uri>

ストレージエンジン URI

--pool_weight <pool_weight>

プールの重み

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.86 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.87 位置引数
概要

<queue_name>

キューの名前

Expand
表40.88 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.89 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.90 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表40.91 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.21. messaging queue delete

キューを削除します。

使用方法

openstack messaging queue delete [-h] <queue_name>
Copy to Clipboard Toggle word wrap

Expand
表40.92 位置引数
概要

<queue_name>

キューの名前

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.94 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.95 位置引数
概要

<queue_name>

キューの名前

Expand
表40.96 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.97 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.98 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表40.100 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.101 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表40.103 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.105 位置引数
概要

<queue_name>

キューの名前

Expand
表40.106 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource_types <resource_types>

パージするリソースタイプ。

40.25. messaging queue set metadata

キューのメタデータを設定します。

使用方法

openstack messaging queue set metadata [-h]
                                              <queue_name> <queue_metadata>
Copy to Clipboard Toggle word wrap

Expand
表40.107 位置引数
概要

<queue_name>

キューの名前

<queue_metadata>

キューメタデータ。キューのメタデータはすべて queue_metadata に置き換えられます。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.109 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.110 位置引数
概要

<queue_name>

キューの名前

Expand
表40.111 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.112 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.113 その他の引数 (オプション):
概要

--ttl-seconds <ttl_seconds>

署名の有効期限が切れるまでの期間 (秒単位)

-h, --help

ヘルプメッセージを表示して終了します。

--paths <paths>

許可されるパスのコンマ区切りリスト。オプション:messages、subscriptions、claims

--methods <methods>

許可する HTTP メソッドのコンマ区切りリスト。オプション:GET、HEAD、OPTIONS、POST、PUT、DELETE

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.115 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.116 位置引数
概要

<queue_name>

キューの名前

Expand
表40.117 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.118 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.119 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.121 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.122 位置引数
概要

<subscriber>

通知されるサブスクライバー

<ttl>

サブスクリプションの存続期間 (秒単位)

<queue_name>

サブスクライブするキューの名前

Expand
表40.123 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.124 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.125 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--options <options>

json 形式のサブスクリプションのメタデータ

Expand
表40.126 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

40.29. messaging subscription delete

サブスクリプションを削除します。

使用方法

openstack messaging subscription delete [-h]
                                               <queue_name> <subscription_id>
Copy to Clipboard Toggle word wrap

Expand
表40.127 位置引数
概要

<subscription_id>

サブスクリプションの ID

<queue_name>

サブスクリプションのキューの名前

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.129 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.130 位置引数
概要

<queue_name>

サブスクライブするキューの名前

Expand
表40.131 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表40.133 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.135 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.136 位置引数
概要

<subscription_id>

サブスクリプションの ID

<queue_name>

サブスクライブするキューの名前

Expand
表40.137 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.138 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.139 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表40.141 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表40.142 位置引数
概要

<subscription_id>

サブスクリプションの ID

<queue_name>

サブスクライブするキューの名前

Expand
表40.143 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表40.144 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表40.145 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--options <options>

json 形式のサブスクリプションのメタデータ

--subscriber <subscriber>

通知されるサブスクライバー

--ttl <ttl>

サブスクリプションの存続期間 (秒単位)

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表41.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表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 です。

Expand
表41.3 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表41.5 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.7 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.8 位置引数
概要

name

アーカイブポリシーの名前

Expand
表41.9 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.10 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.11 その他の引数 (オプション):
概要

-D <DEFINITION>、--definition <DEFINITION>

名前と値を:で区切った、アーカイブポリシー定義の (,で区切られた)2 つの属性

-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS

アーカイブポリシーの集約メソッド

-h, --help

ヘルプメッセージを表示して終了します。

-b BACK_WINDOW, --back-window BACK_WINDOW

アーカイブポリシーのバックウィンドウ

Expand
表41.12 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.3. metric archive-policy delete

アーカイブポリシーを削除します。

使用方法

openstack metric archive-policy delete [-h] name
Copy to Clipboard Toggle word wrap

Expand
表41.13 位置引数
概要

name

アーカイブポリシーの名前

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表41.15 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.16 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表41.18 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.20 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.21 位置引数
概要

name

ルール名

Expand
表41.22 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.23 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.24 その他の引数 (オプション):
概要

-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME

アーカイブポリシー名

-h, --help

ヘルプメッセージを表示して終了します。

-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN

照合するメトリクス名のワイルドカード

Expand
表41.25 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.6. metric archive-policy-rule delete

アーカイブポリシールールを削除します。

使用方法

openstack metric archive-policy-rule delete [-h] name
Copy to Clipboard Toggle word wrap

Expand
表41.26 位置引数
概要

name

アーカイブポリシールールの名前

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表41.28 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.29 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表41.31 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.33 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.34 位置引数
概要

name

アーカイブポリシールールの名前

Expand
表41.35 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.36 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.37 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.39 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.40 位置引数
概要

name

アーカイブポリシーの名前

Expand
表41.41 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.42 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.43 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.45 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.46 位置引数
概要

name

アーカイブポリシーの名前

Expand
表41.47 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.48 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.49 その他の引数 (オプション):
概要

-D <DEFINITION>、--definition <DEFINITION>

名前と値を:で区切った、アーカイブポリシー定義の (,で区切られた)2 つの属性

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.51 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.52 位置引数
概要

metric

メトリクスの ID または名前

Expand
表41.53 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.54 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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

使用する最終タイムスタンプ

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.57 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.58 位置引数
概要

metric

メトリクスの ID または名前

Expand
表41.59 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表41.60 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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

ヘルプメッセージを表示して終了します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表41.63 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.64 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.65 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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

ヘルプメッセージを表示して終了します。

Expand
表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 ...]
Copy to Clipboard Toggle word wrap

Expand
表41.68 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.69 位置引数
概要

metric

メトリクス ID または名前

Expand
表41.70 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.71 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.72 その他の引数 (オプション):
概要

--count COUNT, -n COUNT

取得するメトリクスの数

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--workers WORKERS, -w WORKERS

使用するワーカー数

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表41.74 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.75 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.76 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.77 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表41.79 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.80 位置引数
概要

METRIC_NAME

メトリクスの名前

Expand
表41.81 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.82 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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

アーカイブポリシーの名前

Expand
表41.84 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.17. metric delete

メトリクスを削除します。

使用方法

openstack metric delete [-h] [--resource-id RESOURCE_ID]
                               metric [metric ...]
Copy to Clipboard Toggle word wrap

Expand
表41.85 位置引数
概要

metric

メトリクスの ID または名前

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表41.87 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.88 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表41.90 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.92 位置引数
概要

metric

メトリクスの ID または名前

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表41.94 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.95 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表41.97 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.99 位置引数
概要

file

バッチ処理または stdin の測定値が含まれるファイル (形式は Gnocchi REST API のドキュメントを参照してください)。

Expand
表41.100 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

41.22. metric measures batch-resources-metrics

使用方法

openstack metric measures batch-resources-metrics [-h]
                                                         [--create-metrics]
                                                         file
Copy to Clipboard Toggle word wrap

Expand
表41.101 位置引数
概要

file

バッチ処理または stdin の測定値が含まれるファイル (形式は Gnocchi REST API のドキュメントを参照してください)。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.103 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.104 位置引数
概要

metric

メトリクスの ID または名前

Expand
表41.105 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表41.107 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表41.109 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.110 位置引数
概要

METRIC_NAME

メトリクスの名前

Expand
表41.111 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.112 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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

アーカイブポリシーの名前

Expand
表41.114 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.25. metric metric delete

非推奨: メトリクスを削除します。

使用方法

openstack metric metric delete [-h] [--resource-id RESOURCE_ID]
                                      metric [metric ...]
Copy to Clipboard Toggle word wrap

Expand
表41.115 位置引数
概要

metric

メトリクスの ID または名前

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表41.117 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.118 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表41.120 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.122 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.123 位置引数
概要

metric

メトリクスの ID または名前

Expand
表41.124 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.125 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.126 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.128 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表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 です。

Expand
表41.130 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.131 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.132 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.134 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.135 位置引数
概要

resource_id

リソースの ID

Expand
表41.136 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.137 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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

リソースのタイプ

Expand
表41.139 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.30. metric resource delete

リソースを削除します。

使用方法

openstack metric resource delete [-h] resource_id
Copy to Clipboard Toggle word wrap

Expand
表41.140 位置引数
概要

resource_id

リソースの ID

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.142 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.143 位置引数
概要

resource_id

リソースの ID

Expand
表41.144 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表41.146 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表41.148 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.149 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表41.151 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.159 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.160 位置引数
概要

resource_id

リソースの ID

Expand
表41.161 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.162 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.163 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.165 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.166 位置引数
概要

name

リソース種別の名前

Expand
表41.167 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.168 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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

Expand
表41.170 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

41.36. metric resource-type delete

リソース種別を削除します。

使用方法

openstack metric resource-type delete [-h] name
Copy to Clipboard Toggle word wrap

Expand
表41.171 位置引数
概要

name

リソース種別の名前

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表41.173 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.174 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表41.176 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.178 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.179 位置引数
概要

name

リソース種別の名前

Expand
表41.180 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.181 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.182 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.184 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.185 位置引数
概要

name

リソース種別の名前

Expand
表41.186 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.187 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.190 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.191 位置引数
概要

resource_id

リソースの ID

Expand
表41.192 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.193 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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

:で区切った属性の名前および値

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表41.196 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.197 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.198 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.199 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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
Copy to Clipboard Toggle word wrap

Expand
表41.201 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.202 位置引数
概要

metric

メトリクスの ID または名前

Expand
表41.203 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.204 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.205 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表41.207 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表41.208 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表41.209 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表41.210 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表42.1 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表42.2 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表42.3 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表42.4 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--all

バージョン情報を持つモジュールをすべて表示します。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表43.1 位置引数
概要

<agent-id>

ネットワークが追加されるエージェント (id のみ)

<network>

エージェントに追加されるネットワーク (名前または ID)

Expand
表43.2 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--dhcp

dhcp エージェントにネットワークを追加します。

43.2. network agent add router

エージェントにルーターを追加します。

使用方法

openstack network agent add router [-h] [--l3] <agent-id> <router>
Copy to Clipboard Toggle word wrap

Expand
表43.3 位置引数
概要

<agent-id>

ルーターが追加されるエージェント (id のみ)

<router>

エージェントに追加されるルーター (名前または ID)

Expand
表43.4 その他の引数 (オプション):
概要

--l3

ルーターを l3 エージェントに追加します。

-h, --help

ヘルプメッセージを表示して終了します。

43.3. network agent delete

ネットワークエージェントを削除します。

使用方法

openstack network agent delete [-h]
                                      <network-agent> [<network-agent> ...]
Copy to Clipboard Toggle word wrap

Expand
表43.5 位置引数
概要

<network-agent>

削除するネットワークエージェント (id のみ)

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表43.7 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表43.8 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表43.10 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表43.12 位置引数
概要

<agent-id>

ネットワークを削除するエージェント (id のみ)

<network>

エージェントから削除されるネットワーク (名前または ID)

Expand
表43.13 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--dhcp

dhcp エージェントからネットワークを削除します。

43.6. network agent remove router

エージェントからルーターを削除します。

使用方法

openstack network agent remove router [-h] [--l3] <agent-id> <router>
Copy to Clipboard Toggle word wrap

Expand
表43.14 位置引数
概要

<agent-id>

ルーターを削除するエージェント (id のみ)

<router>

エージェントから削除されるルーター (名前または ID)

Expand
表43.15 その他の引数 (オプション):
概要

--l3

l3 エージェントからルーターを削除します。

-h, --help

ヘルプメッセージを表示して終了します。

43.7. network agent set

ネットワークエージェントの属性を設定します。

使用方法

openstack network agent set [-h] [--description <description>]
                                   [--enable | --disable]
                                   <network-agent>
Copy to Clipboard Toggle word wrap

Expand
表43.16 位置引数
概要

<network-agent>

変更するネットワークエージェント (id のみ)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表43.18 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表43.19 位置引数
概要

<network-agent>

表示するネットワークエージェント (id のみ)

Expand
表43.20 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表43.21 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表43.22 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表43.24 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表43.25 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表43.26 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表43.27 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

--check-resources

自動割り当てトポロジーの要件を検証します。トポロジーを返しません。

--or-show

トポロジーが存在する場合は、トポロジーの情報を返します (デフォルト)。

--project <project>

指定されたプロジェクトに対して自動的に割り当てられたトポロジーを返します。デフォルトは現在のプロジェクトです。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表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>]
Copy to Clipboard Toggle word wrap

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表43.30 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表43.31 位置引数
概要

<name>

新しいネットワーク名

Expand
表43.32 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表43.33 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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

ネットワークをデフォルトの外部ネットワークとして使用しません (デフォルト)。

Expand
表43.35 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.12. network delete

ネットワークを削除します。

使用方法

openstack network delete [-h] <network> [<network> ...]
Copy to Clipboard Toggle word wrap

Expand
表43.36 位置引数
概要

<network>

削除するネットワーク (名前または ID)

Expand
表43.37 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

43.13. network flavor add profile

サービスプロファイルをネットワークフレーバーに追加します。

使用方法

openstack network flavor add profile [-h] <flavor> <service-profile>
Copy to Clipboard Toggle word wrap

Expand
表43.38 位置引数
概要

<service-profile>

サービスプロファイル (id のみ)

<flavor>

ネットワークフレーバー (名前または ID)

Expand
表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>
Copy to Clipboard Toggle word wrap

Expand
表43.40 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表43.41 位置引数
概要

<name>

フレーバーの名前

Expand
表43.42 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表43.43 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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)。プロジェクト名の競合が発生してしまった場合に、使用できます。

Expand
表43.45 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.15. network flavor delete

ネットワークフレーバーを削除します。

使用方法

openstack network flavor delete [-h] <flavor> [<flavor> ...]
Copy to Clipboard Toggle word wrap

Expand
表43.46 位置引数
概要

<flavor>

削除するフレーバー (名前または ID)

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表43.48 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表43.49 CSV 書式設定
概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

Expand
表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

データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。

Expand
表43.51 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表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]
Copy to Clipboard Toggle word wrap

Expand
表43.53 表の書式設定
概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

Expand
表43.54 出力形式の設定
概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

Expand
表43.55 JSON 書式設定
概要

--noindent

Json のインデントを無効にするかどうか。

Expand
表43.56 その他の引数 (オプション):
概要

--description <description>

フレーバープロファイルの説明

--driver DRIVER

ドライバーへの Python モジュールパス。これは、--metainfo がない場合は必須です (逆の場合も同様)。

--enable

フレーバープロファイルを有効にします。

--project-domain <project-domain>

プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

-h, --help

ヘルプメッセージを表示して終了します。

--disable

フレーバープロファイルを無効にします。

--project <project>

所有者のプロジェクト (名前または ID)

--metainfo METAINFO

フレーバープロファイルの metainfo。これは、--driver がない場合は必須です (逆の場合も同様)。

Expand
表43.57 Shell フォーマッター
概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。

43.18. network flavor profile delete

ネットワークフレーバープロファイルを削除します。

使用方法

openstack network flavor profile delete [-h]
                                               <flavor-profile>
                                               [<flavor-profile> ...]
Copy to Clipboard Toggle word wrap

Expand
表43.58 位置引数
概要

<flavor-profile>

削除するフレーバープロファイル (id のみ)

Expand
表43.59 その他の引数 (オプション):
概要

-h, --help

ヘルプメッセージを表示して終了します。

43.19. network flavor profile list