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

Red Hat OpenStack Platform 16.0

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

概要

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

前書き

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

第1章 OpenStack クライアント

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

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

使用方法

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

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

概要

--version

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

-v、--verbose

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

-q, --quiet

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

--log-file LOG_FILE

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

-h, --help

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

--debug

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

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

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

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

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

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

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

--os-cert <certificate-file>

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

--os-key <key-file>

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

--verify

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

--insecure

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

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

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

--os-interface <interface>

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

--os-service-provider <service_provider>

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

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

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

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

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

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

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

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

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

--timing

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

--os-beta-command

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

--os-profile hmac-key

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

--os-data-processing-url OS_DATA_PROCESSING_URL

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

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

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

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

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

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

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

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

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

--inspector-api-version INSPECTOR_API_VERSION

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

--inspector-url INSPECTOR_URL

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

v3totp を使用したシステム操作の token: スコープを使用。 パスワードによるシステム操作のスコープ v3password を使用するシステム操作の範囲: v3applicationcredential を使用するシステム操作の範囲: v3oidcpassword を使用するシステム操作の範囲: v3multifactor を使用したシステム操作の範囲: v3oidcaccesstoken を使用するシステム操作のスコープ。 v3oidcauthcode を使用するシステム操作の範囲: v3adfspassword を使用するシステム操作の範囲: v3samlpassword を使用するシステム操作の範囲: v3oidcclientcredentials を使用するシステム操作の範囲: v3token を使用するシステム操作の範囲: システム操作のスコープ(Env: SYSTEM_SYSTEM_SCOPE)

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

token: domain id を使用して、v3totp: ドメイン ID を使用してスコープを With password にします。 v3password のスコープに設定するドメイン ID: v3applicationcredential のスコープに設定するドメイン ID: v3oidcpassword のスコープに設定するドメイン ID: v3multifactor のスコープに設定するドメイン ID: v3oidcaccesstoken のスコープに設定するドメイン ID: v3oidcauthcode のスコープに設定するドメイン ID: v3adfspassword のスコープに設定するドメイン ID: v3samlpassword のスコープに設定するドメイン ID: v3oidcclientcredentials のスコープに設定するドメイン ID: v3token のスコープに設定するドメイン ID: v3tokenlessauth にバインドするドメイン ID: スコープするドメイン ID(Env: os_DOMAIN_ID)

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

token: スコープを v3totp でスコープ設定するドメイン名を使用する場合: スコープを password に指定するドメイン名: v3password のスコープに設定するドメイン名 v3applicationcredential に適用するドメイン名 v3oidcpassword のスコープに設定するドメイン名: v3multifactor のスコープに設定するドメイン名 v3oidcaccesstoken のスコープに設定するドメイン名: v3oidcauthcode のスコープに設定するドメイン名: v3adfspassword のスコープに設定するドメイン名 v3samlpassword のスコープに設定するドメイン名 v3oidcclientcredentials のスコープに設定するドメイン名 With v3token にバインドするドメイン名 v3tokenlessauth にバインドするドメイン名 スコープするドメイン名(Env: Env): os_domain_name)

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

token: プロジェクト ID を使用して v3totp のスコープを設定します。 With password にバインドするプロジェクト ID: スコープを v3password でスコープ設定するプロジェクト ID: v3applicationcredential のスコープに設定するプロジェクト ID: V3oidcpassword のスコープに設定するプロジェクト ID: aodh- noauth によりスコープをするプロジェクト ID: gnocchi-noauth を使用したプロジェクト ID: v3multifactor を使用したプロジェクト ID: V3oidcaccesstoken のスコープに設定するプロジェクト ID: v3oidcauthcode のスコープに設定するプロジェクト ID: noauth にバインドするプロジェクト ID: v3adfspassword を使用したプロジェクト ID: v3samlpassword のスコープに設定するプロジェクト ID: V3oidcclientcredentials のスコープに設定するプロジェクト ID: With v3token にバインドするプロジェクト ID: v3tokenlessauth のスコープに設定するプロジェクト ID: スコープするプロジェクト ID(Env: os_PROJECT_ID)

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

token: スコープを v3totp でスコープ設定するプロジェクト名の場合: スコープ指定に使用するプロジェクト名(with password): スコープを設定するプロジェクト名(With v3password): v3applicationcredential のスコープに設定するプロジェクト名 スコープを With v3oidcpassword に指定するプロジェクト名: スコープを指定するプロジェクト名(with v3multifactor): Project name to scope to With v3oidcaccesstoken: v3oidcauthcode のスコープに設定するプロジェクト名: スコープを指定するプロジェクト名(v1password): v3adfspassword で使用する Swift アカウント: v3samlpassword のスコープに設定するプロジェクト名: スコープを指定するプロジェクト名(With v3oidcclientcredentials): With v3token にバインドするプロジェクト名: v3tokenlessauth スコープに設定するプロジェクト名: スコープするプロジェクト名(Env: os_PROJECT_NAME)

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

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

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

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

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

token: trust id with v3totp: trust id with password: v3password を使用した信頼 ID v3applicationcredential を使用した信頼 ID: v2password を使用した信頼 ID: v3oidcpassword を使用した信頼 ID: v3multifactor を使用した信頼 ID: v3oidcaccesstoken を使用した信頼 ID: v3oidcauthcode を使用する信頼 ID: v3adfspassword を使用した信頼 ID v3samlpassword を使用した信頼 ID: v3oidcclientcredentials を使用した信頼 ID: v2token を使用した信頼 ID: v3token を使用した信頼 ID: 信頼 ID(Env: os_TRUST_ID)

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

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

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

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

--os-token <auth-token>

トークン: v2token: Token With v3token: Token With v3token: Token to authenticate with admin_token: 常に使用されるトークン(Env: OS_TOKEN)

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

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

--os-username <auth-username>

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

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

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

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

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

--os-passcode <auth-passcode>

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

--os-endpoint <auth-endpoint>

none の場合: gnocchi-noauth と常に使用されるエンドポイント: noauth: Cinder エンドポイントと gnocchi-basic: Gnocchi エンドポイントの組み合わせ: admin_token: 常に使用されるエンドポイント(Env: OS_ENDPOINT)

--os-password <auth-password>

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

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

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

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

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

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

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

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

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

--os-protocol <auth-protocol>

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

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

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

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

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

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

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

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

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

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

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

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

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

--os-roles <auth-roles>

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

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

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

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

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

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

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

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

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

--os-code <auth-code>

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

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

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

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

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

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

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

--os-user <auth-user>

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

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

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

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

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

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

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

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

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

第2章 access

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

2.1. access token create

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

使用方法

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

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

概要

-h, --help

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

--consumer-key <consumer-key>

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

--consumer-secret <consumer-secret>

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

--request-key <request-key>

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

--request-secret <request-secret>

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

--verifier <verifier>

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

表2.2 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表2.3 JSON 書式設定

概要

--noindent

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

表2.4 Shell フォーマッター

概要

--prefix PREFIX

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

表2.5 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

第3章 acl

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

3.1. acl delete

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

使用方法

openstack acl delete [-h] URI

表3.1 位置引数

概要

URI

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

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

概要

-h, --help

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

3.2. acl get

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

使用方法

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

表3.3 位置引数

概要

URI

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

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

概要

-h, --help

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

表3.5 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表3.6 CSV 書式設定

概要

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

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

表3.7 JSON 書式設定

概要

--noindent

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

表3.8 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

3.3. acl submit

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

使用方法

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

表3.9 位置引数

概要

URI

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

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

概要

-h, --help

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

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

ACL の keystone ユーザー ID。

--project-access

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

--no-project-access

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

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

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

表3.11 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表3.12 CSV 書式設定

概要

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

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

表3.13 JSON 書式設定

概要

--noindent

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

表3.14 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

3.4. acl user add

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

使用方法

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

表3.15 位置引数

概要

URI

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

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

概要

-h, --help

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

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

ACL の keystone ユーザー ID。

--project-access

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

--no-project-access

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

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

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

表3.17 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表3.18 CSV 書式設定

概要

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

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

表3.19 JSON 書式設定

概要

--noindent

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

表3.20 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

3.5. acl user remove

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

使用方法

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

表3.21 位置引数

概要

URI

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

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

概要

-h, --help

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

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

ACL の keystone ユーザー ID。

--project-access

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

--no-project-access

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

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

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

表3.23 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表3.24 CSV 書式設定

概要

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

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

表3.25 JSON 書式設定

概要

--noindent

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

表3.26 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

第4章 action

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

4.1. action definition create

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

使用方法

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

表4.1 位置引数

概要

定義

アクション定義ファイル

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

概要

-h, --help

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

--marker [MARKER]

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

--limit [LIMIT]

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

--sort_keys [SORT_KEYS]

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

--sort_dirs [SORT_DIRS]

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

--filter FILTERS

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

--public

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

表4.3 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表4.4 CSV 書式設定

概要

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

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

表4.5 JSON 書式設定

概要

--noindent

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

表4.6 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

4.2. action definition definition show

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

使用方法

openstack action definition definition show [-h] name

表4.7 位置引数

概要

name

アクション名

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

概要

-h, --help

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

4.3. action definition delete

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

使用方法

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

表4.9 位置引数

概要

action

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

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

概要

-h, --help

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

4.4. action definition list

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

使用方法

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

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

概要

-h, --help

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

--marker [MARKER]

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

--limit [LIMIT]

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

--sort_keys [SORT_KEYS]

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

--sort_dirs [SORT_DIRS]

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

--filter FILTERS

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

表4.12 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表4.13 CSV 書式設定

概要

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

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

表4.14 JSON 書式設定

概要

--noindent

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

表4.15 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

4.5. action definition show

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

使用方法

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

表4.16 位置引数

概要

action

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

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

概要

-h, --help

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

表4.18 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表4.19 JSON 書式設定

概要

--noindent

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

表4.20 Shell フォーマッター

概要

--prefix PREFIX

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

表4.21 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

4.6. action definition update

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

使用方法

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

表4.22 位置引数

概要

定義

アクション定義ファイル

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

概要

-h, --help

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

--marker [MARKER]

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

--limit [LIMIT]

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

--sort_keys [SORT_KEYS]

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

--sort_dirs [SORT_DIRS]

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

--filter FILTERS

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

--id ID

アクション ID。

--public

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

表4.24 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表4.25 CSV 書式設定

概要

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

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

表4.26 JSON 書式設定

概要

--noindent

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

表4.27 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

4.7. action execution delete

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

使用方法

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

表4.28 位置引数

概要

action_execution

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

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

概要

-h, --help

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

4.8. action execution input show

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

使用方法

openstack action execution input show [-h] id

表4.30 位置引数

概要

id

アクション実行 ID。

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

概要

-h, --help

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

4.9. action execution list

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

使用方法

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

表4.32 位置引数

概要

task_execution_id

タスクの実行 ID。

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

概要

-h, --help

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

--marker [MARKER]

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

--limit [LIMIT]

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

--sort_keys [SORT_KEYS]

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

--sort_dirs [SORT_DIRS]

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

--filter FILTERS

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

--oldest

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

表4.34 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表4.35 CSV 書式設定

概要

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

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

表4.36 JSON 書式設定

概要

--noindent

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

表4.37 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

4.10. action execution output show

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

使用方法

openstack action execution output show [-h] id

表4.38 位置引数

概要

id

アクション実行 ID。

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

概要

-h, --help

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

4.11. action execution run

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

使用方法

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

表4.40 位置引数

概要

name

実行するアクション名。

input

アクション入力。

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

概要

-h, --help

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

-s, --save-result

結果を db に保存します。

--run-sync

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

-t TARGET, --target TARGET

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

表4.42 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表4.43 JSON 書式設定

概要

--noindent

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

表4.44 Shell フォーマッター

概要

--prefix PREFIX

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

表4.45 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

4.12. action execution show

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

使用方法

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

表4.46 位置引数

概要

action_execution

アクション実行 ID。

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

概要

-h, --help

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

表4.48 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表4.49 JSON 書式設定

概要

--noindent

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

表4.50 Shell フォーマッター

概要

--prefix PREFIX

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

表4.51 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

4.13. action execution update

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

使用方法

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

表4.52 位置引数

概要

id

アクション実行 ID。

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

概要

-h, --help

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

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

アクション実行の状態

--output OUTPUT

アクション実行の出力

表4.54 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表4.55 JSON 書式設定

概要

--noindent

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

表4.56 Shell フォーマッター

概要

--prefix PREFIX

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

表4.57 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

第5章 address

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

5.1. address scope create

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

使用方法

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

表5.1 位置引数

概要

<name>

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

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

概要

-h, --help

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

--ip-version {4,6}

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

--project <project>

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

--project-domain <project-domain>

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

--share

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

--no-share

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

表5.3 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表5.4 JSON 書式設定

概要

--noindent

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

表5.5 Shell フォーマッター

概要

--prefix PREFIX

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

表5.6 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

5.2. address scope delete

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

使用方法

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

表5.7 位置引数

概要

<address-scope>

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

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

概要

-h, --help

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

5.3. address scope list

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

使用方法

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

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

概要

-h, --help

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

--name <name>

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

--ip-version <ip-version>

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

--project <project>

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

--project-domain <project-domain>

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

--share

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

--no-share

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

表5.10 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表5.11 CSV 書式設定

概要

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

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

表5.12 JSON 書式設定

概要

--noindent

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

表5.13 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

5.4. address scope set

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

使用方法

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

表5.14 位置引数

概要

<address-scope>

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

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

概要

-h, --help

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

--name <name>

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

--share

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

--no-share

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

5.5. address scope show

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

使用方法

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

表5.16 位置引数

概要

<address-scope>

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

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

概要

-h, --help

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

表5.18 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表5.19 JSON 書式設定

概要

--noindent

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

表5.20 Shell フォーマッター

概要

--prefix PREFIX

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

表5.21 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

第6章 aggregate

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

6.1. aggregate add host

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

使用方法

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

表6.1 位置引数

概要

<aggregate>

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

<host>

<aggregate> に追加するホスト

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

概要

-h, --help

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

表6.3 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表6.4 JSON 書式設定

概要

--noindent

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

表6.5 Shell フォーマッター

概要

--prefix PREFIX

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

表6.6 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

6.2. aggregate create

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

使用方法

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

表6.7 位置引数

概要

<name>

新しいアグリゲート名

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

概要

-h, --help

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

--zone <availability-zone>

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

--property <key=value>

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

表6.9 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表6.10 JSON 書式設定

概要

--noindent

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

表6.11 Shell フォーマッター

概要

--prefix PREFIX

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

表6.12 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

6.3. aggregate delete

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

使用方法

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

表6.13 位置引数

概要

<aggregate>

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

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

概要

-h, --help

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

6.4. aggregate list

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

使用方法

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

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

概要

-h, --help

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

--long

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

表6.16 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表6.17 CSV 書式設定

概要

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

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

表6.18 JSON 書式設定

概要

--noindent

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

表6.19 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

6.5. aggregate remove host

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

使用方法

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

表6.20 位置引数

概要

<aggregate>

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

<host>

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

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

概要

-h, --help

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

表6.22 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表6.23 JSON 書式設定

概要

--noindent

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

表6.24 Shell フォーマッター

概要

--prefix PREFIX

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

表6.25 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

6.6. aggregate set

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

使用方法

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

表6.26 位置引数

概要

<aggregate>

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

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

概要

-h, --help

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

--name <name>

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

--zone <availability-zone>

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

--property <key=value>

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

--no-property

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

6.7. aggregate show

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

使用方法

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

表6.28 位置引数

概要

<aggregate>

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

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

概要

-h, --help

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

表6.30 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表6.31 JSON 書式設定

概要

--noindent

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

表6.32 Shell フォーマッター

概要

--prefix PREFIX

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

表6.33 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

6.8. aggregate unset

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

使用方法

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

表6.34 位置引数

概要

<aggregate>

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

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

概要

-h, --help

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

--property <key>

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

第7章 alarm

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

7.1. alarm create

アラームの作成

使用方法

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

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

概要

-h, --help

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

--name <NAME>

アラームの名前

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

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

--project-id <PROJECT_ID>

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

--user-id <USER_ID>

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

--description <DESCRIPTION>

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

--state <STATE>

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

--severity <SEVERITY>

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

--enabled {True

False}

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

--alarm-action <Webhook URL>

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

--ok-action <Webhook URL>

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

--insufficient-data-action <Webhook URL>

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

--time-constraint <Time Constraint>

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

--repeat-actions {True

False}

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

表7.2 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表7.3 JSON 書式設定

概要

--noindent

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

表7.4 Shell フォーマッター

概要

--prefix PREFIX

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

表7.5 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

表7.6 common alarm rules

概要

--query <QUERY>

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

--comparison-operator <OPERATOR>

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

--evaluation-periods <EVAL_PERIODS>

評価する期間の数

--threshold <THRESHOLD>

評価するしきい値。

表7.7 event alarm

概要

--event-type <EVENT_TYPE>

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

表7.8 common gnocchi alarm rules

概要

--granularity <GRANULARITY>

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

--aggregation-method <AGGR_METHOD>

しきい値と比較する aggregation_method

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

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

表7.9 gnocchi resource threshold alarm

概要

--resource-type <RESOURCE_TYPE>

リソースのタイプ。

--resource-id <RESOURCE_ID>

リソースの ID。

表7.10 composite alarm

概要

--composite-rule <COMPOSITE_RULE>

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

7.2. alarm delete

アラームを削除します。

使用方法

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

表7.11 位置引数

概要

<ALARM ID または NAME>

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

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

概要

-h, --help

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

--name <NAME>

アラームの名前

7.4. alarm-history show

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

使用方法

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

表7.18 位置引数

概要

<alarm-id>

アラームの ID

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

概要

-h, --help

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

--limit <LIMIT>

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

--marker <MARKER>

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

--sort <SORT_KEY:SORT_DIR>

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

表7.20 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表7.21 CSV 書式設定

概要

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

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

表7.22 JSON 書式設定

概要

--noindent

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

表7.23 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.5. alarm list

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

使用方法

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

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

概要

-h, --help

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

--query QUERY

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

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

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

--limit <LIMIT>

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

--marker <MARKER>

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

--sort <SORT_KEY:SORT_DIR>

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

表7.25 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表7.26 CSV 書式設定

概要

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

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

表7.27 JSON 書式設定

概要

--noindent

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

表7.28 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.6. alarm show

アラームを表示します。

使用方法

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

表7.29 位置引数

概要

<ALARM ID または NAME>

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

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

概要

-h, --help

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

--name <NAME>

アラームの名前

表7.31 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表7.32 JSON 書式設定

概要

--noindent

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

表7.33 Shell フォーマッター

概要

--prefix PREFIX

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

表7.34 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.7. alarm state get

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

使用方法

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

表7.35 位置引数

概要

<ALARM ID または NAME>

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

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

概要

-h, --help

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

--name <NAME>

アラームの名前

表7.37 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表7.38 JSON 書式設定

概要

--noindent

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

表7.39 Shell フォーマッター

概要

--prefix PREFIX

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

表7.40 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.8. alarm state set

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

使用方法

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

表7.41 位置引数

概要

<ALARM ID または NAME>

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

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

概要

-h, --help

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

--name <NAME>

アラームの名前

--state <STATE>

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

表7.43 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表7.44 JSON 書式設定

概要

--noindent

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

表7.45 Shell フォーマッター

概要

--prefix PREFIX

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

表7.46 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.9. alarm update

アラームを更新します。

使用方法

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

表7.47 位置引数

概要

<ALARM ID または NAME>

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

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

概要

-h, --help

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

--name <NAME>

アラームの名前

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

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

--project-id <PROJECT_ID>

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

--user-id <USER_ID>

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

--description <DESCRIPTION>

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

--state <STATE>

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

--severity <SEVERITY>

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

--enabled {True

False}

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

--alarm-action <Webhook URL>

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

--ok-action <Webhook URL>

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

--insufficient-data-action <Webhook URL>

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

--time-constraint <Time Constraint>

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

--repeat-actions {True

False}

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

表7.49 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表7.50 JSON 書式設定

概要

--noindent

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

表7.51 Shell フォーマッター

概要

--prefix PREFIX

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

表7.52 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

表7.53 common alarm rules

概要

--query <QUERY>

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

--comparison-operator <OPERATOR>

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

--evaluation-periods <EVAL_PERIODS>

評価する期間の数

--threshold <THRESHOLD>

評価するしきい値。

表7.54 event alarm

概要

--event-type <EVENT_TYPE>

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

表7.55 common gnocchi alarm rules

概要

--granularity <GRANULARITY>

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

--aggregation-method <AGGR_METHOD>

しきい値と比較する aggregation_method

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

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

表7.56 gnocchi resource threshold alarm

概要

--resource-type <RESOURCE_TYPE>

リソースのタイプ。

--resource-id <RESOURCE_ID>

リソースの ID。

表7.57 composite alarm

概要

--composite-rule <COMPOSITE_RULE>

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

第8章 アラーム

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

8.1. alarming capabilities list

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

使用方法

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

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

概要

-h, --help

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

表8.2 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表8.3 JSON 書式設定

概要

--noindent

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

表8.4 Shell フォーマッター

概要

--prefix PREFIX

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

表8.5 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

第9章 アプリケーション

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

9.1. application credential create

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

使用方法

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

表9.1 位置引数

概要

<name>

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

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

概要

-h, --help

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

--secret <secret>

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

--role <role>

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

--expiration <expiration>

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

--description <description>

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

--unrestricted

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

--restricted

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

表9.3 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表9.4 JSON 書式設定

概要

--noindent

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

表9.5 Shell フォーマッター

概要

--prefix PREFIX

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

表9.6 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

9.2. application credential delete

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

使用方法

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

表9.7 位置引数

概要

<application-credential>

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

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

概要

-h, --help

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

9.3. application credential list

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

使用方法

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

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

概要

-h, --help

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

--user <user>

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

--user-domain <user-domain>

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

表9.10 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表9.11 CSV 書式設定

概要

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

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

表9.12 JSON 書式設定

概要

--noindent

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

表9.13 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

9.4. application credential show

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

使用方法

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

表9.14 位置引数

概要

<application-credential>

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

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

概要

-h, --help

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

表9.16 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表9.17 JSON 書式設定

概要

--noindent

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

表9.18 Shell フォーマッター

概要

--prefix PREFIX

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

表9.19 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

第10章 availability

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

10.1. availability zone list

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

使用方法

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

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

概要

-h, --help

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

--compute

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

--network

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

--volume

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

--long

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

表10.2 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表10.3 CSV 書式設定

概要

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

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

表10.4 JSON 書式設定

概要

--noindent

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

表10.5 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

第11章 baremetal

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

11.1. baremetal allocation create

新規ベアメタルの割り当てを作成します。

使用方法

openstack baremetal allocation create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--resource-class RESOURCE_CLASS]
                                             [--trait TRAITS]
                                             [--candidate-node CANDIDATE_NODES]
                                             [--name NAME] [--uuid UUID]
                                             [--extra <key=value>]
                                             [--wait [<time-out>]]
                                             [--node NODE]

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

概要

-h, --help

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

--resource-class RESOURCE_CLASS

要求するリソースクラス。

--trait TRAITS

要求する特性。複数回指定できます。

--candidate-node CANDIDATE_NODES

この割り当て候補ノード。複数回指定できます。1 つ以上の指定した場合には、指定した候補ノードのみが割り当ての対象として考慮されます。

--name NAME

割り当ての一意名。

--uuid UUID

割り当ての UUID

--extra <key=value>

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

--wait [<time-out>]

新しい割り当てがアクティブになるまで待機します。--wait を使用する場合に割り当て失敗するとエラーが返されます。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

--node NODE

すでにデプロイされている指定ノードからこの割り当てに対応します。通常の割り当てプロセスを回避します。

表11.2 出力形式の設定

概要

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

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

-c COLUMN, --column COLUMN

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

表11.3 JSON 書式設定

概要

--noindent

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

表11.4 Shell フォーマッター

概要

--prefix PREFIX

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

表11.5 表の書式設定

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.2. baremetal allocation delete

ベアメタル割り当ての登録を解除します。

使用方法

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

表11.6 位置引数

概要

<allocation>

削除する割り当て(名前または uuid)。

表11.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.3. baremetal allocation list

ベアメタルの割り当てを一覧表示します。

使用方法

openstack baremetal allocation list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           [--limit <limit>]
                                           [--marker <allocation>]
                                           [--sort <key>[:<direction>]]
                                           [--node <node>]
                                           [--resource-class <resource_class>]
                                           [--state <state>]
                                           [--long | --fields <field> [<field> ...]]

表11.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

要求ごとに返す割り当ての最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <allocation>

Allocation uuid(以前の要求リストにある最後の割り当てなど)。この UUID の後の割り当て一覧を返します。

--sort <key>[:<direction>]

指定した割り当てフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--node <node>

このノード(名前または UUID)の割り当てのみを一覧表示します。

--resource-class <resource_class>

このリソースクラスによる割り当てのみを一覧表示します。

--state <state>

この状態の割り当てのみを一覧表示します。

--long

割り当ての詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上の割り当てフィールド。これらのフィールドのみがサーバーから取得されます。-- long が指定されている場合は使用できません。

表11.9 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.12 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.4. baremetal allocation set

ベアメタル割り当てプロパティーを設定します。

使用方法

openstack baremetal allocation set [-h] [--name <name>]
                                          [--extra <key=value>]
                                          <allocation>

表11.13 位置引数

概要

<allocation>

割り当ての名前または UUID

表11.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

割り当ての名前を設定します。

--extra <key=value>

この割り当てに設定する追加プロパティー(複数の追加プロパティーを設定するにはオプションを繰り返し使用します。)

11.5. baremetal allocation show

ベアメタルの割り当ての詳細を表示します。

使用方法

openstack baremetal allocation show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--fields <field> [<field> ...]]
                                           <id>

表11.15 位置引数

概要

<id>

割り当ての UUID または名前

表11.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上の割り当てフィールド。これらのフィールドのみがサーバーから取得されます。

表11.17 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.18 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.19 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.20 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.6. baremetal allocation unset

ベアメタル割り当てプロパティーの設定を解除します。

使用方法

openstack baremetal allocation unset [-h] [--name] [--extra <key>]
                                            <allocation>

表11.21 位置引数

概要

<allocation>

割り当ての名前または UUID

表11.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name

割り当て名の設定を解除します。

--extra <key>

このベアメタル割り当ての設定を解除する追加のプロパティー(複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します)

11.7. baremetal chassis create

新しいシャーシを作成します。

使用方法

openstack baremetal chassis create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--description <description>]
                                          [--extra <key=value>]
                                          [--uuid <uuid>]

表11.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

シャーシの説明

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--uuid <uuid>

シャーシの一意の UUID

表11.24 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.26 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.27 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.8. baremetal chassis delete

シャーシを削除します。

使用方法

openstack baremetal chassis delete [-h] <chassis> [<chassis> ...]

表11.28 位置引数

概要

<chassis>

削除するシャーシの UUID

表11.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.9. ベアメタルシャーシの一覧

シャーシを一覧表示します。

使用方法

openstack baremetal chassis list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--fields <field> [<field> ...]]
                                        [--limit <limit>] [--long]
                                        [--marker <chassis>]
                                        [--sort <key>[:<direction>]]

表11.30 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のシャーシフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

--limit <limit>

要求ごとに返すシャーシの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--long

シャーシに関する詳細情報を表示します。

--marker <chassis>

シャーシ uuid(以前の要求リストにある最後のシャーシなど)。この UUID の後にシャーシの一覧を返します。

--sort <key>[:<direction>]

指定したシャシーフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

表11.31 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.32 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.33 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.34 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.10. baremetal chassis set

シャーシのプロパティーを設定します。

使用方法

openstack baremetal chassis set [-h] [--description <description>]
                                       [--extra <key=value>]
                                       <chassis>

表11.35 位置引数

概要

<chassis>

シャーシの UUID

表11.36 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

シャーシの説明を設定します。

--extra <key=value>

このシャーシに設定する追加項目(複数の追加項目を設定する場合は、オプションを繰り返し使用します。)

11.11. baremetal chassis show

シャーシの詳細を表示します。

使用方法

openstack baremetal chassis show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--fields <field> [<field> ...]]
                                        <chassis>

表11.37 位置引数

概要

<chassis>

シャーシの UUID

表11.38 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のシャーシフィールド。これらのフィールドのみがサーバーから取得されます。

表11.39 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.40 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.41 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.42 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.12. baremetal chassis unset

シャーシのプロパティーの設定を解除します。

使用方法

openstack baremetal chassis unset [-h] [--description] [--extra <key>]
                                         <chassis>

表11.43 位置引数

概要

<chassis>

シャーシの UUID

表11.44 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description

シャーシの説明を消去します。

--extra <key>

このシャーシの設定を解除する追加項目(複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。)

11.13. baremetal conductor list

ベアメタルコンダクターを一覧表示します。

使用方法

openstack baremetal conductor list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          [--limit <limit>]
                                          [--marker <conductor>]
                                          [--sort <key>[:<direction>]]
                                          [--long | --fields <field> [<field> ...]]

表11.45 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

要求ごとに返すコンダクターの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <conductor>

コンダクターのホスト名(例:以前の要求リストにある最後のコンダクター)。このコンダクターの後にコンダクターの一覧を返します。

--sort <key>[:<direction>]

指定したコンダクターフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--long

コンダクターに関する詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のコンダクターフィールド。これらのフィールドのみがサーバーから取得されます。-- long が指定されている場合は使用できません。

表11.46 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.47 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.48 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.49 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.14. baremetal conductor show

ベアメタルコンダクターの詳細を表示します。

使用方法

openstack baremetal conductor show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--fields <field> [<field> ...]]
                                          <conductor>

表11.50 位置引数

概要

<conductor>

コンダクターのホスト名

表11.51 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のコンダクターフィールド。これらのフィールドのみがサーバーから取得されます。

表11.52 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.53 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.54 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.55 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.15. baremetal create

ファイルからのリソースを作成します。

使用方法

openstack baremetal create [-h] <file> [<file> ...]

表11.56 位置引数

概要

<file>

作成するリソースの説明が記載されているファイル(.yaml または .json)。複数回指定できます。

表11.57 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.16. baremetal deploy template create

新規デプロイテンプレートを作成します。

使用方法

openstack baremetal deploy template create [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--uuid <uuid>]
                                                  [--extra <key=value>]
                                                  --steps <steps>
                                                  <name>

表11.58 位置引数

概要

<name>

このデプロイテンプレートの一意名。有効な特性名である必要があります。

表11.59 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--uuid <uuid>

デプロイテンプレートの UUID

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--steps <steps>

Json 形式のデプロイ手順。デプロイ手順が含まれるファイルへのパス、- (デプロイ手順が標準入力から読み取る)、または文字列になります。値は deploy-step ディクショナリーの一覧である必要があります。各ディクショナリーには、interfacestepargs および priority が必要です。

表11.60 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.61 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.62 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.63 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.17. baremetal deploy template delete

デプロイテンプレートを削除します。

使用方法

openstack baremetal deploy template delete [-h]
                                                  <template> [<template> ...]

表11.64 位置引数

概要

<template>

削除するデプロイテンプレートの名前または UUID。

表11.65 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.18. baremetal deploy template list

ベアメタルのデプロイテンプレートを一覧表示します。

使用方法

openstack baremetal deploy template list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--noindent]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                [--limit <limit>]
                                                [--marker <template>]
                                                [--sort <key>[:<direction>]]
                                                [--long | --fields <field> [<field> ...]]

表11.66 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

要求ごとに返すデプロイテンプレートの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <template>

DeployTemplate uuid(以前の要求リストにある最後のデプロイテンプレートなど)この UUID の後にデプロイテンプレートの一覧を返します。

--sort <key>[:<direction>]

指定したデプロイテンプレートフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--long

デプロイテンプレートに関する詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のデプロイテンプレートフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

表11.67 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.68 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.69 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.70 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.19. baremetal deploy template set

ベアメタルのデプロイテンプレートプロパティーを設定します。

使用方法

openstack baremetal deploy template set [-h] [--name <name>]
                                               [--steps <steps>]
                                               [--extra <key=value>]
                                               <template>

表11.71 位置引数

概要

<template>

デプロイテンプレートの名前または UUID

表11.72 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

デプロイテンプレートの一意名を設定します。有効な特性名である必要があります。

--steps <steps>

Json 形式のデプロイ手順。デプロイ手順が含まれるファイルへのパス、- (デプロイ手順が標準入力から読み取る)、または文字列になります。値は deploy-step ディクショナリーの一覧である必要があります。各ディクショナリーには、interfacestepargs および priority が必要です。

--extra <key=value>

このベアメタルデプロイテンプレートに設定する追加項目(複数の追加項目を設定する場合は、オプションを繰り返し使用します。)

11.20. baremetal deploy template show

ベアメタルのデプロイテンプレートの詳細を表示します。

使用方法

openstack baremetal deploy template show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--fields <field> [<field> ...]]
                                                <template>

表11.73 位置引数

概要

<template>

デプロイテンプレートの名前または UUID。

表11.74 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のデプロイテンプレートフィールド。これらのフィールドのみがサーバーから取得されます。

表11.75 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.76 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.77 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.78 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.21. baremetal deploy template unset

ベアメタルのデプロイテンプレートプロパティーの設定を解除します。

使用方法

openstack baremetal deploy template unset [-h] [--extra <key>]
                                                 <template>

表11.79 位置引数

概要

<template>

デプロイテンプレートの名前または UUID

表11.80 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--extra <key>

このベアメタルデプロイテンプレートの設定を解除する追加項目(複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。)

11.22. baremetal driver list

有効なドライバーを一覧表示します。

使用方法

openstack baremetal driver list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--type <type>] [--long]

表11.81 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--type <type>

ドライバーのタイプ(「classic」または「dynamic」)。デフォルトでは、すべてのドライバーが一覧表示されます。

--long

ドライバーに関する詳細情報を表示します。

表11.82 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.83 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.84 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.85 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.23. baremetal driver passthru call

ドライバーのベンダーパススルーメソッドを呼び出します。

使用方法

openstack baremetal driver passthru call [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--arg <key=value>]
                                                [--http-method <http-method>]
                                                <driver> <method>

表11.86 位置引数

概要

<driver>

ドライバーの名前。

<method>

呼び出すベンダーパススルーメソッド

表11.87 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--arg <key=value>

Passthru メソッドに渡す引数(複数の引数を指定する場合は、オプションを繰り返し使用します)。

--http-method <http-method>

パススルー要求で使用する http メソッド。DELETE、GET、PATCH、POST、PUT のいずれか。デフォルトは POST です。

表11.88 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.89 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.90 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.91 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.24. baremetal driver passthru list

ドライバーで利用可能なベンダーパススルー方法を一覧表示します。

使用方法

openstack baremetal driver passthru list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--noindent]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                <driver>

表11.92 位置引数

概要

<driver>

ドライバーの名前。

表11.93 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.94 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.95 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.96 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.97 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.25. baremetal driver property list

ドライバープロパティーを一覧表示します。

使用方法

openstack baremetal driver property list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--noindent]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                <driver>

表11.98 位置引数

概要

<driver>

ドライバーの名前。

表11.99 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.100 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.101 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.102 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.103 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.26. baremetal driver raid property list

ドライバーの RAID 論理ネットワークプロパティーを一覧表示します。

使用方法

openstack baremetal driver raid property list [-h]
                                                     [-f {csv,json,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--quote {all,minimal,none,nonnumeric}]
                                                     [--noindent]
                                                     [--max-width <integer>]
                                                     [--fit-width]
                                                     [--print-empty]
                                                     [--sort-column SORT_COLUMN]
                                                     <driver>

表11.104 位置引数

概要

<driver>

ドライバーの名前。

表11.105 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.106 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.107 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.108 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.109 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.27. baremetal driver show

ドライバーに関する情報を表示します。

使用方法

openstack baremetal driver show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <driver>

表11.110 位置引数

概要

<driver>

ドライバーの名前。

表11.111 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.112 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.113 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.114 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.115 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.28. baremetal introspection abort

ノードのイントロスペクションの実行を中止します。

使用方法

openstack baremetal introspection abort [-h] node

表11.116 位置引数

概要

node

ベアメタルノードの uuid または名前

表11.117 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.29. baremetal introspection data save

未加工のイントロスペクションデータを保存または表示します。

使用方法

openstack baremetal introspection data save [-h] [--file <filename>]
                                                   node

表11.118 位置引数

概要

node

ベアメタルノードの uuid または名前

表11.119 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--file <filename>

ダウンロードするイントロスペクションデータのファイル名(デフォルト:stdout)

11.30. baremetal introspection interface list

接続されたスイッチポート情報を含むインターフェースデータを一覧表示します。

使用方法

openstack baremetal introspection interface list [-h]
                                                        [-f {csv,json,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--quote {all,minimal,none,nonnumeric}]
                                                        [--noindent]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--sort-column SORT_COLUMN]
                                                        [--vlan VLAN]
                                                        [--long | --fields <field> [<field> ...]]
                                                        node_ident

表11.120 位置引数

概要

node_ident

ベアメタルノードの uuid または名前

表11.121 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--vlan VLAN

この vlan ID 用に設定されたインターフェースのみを一覧表示します。繰り返し使用できます。

--long

インターフェースに関する詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のフィールドを表示します。-- long が指定されている場合は使用できません。

表11.122 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.123 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.124 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.125 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.31. baremetal introspection interface show

接続されたスイッチポート情報が含まれるインターフェースデータを表示します。

使用方法

openstack baremetal introspection interface show [-h]
                                                        [-f {json,shell,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--noindent]
                                                        [--prefix PREFIX]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--fields <field> [<field> ...]]
                                                        node_ident interface

表11.126 位置引数

概要

node_ident

ベアメタルノードの uuid または名前

interface

インターフェース名

表11.127 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のフィールドを表示します。

表11.128 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.129 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.130 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.131 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.32. baremetal introspection list

イントロスペクションのステータスを一覧表示します。

使用方法

openstack baremetal introspection list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              [--marker MARKER]
                                              [--limit LIMIT]

表11.132 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker MARKER

前のページにある最後の項目の UUID

--limit LIMIT

返す項目数

表11.133 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.134 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.135 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.136 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.33. baremetal introspection reprocess

保存されたイントロスペクションデータを再処理します。

使用方法

openstack baremetal introspection reprocess [-h] node

表11.137 位置引数

概要

node

ベアメタルノードの uuid または名前

表11.138 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.34. baremetal introspection rule delete

イントロスペクションルールを削除します。

使用方法

openstack baremetal introspection rule delete [-h] uuid

表11.139 位置引数

概要

uuid

ルールの uuid

表11.140 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.35. baremetal introspection rule import

JSON/YAML ファイルから 1 つまたは複数のイントロスペクションルールをインポートします。

使用方法

openstack baremetal introspection rule import [-h]
                                                     [-f {csv,json,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--quote {all,minimal,none,nonnumeric}]
                                                     [--noindent]
                                                     [--max-width <integer>]
                                                     [--fit-width]
                                                     [--print-empty]
                                                     [--sort-column SORT_COLUMN]
                                                     file

表11.141 位置引数

概要

file

インポートする JSON または yaml ファイル。1 つまたは複数のルールを含めることができます。

表11.142 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.143 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.144 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.145 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.146 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.36. baremetal introspection rule list

全イントロスペクションルールを一覧表示します。

使用方法

openstack baremetal introspection rule list [-h]
                                                   [-f {csv,json,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--quote {all,minimal,none,nonnumeric}]
                                                   [--noindent]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--sort-column SORT_COLUMN]

表11.147 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.148 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.149 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.150 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.151 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.37. baremetal introspection rule purge

すべてのイントロスペクションルールを破棄します。

使用方法

openstack baremetal introspection rule purge [-h]

表11.152 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.38. baremetal introspection rule show

イントロスペクションルールを表示します。

使用方法

openstack baremetal introspection rule show [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   uuid

表11.153 位置引数

概要

uuid

ルールの uuid

表11.154 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.155 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.156 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.157 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.158 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.39. baremetal introspection start

イントロスペクションを開始します。

使用方法

openstack baremetal introspection start [-h]
                                               [-f {csv,json,table,value,yaml}]
                                               [-c COLUMN]
                                               [--quote {all,minimal,none,nonnumeric}]
                                               [--noindent]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--sort-column SORT_COLUMN]
                                               [--wait] [--check-errors]
                                               node [node ...]

表11.159 位置引数

概要

node

ベアメタルノードの uuid または名前

表11.160 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait

イントロスペクションが完了するまで待機します。結果は最後に表示されます。

--check-errors

イントロスペクション中にエラーが発生しているかどうかを確認します。エラーが発生した場合は、エラーのみが表示されます。--wait と併用しないと使用できません。

表11.161 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.162 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.163 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.164 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.40. baremetal introspection status

イントロスペクションのステータスを取得します。

使用方法

openstack baremetal introspection status [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                node

表11.165 位置引数

概要

node

ベアメタルノードの uuid または名前

表11.166 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.167 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.168 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.169 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.170 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.41. baremetal node abort

ベアメタルノードのプロビジョニング状態を abort に設定します。

使用方法

openstack baremetal node abort [-h] <node>

表11.171 位置引数

概要

<node>

ノードの名前または UUID。

表11.172 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.42. baremetal node add trait

ノードに特性を追加します。

使用方法

openstack baremetal node add trait [-h] <node> <trait> [<trait> ...]

表11.173 位置引数

概要

<node>

ノードの名前または UUID

<trait>

追加する特性

表11.174 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.43. baremetal node adopt

ベアメタルノードのプロビジョニング状態を adopt に設定します。

使用方法

openstack baremetal node adopt [-h] [--wait [<time-out>]] <node>

表11.175 位置引数

概要

<node>

ノードの名前または UUID。

表11.176 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.44. baremetal node bios setting list

ノードの BIOS 設定を一覧表示します。

使用方法

openstack baremetal node bios setting list [-h]
                                                  [-f {csv,json,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--quote {all,minimal,none,nonnumeric}]
                                                  [--noindent]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--sort-column SORT_COLUMN]
                                                  <node>

表11.177 位置引数

概要

<node>

ノードの名前または UUID

表11.178 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.179 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.180 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.181 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.182 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.45. baremetal node bios setting show

ノードの特定の BIOS 設定を表示します。

使用方法

openstack baremetal node bios setting show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  <node> <setting name>

表11.183 位置引数

概要

<node>

ノードの名前または UUID

<setting name>

表示する名前の設定

表11.184 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.185 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.186 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.187 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.188 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.46. baremetal node boot device set

ノードのブートデバイスを設定します。

使用方法

openstack baremetal node boot device set [-h] [--persistent]
                                                <node> <device>

表11.189 位置引数

概要

<node>

ノードの名前または UUID

<device>

Bios、cdrom、disk、pxe、safe、wanboot のいずれか

表11.190 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--persistent

今後の起動時にすべての変更を永続化します。

11.47. baremetal node boot device show

ノードのブートデバイス情報を表示します。

使用方法

openstack baremetal node boot device show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--supported]
                                                 <node>

表11.191 位置引数

概要

<node>

ノードの名前または UUID

表11.192 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--supported

サポート対象のブートデバイスを表示します。

表11.193 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.194 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.195 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.196 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.48. baremetal node clean

ベアメタルノードのプロビジョニング状態を clean に設定します。

使用方法

openstack baremetal node clean [-h] [--wait [<time-out>]] --clean-steps
                                      <clean-steps>
                                      <node>

表11.197 位置引数

概要

<node>

ノードの名前または UUID。

表11.198 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

--clean-steps <clean-steps>

Json 形式の消去手順。消去手順が含まれるファイルへのパス、- (消去手順が標準入力から読み取る)、または文字列になります。値は clean-step ディクショナリーの一覧である必要があります。各ディクショナリーには、キーの interface および step、任意のキーの args が必要です。

11.49. baremetal node console disable

ノードのコンソールアクセスを無効化します。

使用方法

openstack baremetal node console disable [-h] <node>

表11.199 位置引数

概要

<node>

ノードの名前または UUID

表11.200 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.50. baremetal node console enable

ノードのコンソールアクセスを有効化します。

使用方法

openstack baremetal node console enable [-h] <node>

表11.201 位置引数

概要

<node>

ノードの名前または UUID

表11.202 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.51. baremetal node console show

ノードのコンソール情報を表示します。

使用方法

openstack baremetal node console show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <node>

表11.203 位置引数

概要

<node>

ノードの名前または UUID

表11.204 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.205 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.206 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.207 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.208 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.52. baremetal node create

新規ノードを baremetal サービスに登録します。

使用方法

openstack baremetal node create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--chassis-uuid <chassis>] --driver
                                       <driver> [--driver-info <key=value>]
                                       [--property <key=value>]
                                       [--extra <key=value>] [--uuid <uuid>]
                                       [--name <name>]
                                       [--bios-interface <bios_interface>]
                                       [--boot-interface <boot_interface>]
                                       [--console-interface <console_interface>]
                                       [--deploy-interface <deploy_interface>]
                                       [--inspect-interface <inspect_interface>]
                                       [--management-interface <management_interface>]
                                       [--network-interface <network_interface>]
                                       [--power-interface <power_interface>]
                                       [--raid-interface <raid_interface>]
                                       [--rescue-interface <rescue_interface>]
                                       [--storage-interface <storage_interface>]
                                       [--vendor-interface <vendor_interface>]
                                       [--resource-class <resource_class>]
                                       [--conductor-group <conductor_group>]
                                       [--automated-clean] [--owner <owner>]
                                       [--description <description>]

表11.209 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--chassis-uuid <chassis>

このノードが属するシャーシの UUID。

--driver <driver>

ノードの制御に使用されるドライバー [必須]。

--driver-info <key=value>

アウトバウンド管理認証情報など、ドライバーが使用するキー/値のペア。複数回指定できます。

--property <key=value>

ノードの物理的な特性を記述するキー/値のペア。これは Nova にエクスポートされ、スケジューラーが使用します。複数回指定できます。

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--uuid <uuid>

ノードの一意の UUID。

--name <name>

ノードの一意名。

--bios-interface <bios_interface>

ノードのドライバーで使用される BIOS インターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--boot-interface <boot_interface>

ノードのドライバーで使用される起動インターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--console-interface <console_interface>

ノードのドライバーで使用されるコンソールインターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--deploy-interface <deploy_interface>

ノードのドライバーで使用されるデプロイインターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--inspect-interface <inspect_interface>

ノードのドライバーで使用されるインスペクトインターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--management-interface <management_interface>

ノードのドライバーで使用される管理インターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--network-interface <network_interface>

クリーニング/プロビジョニングネットワークへのノードの切り替えに使用するネットワークインターフェース

--power-interface <power_interface>

ノードのドライバーで使用される電源インターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--raid-interface <raid_interface>

ノードのドライバーで使用される RAID インターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--rescue-interface <rescue_interface>

ノードのドライバーで使用されるレスキューインターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--storage-interface <storage_interface>

ノードのドライバーが使用するストレージインターフェース。

--vendor-interface <vendor_interface>

ノードのドライバーで使用されるベンダーインターフェース。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。

--resource-class <resource_class>

ノードを nova フレーバーにマッピングするためのリソースクラス

--conductor-group <conductor_group>

ノードが所属するコンダクターグループ

--automated-clean

ノードの自動クリーニングを有効化します。

--owner <owner>

ノードの所有者。

--description <description>

ノードの説明。

表11.210 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.211 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.212 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.213 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.53. baremetal node delete

ベアメタルノードの登録を解除します。

使用方法

openstack baremetal node delete [-h] <node> [<node> ...]

表11.214 位置引数

概要

<node>

削除するノード(名前または uuid)

表11.215 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.54. baremetal node deploy

ベアメタルノードのプロビジョニングの状態を deploy に設定します。

使用方法

openstack baremetal node deploy [-h] [--wait [<time-out>]]
                                       [--config-drive <config-drive>]
                                       <node>

表11.216 位置引数

概要

<node>

ノードの名前または UUID。

表11.217 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

--config-drive <config-drive>

Gzipped, base64 でエンコードされたコンフィグドライブの文字列、またはコンフィグドライブファイルへのパス、コンフィグドライブファイルが含まれるパス、コンフィグドライブのビルド元の JSON オブジェクト。ディレクトリーの場合には、コンフィグドライブはそのディレクトリーで生成されます。JSON オブジェクトに、オプションのキー meta_data、user_data、および network_data が指定されている場合には、コンフィグドライブがサーバー側で生成されます(詳細は、ベアメタル API のリファレンス を参照)。

11.55. baremetal node inject nmi

NMI をベアメタルノードに注入します。

使用方法

openstack baremetal node inject nmi [-h] <node>

表11.218 位置引数

概要

<node>

ノードの名前または UUID。

表11.219 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.56. baremetal node inspect

ベアメタルノードのプロビジョニング状態を inspect に設定します。

使用方法

openstack baremetal node inspect [-h] [--wait [<time-out>]] <node>

表11.220 位置引数

概要

<node>

ノードの名前または UUID。

表11.221 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.57. baremetal node list

ベアメタルノードを一覧表示します。

使用方法

openstack baremetal node list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--limit <limit>] [--marker <node>]
                                     [--sort <key>[:<direction>]]
                                     [--maintenance | --no-maintenance]
                                     [--fault <fault>]
                                     [--associated | --unassociated]
                                     [--provision-state <provision state>]
                                     [--driver <driver>]
                                     [--resource-class <resource class>]
                                     [--conductor-group <conductor_group>]
                                     [--conductor <conductor>]
                                     [--chassis <chassis UUID>]
                                     [--owner <owner>]
                                     [--description-contains <description_contains>]
                                     [--long | --fields <field> [<field> ...]]

表11.222 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

要求ごとに返すノードの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <node>

ノードの uuid(例:以前の要求リストにある最後のノード)。UUID の後にノードの一覧を返します。

--sort <key>[:<direction>]

指定したノードフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--maintenance

メンテナンスモードのノードだけにリストを制限します。

--no-maintenance

メンテナンスモード以外のノードだけにリストを制限します。

--fault <fault>

指定した障害でが発生しているノードを一覧表示します。

--associated

インスタンスに関連付けられているノードのみを一覧表示します。

--unassociated

インスタンスに関連付けられていないノードのみを一覧表示します。

--provision-state <provision state>

指定したプロビジョニング状態のノードを一覧表示します。

--driver <driver>

ドライバーが <driver> のノードのみに一覧を制限します。

--resource-class <resource class>

リソースクラスが <resource class> のノードのみに一覧を制限します。

--conductor-group <conductor_group>

コンダクターグループが <conductor group> のノードのみに一覧を制限します。

--conductor <conductor>

コンダクターが <conductor> のノードのみに一覧を制限します。

--chassis <chassis UUID>

このシャーシのノードのみに一覧を制限します。

--owner <owner>

所有者が <owner> のノードのみに一覧を制限します。

--description-contains <description_contains>

説明に <description_contains> が含まれるノードのみに一覧を制限します。

--long

ノードの詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のノードフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

表11.223 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.224 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.225 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.226 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.58. baremetal node maintenance set

ベアメタルノードをメンテナンスモードに設定します。

使用方法

openstack baremetal node maintenance set [-h] [--reason <reason>]
                                                <node>

表11.227 位置引数

概要

<node>

ノードの名前または UUID。

表11.228 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--reason <reason>

メンテナンスモードを設定する理由。

11.59. baremetal node maintenance unset

メンテナンスモードのベアメタルノードの設定を解除します。

使用方法

openstack baremetal node maintenance unset [-h] <node>

表11.229 位置引数

概要

<node>

ノードの名前または UUID。

表11.230 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.60. baremetal node manage

ベアメタルノードのプロビジョニングの状態を manage に設定します。

使用方法

openstack baremetal node manage [-h] [--wait [<time-out>]] <node>

表11.231 位置引数

概要

<node>

ノードの名前または UUID。

表11.232 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.61. baremetal node passthru call

ノードのベンダーパススルーメソッドを呼び出します。

使用方法

openstack baremetal node passthru call [-h] [--arg <key=value>]
                                              [--http-method <http-method>]
                                              <node> <method>

表11.233 位置引数

概要

<node>

ノードの名前または UUID

<method>

実行するベンダーパススルーメソッド

表11.234 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--arg <key=value>

Passthru メソッドに渡す引数(複数の引数を指定する場合は、オプションを繰り返し使用します)。

--http-method <http-method>

パススルー要求で使用する http メソッド。DELETE、GET、PATCH、POST、PUT のいずれか。デフォルトは POST です。

11.62. baremetal node passthru list

ノードのベンダーパススルー方法を一覧表示します。

使用方法

openstack baremetal node passthru list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              <node>

表11.235 位置引数

概要

<node>

ノードの名前または UUID

表11.236 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.237 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.238 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.239 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.240 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.63. baremetal node power off

ノードの電源をオフにします。

使用方法

openstack baremetal node power off [-h]
                                          [--power-timeout <power-timeout>]
                                          [--soft]
                                          <node>

表11.241 位置引数

概要

<node>

ノードの名前または UUID。

表11.242 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--power-timeout <power-timeout>

エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間(秒単位、正の整数)。

--soft

正常な電源オフを要求します。

11.64. baremetal node power on

ノードの電源をオンにします。

使用方法

openstack baremetal node power on [-h]
                                         [--power-timeout <power-timeout>]
                                         <node>

表11.243 位置引数

概要

<node>

ノードの名前または UUID。

表11.244 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--power-timeout <power-timeout>

エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間(秒単位、正の整数)。

11.65. baremetal node provide

ベアメタルノードのプロビジョニングの状態を provide に設定します。

使用方法

openstack baremetal node provide [-h] [--wait [<time-out>]] <node>

表11.245 位置引数

概要

<node>

ノードの名前または UUID。

表11.246 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態(available)に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.66. baremetal node reboot

ベアメタルノードを再起動します。

使用方法

openstack baremetal node reboot [-h] [--soft]
                                       [--power-timeout <power-timeout>]
                                       <node>

表11.247 位置引数

概要

<node>

ノードの名前または UUID。

表11.248 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--soft

正常な再起動を要求します。

--power-timeout <power-timeout>

エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間(秒単位、正の整数)。

11.67. baremetal node rebuild

ベアメタルノードのプロビジョニングの状態を rebuild に設定します。

使用方法

openstack baremetal node rebuild [-h] [--wait [<time-out>]]
                                        [--config-drive <config-drive>]
                                        <node>

表11.249 位置引数

概要

<node>

ノードの名前または UUID。

表11.250 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

--config-drive <config-drive>

Gzipped, base64 でエンコードされたコンフィグドライブの文字列、またはコンフィグドライブファイルへのパス、コンフィグドライブファイルが含まれるパス、コンフィグドライブのビルド元の JSON オブジェクト。ディレクトリーの場合には、コンフィグドライブはそのディレクトリーで生成されます。JSON オブジェクトに、オプションのキー meta_data、user_data、および network_data が指定されている場合には、コンフィグドライブがサーバー側で生成されます(詳細は、ベアメタル API のリファレンス を参照)。

11.68. baremetal node remove trait

ノードから特性を削除します。

使用方法

openstack baremetal node remove trait [-h] [--all]
                                             <node> [<trait> [<trait> ...]]

表11.251 位置引数

概要

<node>

ノードの名前または UUID

<trait>

削除する特性

表11.252 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all

すべての特性を削除します。

11.69. baremetal node rescue

ベアメタルノードのプロビジョニングの状態を rescue に設定します。

使用方法

openstack baremetal node rescue [-h] [--wait [<time-out>]]
                                       --rescue-password <rescue-password>
                                       <node>

表11.253 位置引数

概要

<node>

ノードの名前または UUID。

表11.254 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (rescue) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

--rescue-password <rescue-password>

Rescue ramdisk へのログインに使用するパスワード。値は空でない文字列である必要があります。

11.70. baremetal node set

ベアメタルのプロパティを設定します。

使用方法

openstack baremetal node set [-h] [--instance-uuid <uuid>]
                                    [--name <name>]
                                    [--chassis-uuid <chassis UUID>]
                                    [--driver <driver>]
                                    [--bios-interface <bios_interface> | --reset-bios-interface]
                                    [--boot-interface <boot_interface> | --reset-boot-interface]
                                    [--console-interface <console_interface> | --reset-console-interface]
                                    [--deploy-interface <deploy_interface> | --reset-deploy-interface]
                                    [--inspect-interface <inspect_interface> | --reset-inspect-interface]
                                    [--management-interface <management_interface> | --reset-management-interface]
                                    [--network-interface <network_interface> | --reset-network-interface]
                                    [--power-interface <power_interface> | --reset-power-interface]
                                    [--raid-interface <raid_interface> | --reset-raid-interface]
                                    [--rescue-interface <rescue_interface> | --reset-rescue-interface]
                                    [--storage-interface <storage_interface> | --reset-storage-interface]
                                    [--vendor-interface <vendor_interface> | --reset-vendor-interface]
                                    [--reset-interfaces]
                                    [--resource-class <resource_class>]
                                    [--conductor-group <conductor_group>]
                                    [--automated-clean] [--protected]
                                    [--protected-reason <protected_reason>]
                                    [--target-raid-config <target_raid_config>]
                                    [--property <key=value>]
                                    [--extra <key=value>]
                                    [--driver-info <key=value>]
                                    [--instance-info <key=value>]
                                    [--owner <owner>]
                                    [--description <description>]
                                    <node>

表11.255 位置引数

概要

<node>

ノードの名前または UUID。

表11.256 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--instance-uuid <uuid>

ノードのインスタンスの uuid を <uuid> に設定します。

--name <name>

ノードの名前。

--chassis-uuid <chassis UUID>

ノードのシャーシを設定します。

--driver <driver>

ノードのドライバーを設定します。

--bios-interface <bios_interface>

ノードの bios インターフェースを設定します。

--reset-bios-interface

BIOS インターフェースをハードウェアタイプのデフォルトにリセットします。

--boot-interface <boot_interface>

ノードの起動インターフェースを設定します。

--reset-boot-interface

起動インターフェースをハードウェアタイプのデフォルトにリセットします。

--console-interface <console_interface>

ノードのコンソールインターフェースを設定します。

--reset-console-interface

コンソールインターフェースをハードウェアタイプのデフォルトにリセットします。

--deploy-interface <deploy_interface>

ノードのデプロイインターフェースを設定します。

--reset-deploy-interface

デプロイインターフェースをハードウェアタイプのデフォルトにリセットします。

--inspect-interface <inspect_interface>

ノードの検査インターフェースを設定します。

--reset-inspect-interface

検査インターフェースをハードウェアタイプのデフォルトにリセットします。

--management-interface <management_interface>

ノードの管理インターフェースを設定します。

--reset-management-interface

管理インターフェースをハードウェアタイプのデフォルトにリセットします。

--network-interface <network_interface>

ノードのネットワークインターフェースを設定します。

--reset-network-interface

ネットワークインターフェースをハードウェアタイプのデフォルトにリセットします。

--power-interface <power_interface>

ノードの電源インターフェースを設定します。

--reset-power-interface

電源インターフェースをハードウェアタイプのデフォルトにリセットします。

--raid-interface <raid_interface>

ノードの RAID インターフェースを設定します。

--reset-raid-interface

RAID インターフェースをハードウェアタイプのデフォルトにリセットします。

--rescue-interface <rescue_interface>

ノードのレスキューインターフェースを設定します。

--reset-rescue-interface

レスキューインターフェースをハードウェアタイプのデフォルトにリセットします。

--storage-interface <storage_interface>

ノードのストレージインターフェースを設定します。

--reset-storage-interface

ストレージインターフェースのハードウェアタイプのデフォルトにリセットします。

--vendor-interface <vendor_interface>

ノードのベンダーインターフェースを設定します。

--reset-vendor-interface

ベンダーインターフェースをハードウェアタイプのデフォルトにリセットします。

--reset-interfaces

明示的に指定されていないすべてのインターフェースをデフォルトの実装にリセットします。--driver と併用する場合のみ有効です。

--resource-class <resource_class>

ノードのリソースクラスを設定します。

--conductor-group <conductor_group>

ノードのコンダクターグループを設定します。

--automated-clean

ノードの自動クリーニングを有効化します。

--protected

ノードを「保護する」とマークします。

--protected-reason <protected_reason>

ノードを「保護する」とマークする理由を設定します。

--target-raid-config <target_raid_config>

ノードのターゲット RAID 構成(json)を設定します。これには、以下のいずれかを使用できます。1. RAID 設定の JSON データを含むファイル、2. 標準入力からコンテンツを読み取る "-"、3、有効な JSON 文字列。

--property <key=value>

このベアメタルノードに設定するプロパティー(複数のプロパティーを設定する場合はオプションを繰り返し使用します)

--extra <key=value>

このベアメタルノードに設定する追加項目(複数のプロパティーを設定する場合はオプションを繰り返し使用します)

--driver-info <key=value>

このベアメタルノードに設定するドライバー情報(複数のドライバー情報を設定する場合はオプションを繰り返し使用します)

--instance-info <key=value>

このベアメタルノードに設定するインスタンス情報(複数のインスタンス情報を設定する場合はオプションを繰り返し使用します)

--owner <owner>

ノードの所有者を設定します。

--description <description>

ノードの説明を設定します。

11.71. baremetal node show

ベアメタルノードの詳細を表示します。

使用方法

openstack baremetal node show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--instance]
                                     [--fields <field> [<field> ...]]
                                     <node>

表11.257 位置引数

概要

<node>

ノードの名前または uuid(または --instance が指定されている場合のインスタンスの uuid)

表11.258 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--instance

<node> はインスタンスの uuid です。

--fields <field> [<field> …​]

1 つ以上のノードフィールド。これらのフィールドのみがサーバーから取得されます。

表11.259 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.260 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.261 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.262 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.72. baremetal node trait list

ノードの特性を一覧表示します。

使用方法

openstack baremetal node trait list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           <node>

表11.263 位置引数

概要

<node>

ノードの名前または UUID

表11.264 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.265 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.266 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.267 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.268 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.73. baremetal node undeploy

ベアメタルノードのプロビジョニングの状態を deleted に設定します。

使用方法

openstack baremetal node undeploy [-h] [--wait [<time-out>]] <node>

表11.269 位置引数

概要

<node>

ノードの名前または UUID。

表11.270 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態(available)に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.74. baremetal node unrescue

ベアメタルノードのプロビジョニング状態を unrescue に設定します。

使用方法

openstack baremetal node unrescue [-h] [--wait [<time-out>]] <node>

表11.271 位置引数

概要

<node>

ノードの名前または UUID。

表11.272 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait [<time-out>]

ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値(秒単位)を指定できます。デフォルト値は 0 で、無期限に待機します。

11.75. baremetal node unset

ベアメタルプロパティーの設定を解除します。

使用方法

openstack baremetal node unset [-h] [--instance-uuid] [--name]
                                      [--resource-class]
                                      [--target-raid-config]
                                      [--property <key>] [--extra <key>]
                                      [--driver-info <key>]
                                      [--instance-info <key>] [--chassis-uuid]
                                      [--bios-interface] [--boot-interface]
                                      [--console-interface]
                                      [--deploy-interface]
                                      [--inspect-interface]
                                      [--management-interface]
                                      [--network-interface]
                                      [--power-interface] [--raid-interface]
                                      [--rescue-interface]
                                      [--storage-interface]
                                      [--vendor-interface] [--conductor-group]
                                      [--automated-clean] [--protected]
                                      [--protected-reason] [--owner]
                                      [--description]
                                      <node>

表11.273 位置引数

概要

<node>

ノードの名前または UUID。

表11.274 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--instance-uuid

このベアメタルノードでのインスタンスの uuid の設定を解除します。

--name

ノードの名前の設定を解除します。

--resource-class

ノードのリソースクラスの設定を解除します。

--target-raid-config

ノードのターゲット RAID 構成の設定を解除します。

--property <key>

このベアメタルノードで設定を解除するプロパティー(複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します)

--extra <key>

このベアメタルノードの設定を追加で解除する項目(複数のプロパティーを設定する場合はオプションを繰り返し使用します)

--driver-info <key>

このベアメタルノードでの設定を解除するドライバー情報(複数のドライバー情報の設定を解除する場合はオプションを繰り返し使用します)

--instance-info <key>

このベアメタルノードでの設定を解除するインスタンス情報(複数のインスタンス情報の設定を解除する場合はオプションを繰り返し使用します)

--chassis-uuid

このベアメタルノードでのシャーシ UUID の設定を解除します。

--bios-interface

このベアメタルノードでの bios インターフェースの設定を解除します。

--boot-interface

このベアメタルノードでのブートインターフェースの設定を解除します。

--console-interface

このベアメタルノードでのコンソールインターフェースの設定を解除します。

--deploy-interface

このベアメタルノードでのデプロイインターフェースの設定を解除します。

--inspect-interface

このベアメタルノードでの検査インターフェースの設定を解除します。

--management-interface

このベアメタルノードでの管理インターフェースの設定を解除します。

--network-interface

このベアメタルノードでのネットワークインターフェースの設定を解除します。

--power-interface

このベアメタルノードの電源インターフェースの設定を解除します。

--raid-interface

このベアメタルノードでの RAID インターフェースの設定を解除します。

--rescue-interface

このベアメタルノードでのレスキューインターフェースの設定を解除します。

--storage-interface

このベアメタルノードでのストレージインターフェースの設定を解除します。

--vendor-interface

このベアメタルノードでのベンダーインターフェースの設定を解除します。

--conductor-group

このベアメタルノードのコンダクターグループの設定を解除します(デフォルトのグループが使用されます)。

--automated-clean

このベアメタルノードでの自動クリーニングの設定を解除します(設定からの値が使用されます)。

--protected

ノード上の保護フラグの設定を解除します。

--protected-reason

保護理由の設定を解除します(保護が解除されると自動的にこの設定も解除されます。)

--owner

ノードの所有者フィールドの設定を解除します。

--description

ノードの説明フィールドの設定を解除します。

11.76. baremetal node validate

ノードのドライバーインターフェースを検証します。

使用方法

openstack baremetal node validate [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]
                                         <node>

表11.275 位置引数

概要

<node>

ノードの名前または UUID

表11.276 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.277 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.278 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.279 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.280 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.77. baremetal node vif attach

VIF を指定ノードに接続します。

使用方法

openstack baremetal node vif attach [-h] [--vif-info <key=value>]
                                           <node> <vif-id>

表11.281 位置引数

概要

<node>

ノードの名前または UUID

<vif-id>

ノードに割り当てる vif の名前または UUID。

表11.282 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--vif-info <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。必須の id パラメーターはキーとして指定できません。

11.78. baremetal node vif detach

指定のノードから VIF を切断します。

使用方法

openstack baremetal node vif detach [-h] <node> <vif-id>

表11.283 位置引数

概要

<node>

ノードの名前または UUID

<vif-id>

ノードから切り離す vif の名前または UUID。

表11.284 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.79. baremetal node vif list

ノードに接続された VIF を表示します。

使用方法

openstack baremetal node vif list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]
                                         <node>

表11.285 位置引数

概要

<node>

ノードの名前または UUID

表11.286 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表11.287 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.288 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.289 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.290 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.80. baremetal port create

新規ポートの作成

使用方法

openstack baremetal port create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] --node <uuid>
                                       [--uuid <uuid>] [--extra <key=value>]
                                       [--local-link-connection <key=value>]
                                       [-l <key=value>]
                                       [--pxe-enabled <boolean>]
                                       [--port-group <uuid>]
                                       [--physical-network <physical network>]
                                       [--is-smartnic]
                                       <address>

表11.291 位置引数

概要

<address>

このポートの MAC アドレス。

表11.292 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--node <uuid>

このポートが属するノードの UUID。

--uuid <uuid>

ポートの UUID

--extra <key=value>

任意のキー/値のメタデータを記録します。引数は複数回指定できます。

--local-link-connection <key=value>

ローカルリンク接続情報を記述するキー/値のメタデータ。有効なキーは switch_infoswitch_idport_id、および hostname です。switch_idport_id キーは必須です。スマート NIC ポートの場合に、必要なキーは port_idhostname です。引数は、複数回指定できます。

-l <key=value>

非推奨です。代わりに --local-link-connection を使用してください。ローカルリンク接続情報を記述するキー/値のメタデータ。有効なキーは switch_infoswitch_id、および port_id です。switch_idport_id キーは必須です。複数回指定できます。

--pxe-enabled <boolean>

このノードの PXE の起動時にこのポートを使用するかどうかを指定します。

--port-group <uuid>

このポートが属するポートグループの UUID。

--physical-network <physical network>

このポートを接続する物理ネットワークの名前。

--is-smartnic

このポートがスマート NIC ポートであるかどうかを指定します。

表11.293 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.294 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.295 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.296 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.81. baremetal port delete

ポートを削除します。

使用方法

openstack baremetal port delete [-h] <port> [<port> ...]

表11.297 位置引数

概要

<port>

削除するポートの UUID

表11.298 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.82. baremetal port group create

新規ベアメタルポートグループを作成します。

使用方法

openstack baremetal port group create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             --node <uuid>
                                             [--address <mac-address>]
                                             [--name NAME] [--uuid UUID]
                                             [--extra <key=value>]
                                             [--mode MODE]
                                             [--property <key=value>]
                                             [--support-standalone-ports | --unsupport-standalone-ports]

表11.299 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--node <uuid>

このポートグループが属するノードの UUID。

--address <mac-address>

このポートグループの MAC アドレス。

--name NAME

ポートグループの名前。

--uuid UUID

ポートグループの UUID

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

--mode MODE

ポートグループのモード。使用できる値は https://www.kernel.org/doc/Documentation/networking/bo nding.txt を参照してください。

--property <key=value>

このポートグループの設定に関連するキー/値プロパティー。複数回指定できます。

--support-standalone-ports

このポートグループのメンバーであるポートはスタンドアロンのポートとして使用できます(デフォルト)。

--unsupport-standalone-ports

このポートグループのメンバーであるポートは、スタンドアロンのポートとしては使用できません。

表11.300 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.301 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.302 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.303 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.83. baremetal port group delete

ベアメタルポートグループの登録を解除します。

使用方法

openstack baremetal port group delete [-h]
                                             <port group> [<port group> ...]

表11.304 位置引数

概要

<port group>

削除するポートグループ(名前または UUID)。

表11.305 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.84. baremetal port group list

ベアメタルポートグループを一覧表示します。

使用方法

openstack baremetal port group list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           [--limit <limit>]
                                           [--marker <port group>]
                                           [--sort <key>[:<direction>]]
                                           [--address <mac-address>]
                                           [--node <node>]
                                           [--long | --fields <field> [<field> ...]]

表11.306 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

要求ごとに返すポートグループの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <port group>

ポートグループの uuid (以前の要求リストにある最後のポートグループなど)。この UUID の後にポートグループの一覧を返します。

--sort <key>[:<direction>]

指定したポートグループのフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--address <mac-address>

この mac アドレスのポートグループに関する情報のみを表示します。

--node <node>

このノードのポートグループ(名前または UUID)のみを一覧表示します。

--long

ポートグループの詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のポートグループフィールド。これらのフィールドのみがサーバーから取得されます。-- long が指定されている場合は使用できません。

表11.307 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.308 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.309 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.310 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.85. 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>

表11.311 位置引数

概要

<port group>

ポートグループの名前または UUID。

表11.312 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--node <uuid>

このポートグループが属するノードの uuid を更新します。

--address <mac-address>

このポートグループの MAC アドレス。

--name <name>

ポートグループの名前。

--extra <key=value>

このベアメタルポートグループに設定する追加項目(複数の項目を設定する場合はオプションを繰り返し使用します)

--mode MODE

ポートグループのモード。使用できる値は https://www.kernel.org/doc/Documentation/networking/bo nding.txt を参照してください。

--property <key=value>

このポートグループの設定に関連するキー/値プロパティー(複数のプロパティーを設定する場合は、オプションを繰り返し使用します)。

--support-standalone-ports

このポートグループのメンバーであるポートは、スタンドアロンのポートとして使用できます。

--unsupport-standalone-ports

このポートグループのメンバーであるポートは、スタンドアロンのポートとしては使用できません。

11.86. baremetal port group show

ベアメタルポートグループの詳細を表示します。

使用方法

openstack baremetal port group show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--address]
                                           [--fields <field> [<field> ...]]
                                           <id>

表11.313 位置引数

概要

<id>

ポートグループの UUID または名前(または --address が指定されている場合は mac アドレス)。

表11.314 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--address

<id> は、ポートグループの mac アドレス(uuid または name ではなく)です。

--fields <field> [<field> …​]

1 つ以上のポートグループフィールド。これらのフィールドのみがサーバーから取得されます。

表11.315 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.316 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.317 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.318 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.87. baremetal port group unset

ベアメタルポートグループプロパティーの設定を解除します。

使用方法

openstack baremetal port group unset [-h] [--name] [--address]
                                            [--extra <key>] [--property <key>]
                                            <port group>

表11.319 位置引数

概要

<port group>

ポートグループの名前または UUID。

表11.320 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name

ポートグループの名前の設定を解除します。

--address

ポートグループのアドレスを解除します。

--extra <key>

このベアメタルポートグループで追加で設定を解除する項目(複数の項目の設定を解除する場合はオプションを繰り返し使用します)

--property <key>

このベアメタルポートグループで設定を解除するプロパティー(複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します)

11.88. baremetal port list

ベアメタルポートを一覧表示します。

使用方法

openstack baremetal port list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--address <mac-address>] [--node <node>]
                                     [--port-group <port group>]
                                     [--limit <limit>] [--marker <port>]
                                     [--sort <key>[:<direction>]]
                                     [--long | --fields <field> [<field> ...]]

表11.321 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--address <mac-address>

この mac アドレスのポートに関する情報のみを表示します。

--node <node>

このノードのポート(名前または UUID)のみを一覧表示します。

--port-group <port group>

このポートグループのポートのみを一覧表示します(名前または UUID)。

--limit <limit>

要求ごとに返すポートの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <port>

ポート uuid(以前の要求リストにある最後のポートなど)。この UUID の後にポートの一覧を返します。

--sort <key>[:<direction>]

指定したポートフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--long

ポートの詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のポートフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

表11.322 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.323 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.324 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.325 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.89. baremetal port set

ベアメタルポートのプロパティーを設定します。

使用方法

openstack baremetal port set [-h] [--node <uuid>] [--address <address>]
                                    [--extra <key=value>]
                                    [--port-group <uuid>]
                                    [--local-link-connection <key=value>]
                                    [--pxe-enabled | --pxe-disabled]
                                    [--physical-network <physical network>]
                                    [--is-smartnic]
                                    <port>

表11.326 位置引数

概要

<port>

ポートの UUID

表11.327 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--node <uuid>

このポートが属するノードの uuid を設定します。

--address <address>

このポートの mac アドレスを設定します。

--extra <key=value>

このベアメタルポートグループに設定する追加項目(複数の項目を設定する場合はオプションを繰り返し使用します)

--port-group <uuid>

このポートが属するポートグループの uuid を設定します。

--local-link-connection <key=value>

ローカルリンク接続情報を記述するキー/値のメタデータ。有効なキーは switch_infoswitch_idport_id、および hostname です。switch_idport_id キーは必須です。スマート NIC ポートの場合に、必要なキーは port_idhostname です。引数は、複数回指定できます。

--pxe-enabled

このノードの PXE の起動時にこのポートを使用するかどうかを指定します。

--pxe-disabled

このノードの PXE の起動時にこのポートを使用しないように指定します。

--physical-network <physical network>

このポートを接続する物理ネットワークの名前を設定します。

--is-smartnic

ポートをスマート NIC ポートに設定します。

11.90. baremetal port show

ベアメタルポートの詳細を表示します。

使用方法

openstack baremetal port show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty] [--address]
                                     [--fields <field> [<field> ...]]
                                     <id>

表11.328 位置引数

概要

<id>

ポートの UUID(--address が指定されている場合は mac アドレス)。

表11.329 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--address

<id> はポートの(uuid ではなく)mac アドレスです。

--fields <field> [<field> …​]

1 つ以上のポートフィールド。これらのフィールドのみがサーバーから取得されます。

表11.330 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.331 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.332 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.333 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.91. baremetal port unset

ベアメタルポートのプロパティーの設定を解除します。

使用方法

openstack baremetal port unset [-h] [--extra <key>] [--port-group]
                                      [--physical-network] [--is-smartnic]
                                      <port>

表11.334 位置引数

概要

<port>

ポートの UUID

表11.335 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--extra <key>

このベアメタルポートの設定を追加で解除する項目(複数のプロパティーを設定する場合はオプションを繰り返し使用します)

--port-group

ポートグループからポートを削除します。

--physical-network

このベアメタルポートで物理ネットワークの設定を解除します。

--is-smartnic

ポートをスマート NIC ポートとして設定します。

11.92. baremetal volume connector create

新しいベアメタルのボリュームコネクターを作成します。

使用方法

openstack baremetal volume connector create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty] --node
                                                   <uuid> --type <type>
                                                   --connector-id <connector
                                                   id> [--uuid <uuid>]
                                                   [--extra <key=value>]

表11.336 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--node <uuid>

このボリュームコネクターが属するノードの UUID。

--type <type>

ボリュームコネクターの種類。iqnipmacwwnnwwpnportportgroup

--connector-id <connector id>

指定のタイプのボリュームコネクター ID。たとえば、タイプが iqn の場合は、ノードの iSCSI イニシエーター IQN。

--uuid <uuid>

ボリュームコネクターの UUID。

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

表11.337 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.338 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.339 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.340 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.93. baremetal volume connector delete

ベアメタルボリュームコネクターの登録を解除します。

使用方法

openstack baremetal volume connector delete [-h]
                                                   <volume connector>
                                                   [<volume connector> ...]

表11.341 位置引数

概要

<volume connector>

削除するボリュームコネクターの UUID

表11.342 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.94. baremetal volume connector list

ベアメタルボリュームコネクターを一覧表示します。

使用方法

openstack baremetal volume connector list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]
                                                 [--node <node>]
                                                 [--limit <limit>]
                                                 [--marker <volume connector>]
                                                 [--sort <key>[:<direction>]]
                                                 [--long | --fields <field> [<field> ...]]

表11.343 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--node <node>

このノードのボリュームコネクター(名前または UUID)のみを一覧表示します。

--limit <limit>

要求ごとに返すボリュームの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <volume connector>

ボリュームコネクター UUID(以前の要求リストにある最後のボリュームコネクターなど)。この UUID の後にボリュームコネクターの一覧を返します。

--sort <key>[:<direction>]

指定したボリュームコネクターのフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--long

ボリュームコネクターの詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のボリュームコネクターフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

表11.344 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.345 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.346 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.347 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.95. baremetal volume connector set

ベアメタルボリュームコネクタープロパティーを設定します。

使用方法

openstack baremetal volume connector set [-h] [--node <uuid>]
                                                [--type <type>]
                                                [--connector-id <connector id>]
                                                [--extra <key=value>]
                                                <volume connector>

表11.348 位置引数

概要

<volume connector>

ボリュームコネクターの UUID。

表11.349 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--node <uuid>

このボリュームコネクターが属するノードの UUID。

--type <type>

ボリュームコネクターの種類。iqnipmacwwnnwwpnportportgroup

--connector-id <connector id>

指定したタイプのボリュームコネクターの ID。

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

11.96. baremetal volume connector show

ベアメタルボリュームコネクターの詳細を表示します。

使用方法

openstack baremetal volume connector show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--fields <field> [<field> ...]]
                                                 <id>

表11.350 位置引数

概要

<id>

ボリュームコネクターの UUID。

表11.351 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のボリュームコネクターフィールド。これらのフィールドのみがサーバーから取得されます。

表11.352 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.353 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.354 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.355 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.97. baremetal volume connector unset

ベアメタルボリュームコネクタープロパティーの設定を解除します。

使用方法

openstack baremetal volume connector unset [-h] [--extra <key>]
                                                  <volume connector>

表11.356 位置引数

概要

<volume connector>

ボリュームコネクターの UUID。

表11.357 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--extra <key>

設定を解除する追加項目(複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。)

11.98. baremetal volume target create

新しいベアメタルのボリュームターゲットを作成します。

使用方法

openstack baremetal volume target create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                --node <uuid> --type <volume
                                                type> [--property <key=value>]
                                                --boot-index <boot index>
                                                --volume-id <volume id>
                                                [--uuid <uuid>]
                                                [--extra <key=value>]

表11.358 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--node <uuid>

このボリュームターゲットが属するノードの UUID。

--type <volume type>

ボリュームターゲットのタイプ(例:iscsifibre_channel )。

--property <key=value>

このボリュームターゲットのタイプに関連するキー/値プロパティー。複数回指定できます。

--boot-index <boot index>

ボリュームターゲットのブートインデックス。

--volume-id <volume id>

このターゲットに関連付けられたボリュームの ID。

--uuid <uuid>

ボリュームターゲットの UUID

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

表11.359 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.360 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.361 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.362 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.99. baremetal volume target delete

ベアメタルボリュームのターゲットの登録を解除します。

使用方法

openstack baremetal volume target delete [-h]
                                                <volume target>
                                                [<volume target> ...]

表11.363 位置引数

概要

<volume target>

削除するボリュームターゲットの UUID。

表11.364 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

11.100. baremetal volume target list

ベアメタルボリュームターゲットを一覧表示します。

使用方法

openstack baremetal volume target list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              [--node <node>]
                                              [--limit <limit>]
                                              [--marker <volume target>]
                                              [--sort <key>[:<direction>]]
                                              [--long | --fields <field> [<field> ...]]

表11.365 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--node <node>

このノードのボリュームターゲット(名前または UUID)のみを一覧表示します。

--limit <limit>

要求ごとに返すボリュームターゲットの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。

--marker <volume target>

ボリュームターゲットの uuid(以前の要求リストにある最後のボリュームターゲットなど)。UUID の後にボリュームターゲットの一覧を返します。

--sort <key>[:<direction>]

指定したボリュームターゲットのフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。

--long

ボリュームターゲットの詳細情報を表示します。

--fields <field> [<field> …​]

1 つ以上のボリュームターゲットフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。

表11.366 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表11.367 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表11.368 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.369 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.101. 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>

表11.370 位置引数

概要

<volume target>

ボリュームターゲットの UUID

表11.371 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--node <uuid>

このボリュームターゲットが属するノードの UUID。

--type <volume type>

ボリュームターゲットのタイプ(例:iscsifibre_channel )。

--property <key=value>

このボリュームターゲットのタイプに関連するキー/値プロパティー。複数回指定できます。

--boot-index <boot index>

ボリュームターゲットのブートインデックス。

--volume-id <volume id>

このターゲットに関連付けられたボリュームの ID。

--extra <key=value>

任意のキー/値のメタデータを記録します。複数回指定できます。

11.102. baremetal volume target show

ベアメタルボリュームのターゲットの詳細を表示します。

使用方法

openstack baremetal volume target show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--fields <field> [<field> ...]]
                                              <id>

表11.372 位置引数

概要

<id>

ボリュームターゲットの UUID

表11.373 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fields <field> [<field> …​]

1 つ以上のボリュームターゲットフィールド。これらのフィールドのみがサーバーから取得されます。

表11.374 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表11.375 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表11.376 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表11.377 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

11.103. baremetal volume target unset

ベアメタルボリュームのターゲットプロパティーの設定を解除します。

使用方法

openstack baremetal volume target unset [-h] [--extra <key>]
                                               [--property <key>]
                                               <volume target>

表11.378 位置引数

概要

<volume target>

ボリュームターゲットの UUID

表11.379 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--extra <key>

設定を解除する追加項目(複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。)

--property <key>

このベアメタルボリュームターゲットで設定を解除するプロパティー(複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します)

第12章 bgp

本章では、bgp コマンドに含まれるコマンドについて説明します。

12.1. bgp dragent add speaker

BGP スピーカーを動的ルーティングエージェントに追加します。

使用方法

openstack bgp dragent add speaker [-h] <agent-id> <bgp-speaker>

表12.1 位置引数

概要

<agent-id>

動的ルーティングエージェントの ID

<bgp-speaker>

bgp スピーカーの ID または名前

表12.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

12.2. bgp dragent remove speaker

動的ルーティングエージェントから BGP スピーカーを削除します。

使用方法

openstack bgp dragent remove speaker [-h] <agent-id> <bgp-speaker>

表12.3 位置引数

概要

<agent-id>

動的ルーティングエージェントの ID

<bgp-speaker>

bgp スピーカーの ID または名前

表12.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

12.3. bgp peer create

BGP ピアを作成します。

使用方法

openstack bgp peer create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] --peer-ip <peer-ip-address>
                                 --remote-as <peer-remote-as>
                                 [--auth-type <peer-auth-type>]
                                 [--password <auth-password>]
                                 [--project <project>]
                                 [--project-domain <project-domain>]
                                 <name>

表12.5 位置引数

概要

<name>

作成する bgp ピアの名前

表12.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--peer-ip <peer-ip-address>

ピアの IP アドレス

--remote-as <peer-remote-as>

数字で表現したピア([1, 65535] の整数を使用可能)

--auth-type <peer-auth-type>

認証アルゴリズム。サポートされるアルゴリズム:none(デフォルト)、md5

--password <auth-password>

認証パスワード

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表12.7 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表12.8 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表12.9 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表12.10 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

12.4. bgp peer delete

BGP ピアを削除します。

使用方法

openstack bgp peer delete [-h] <bgp-peer>

表12.11 位置引数

概要

<bgp-peer>

削除する BGP ピア(名前または ID)

表12.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

12.5. bgp peer list

BGP ピアを一覧表示します。

使用方法

openstack bgp peer list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN]

表12.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表12.14 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表12.15 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表12.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表12.17 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

12.6. bgp peer set

BGP ピアを更新します。

使用方法

openstack bgp peer set [-h] [--name NAME] [--password <auth-password>]
                              <bgp-peer>

表12.18 位置引数

概要

<bgp-peer>

更新する BGP ピア(名前または ID)

表12.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

更新する Bgp ピア名

--password <auth-password>

更新する認証パスワード

12.7. bgp peer show

BGP ピアの情報を表示します。

使用方法

openstack bgp peer show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               <bgp-peer>

表12.20 位置引数

概要

<bgp-peer>

表示する BGP ピア(名前または ID)

表12.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表12.22 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表12.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表12.24 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表12.25 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

12.8. bgp speaker add network

BGP スピーカーにネットワークを追加します。

使用方法

openstack bgp speaker add network [-h] <bgp-speaker> <network>

表12.26 位置引数

概要

<bgp-speaker>

BGP スピーカー(名前または ID)

<network>

追加するネットワーク(名前または ID)

表12.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

12.9. bgp speaker add peer

BGP スピーカーにピアを追加します。

使用方法

openstack bgp speaker add peer [-h] <bgp-speaker> <bgp-peer>

表12.28 位置引数

概要

<bgp-speaker>

BGP スピーカー(名前または ID)

<bgp-peer>

追加する BGP ピア(名前または ID)

表12.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

12.10. bgp speaker create

BGP スピーカーを作成します。

使用方法

openstack bgp speaker create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] --local-as <local-as>
                                    [--ip-version {4,6}]
                                    [--advertise-floating-ip-host-routes]
                                    [--no-advertise-floating-ip-host-routes]
                                    [--advertise-tenant-networks]
                                    [--no-advertise-tenant-networks]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    <name>

表12.30 位置引数

概要

<name>

作成する bgp スピーカーの名前

表12.31 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--local-as <local-as>

数字で表現したローカル([1, 65535] の整数を使用可能)

--ip-version {4,6}

Bgp スピーカーの IP バージョン(デフォルトは 4)

--advertise-floating-ip-host-routes

BGP スピーカーにより Floating IP ホストルートの広告を有効にします(デフォルト)。

--no-advertise-floating-ip-host-routes

BGP スピーカーにより Floating IP ホストルートの広告を無効にします。

--advertise-tenant-networks

BGP スピーカーによりテナントネットワークルートの広告を有効にします(デフォルト)。

--no-advertise-tenant-networks

BGP スピーカーによりテナントネットワークルートの広告を無効にします。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表12.32 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表12.33 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表12.34 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表12.35 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

12.11. bgp speaker delete

BGP スピーカーを削除します。

使用方法

openstack bgp speaker delete [-h] <bgp-speaker>

表12.36 位置引数

概要

<bgp-speaker>

削除する BGP スピーカー(名前または ID)

表12.37 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

12.12. bgp speaker list advertised routes

広告されるルートを一覧表示します。

使用方法

openstack bgp speaker list advertised routes [-h]
                                                    [-f {csv,json,table,value,yaml}]
                                                    [-c COLUMN]
                                                    [--quote {all,minimal,none,nonnumeric}]
                                                    [--noindent]
                                                    [--max-width <integer>]
                                                    [--fit-width]
                                                    [--print-empty]
                                                    [--sort-column SORT_COLUMN]
                                                    <bgp-speaker>

表12.38 位置引数

概要

<bgp-speaker>

BGP スピーカー(名前または ID)

表12.39 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表12.40 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表12.41 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表12.42 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表12.43 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

12.13. bgp speaker list

BGP スピーカーを一覧表示します。

使用方法

openstack bgp speaker list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  [--agent <agent-id>]

表12.44 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--agent <agent-id>

エージェントがホストする bgp スピーカーの一覧を表示します(ID のみ)

表12.45 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表12.46 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表12.47 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表12.48 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

12.14. bgp speaker remove network

BGP スピーカーからのネットワークを削除します。

使用方法

openstack bgp speaker remove network [-h] <bgp-speaker> <network>

表12.49 位置引数

概要

<bgp-speaker>

BGP スピーカー(名前または ID)

<network>

削除するネットワーク(名前または ID)

表12.50 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

12.15. bgp speaker remove peer

BGP スピーカーからのピアを削除します。

使用方法

openstack bgp speaker remove peer [-h] <bgp-speaker> <bgp-peer>

表12.51 位置引数

概要

<bgp-speaker>

BGP スピーカー(名前または ID)

<bgp-peer>

削除する BGP ピア(名前または ID)

表12.52 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

12.16. bgp speaker set

BGP スピーカープロパティーを設定します。

使用方法

openstack bgp speaker set [-h] [--name NAME]
                                 [--advertise-floating-ip-host-routes]
                                 [--no-advertise-floating-ip-host-routes]
                                 [--advertise-tenant-networks]
                                 [--no-advertise-tenant-networks]
                                 <bgp-speaker>

表12.53 位置引数

概要

<bgp-speaker>

更新する BGP スピーカー(名前または ID)

表12.54 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

更新する bgp スピーカー名

--advertise-floating-ip-host-routes

BGP スピーカーにより Floating IP ホストルートの広告を有効にします(デフォルト)。

--no-advertise-floating-ip-host-routes

BGP スピーカーにより Floating IP ホストルートの広告を無効にします。

--advertise-tenant-networks

BGP スピーカーによりテナントネットワークルートの広告を有効にします(デフォルト)。

--no-advertise-tenant-networks

BGP スピーカーによりテナントネットワークルートの広告を無効にします。

12.17. bgp speaker show dragents

BGP スピーカーをホストする動的ルーティングエージェントを一覧で表示します。

使用方法

openstack bgp speaker show dragents [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           <bgp-speaker>

表12.55 位置引数

概要

<bgp-speaker>

bgp スピーカーの ID または名前

表12.56 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表12.57 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表12.58 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表12.59 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表12.60 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

12.18. bgp speaker show

BGP スピーカーを表示します。

使用方法

openstack bgp speaker show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <bgp-speaker>

表12.61 位置引数

概要

<bgp-speaker>

表示する BGP スピーカー(名前または ID)

表12.62 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表12.63 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表12.64 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表12.65 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表12.66 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第13章 bgpvpn

本章では、bgpvpn コマンドに含まれるコマンドについて説明します。

13.1. bgpvpn create

BGP VPN リソースを作成します。

使用方法

openstack bgpvpn create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--project <project>]
                               [--project-domain <project-domain>]
                               [--name <name>] [--route-target <route-target>]
                               [--import-target <import-target>]
                               [--export-target <export-target>]
                               [--route-distinguisher <route-distinguisher>]
                               [--vni VNI] [--local-pref LOCAL_PREF]
                               [--type {l2,l3}]

表13.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--name <name>

Bgp vpn の名前

--route-target <route-target>

インポート/エクスポートリストにルートターゲットを追加します(複数のルートターゲットを指定する場合はオプションを繰り返します)

--import-target <import-target>

インポートするルートターゲットを追加します(複数のルートターゲットを指定する場合はオプションを繰り返します)。

--export-target <export-target>

エクスポートリストにルートターゲットを追加します(複数のルートターゲットを指定する場合はオプションを繰り返します)

--route-distinguisher <route-distinguisher>

Route Distinguisher を選択して VPN ルートを広告する一覧に Route Distinguisher を追加します (Route Distinguisher を複数指定するには、オプションを繰り返し使用します)。

--vni VNI

VXLAN カプセル化を使用する場合は、この bgpvpn に使用する VXLAN ネットワーク ID

--local-pref LOCAL_PREF

この BGPVPN へのルート広告に使用するデフォルトの bgp local_pref。

--type {l2,l3}

ip vpn (l3) と Ethernet VPN (l2) の間の Bgp vpn タイプの選択 (デフォルト: l3)

表13.2 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表13.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表13.4 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表13.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.2. bgpvpn delete

BGP VPN リソースを削除します。

使用方法

openstack bgpvpn delete [-h] <bgpvpn> [<bgpvpn> ...]

表13.6 位置引数

概要

<bgpvpn>

削除する BGP vpn (名前または ID)

表13.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

13.3. bgpvpn list

BGP VPN リソースを一覧表示します。

使用方法

openstack bgpvpn list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--project <project>]
                             [--project-domain <project-domain>] [--long]
                             [--property <key=value>]

表13.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--long

出力の追加フィールドを一覧表示します。

--property <key=value>

返された bgp vpns に適用する filter プロパティー(複数のプロパティーで絞り込むには繰り返し指定します)

表13.9 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表13.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表13.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表13.12 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.4. bgpvpn network association create

BGP VPN ネットワークの関連付けを作成します。

使用方法

openstack bgpvpn network association create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--project <project>]
                                                   [--project-domain <project-domain>]
                                                   <bgpvpn> <network>

表13.13 位置引数

概要

<bgpvpn>

ネットワークの関連付け(名前または ID)を適用する BGP vpn

<network>

Bgp vpn(名前または ID)を関連付けるネットワーク

表13.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表13.15 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表13.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表13.17 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表13.18 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.5. bgpvpn network association delete

特定の BGP VPN の BGP VPN ネットワーク関連付けを削除します。

使用方法

openstack bgpvpn network association delete [-h]
                                                   <network association ID>
                                                   [<network association ID> ...]
                                                   <bgpvpn>

表13.19 位置引数

概要

<network association ID>

削除するネットワークの関連付け ID

<bgpvpn>

ネットワークの関連付けが所属する BGP vpn(名前または ID)

表13.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

13.6. bgpvpn network association list

特定の BGP VPN の BGP VPN ネットワーク関連付けを一覧で表示します。

使用方法

openstack bgpvpn network association list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]
                                                 [--long]
                                                 [--property <key=value>]
                                                 <bgpvpn>

表13.21 位置引数

概要

<bgpvpn>

記載の関連付けが(名前または ID)所属する bgp vpn

表13.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--property <key=value>

返された bgp vpns に適用する filter プロパティー(複数のプロパティーで絞り込むには繰り返し指定します)

表13.23 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表13.24 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表13.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表13.26 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.7. bgpvpn network association show

特定の BGP VPN ネットワーク関連付けの情報を表示します。

使用方法

openstack bgpvpn network association show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 <network association ID>
                                                 <bgpvpn>

表13.27 位置引数

概要

<network association ID>

検索するネットワークの関連付け ID

<bgpvpn>

この関連付けが所属する BGP vpn(名前または ID)

表13.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表13.29 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表13.30 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表13.31 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表13.32 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.8. bgpvpn port association create

BGP VPN ポートの関連付けを作成します。

使用方法

openstack bgpvpn port association create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--project <project>]
                                                [--project-domain <project-domain>]
                                                [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                                [--prefix-route prefix=<cidr>[,local_pref=<integer>]]
                                                [--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]]
                                                <bgpvpn> <port>

表13.33 位置引数

概要

<bgpvpn>

ポートの関連付け(名前または ID)を適用する BGP vpn

<port>

Bgp vpn(名前または ID)を関連付けるポート

表13.34 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--advertise-fixed-ips

ポートの固定 ip が bgp VPN に広告されます(デフォルト)。

--no-advertise-fixed-ips

ポートの固定 IP が BGP VPN に広告されません。

--prefix-route prefix=<cidr>[,local_pref=<integer>]

Cidr 表記でプレフィックスルートを追加します。オプションで、広告されるルートの BGP LOCAL_PREF の値を制御できます(複数のプレフィックスルートのオプション)。

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

ルートリークの bgp vpn ルートを追加します。オプションで、広告されるルートの BGP LOCAL_PREF の値を制御できます(複数の BGP VPN ルートのオプション)。

表13.35 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表13.36 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表13.37 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表13.38 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.9. bgp shared port association delete

特定の BGP VPN の BGP VPN ポートの関連付けを削除します。

使用方法

openstack bgpvpn port association delete [-h]
                                                <port association ID>
                                                [<port association ID> ...]
                                                <bgpvpn>

表13.39 位置引数

概要

<port association ID>

削除するポート関連 ID

<bgpvpn>

ポートの関連付けが属する bgp vpn(名前または ID)

表13.40 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

13.10. bgpvpn port association list

特定の BGP VPN の BGP VPN ポートの関連付けを一覧で表示します。

使用方法

openstack bgpvpn port association list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              [--long]
                                              [--property <key=value>]
                                              <bgpvpn>

表13.41 位置引数

概要

<bgpvpn>

記載の関連付けが(名前または ID)所属する bgp vpn

表13.42 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--property <key=value>

返された bgp vpns に適用する filter プロパティー(複数のプロパティーで絞り込むには繰り返し指定します)

表13.43 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表13.44 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表13.45 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表13.46 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.11. bgpvpn port association set

BGP VPN ポートの関連付けプロパティーを設定します。

使用方法

openstack bgpvpn port association set [-h]
                                             [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                             [--prefix-route prefix=<cidr>[,local_pref=<integer>]]
                                             [--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]]
                                             [--no-prefix-route]
                                             [--no-bgpvpn-route]
                                             <port association ID> <bgpvpn>

表13.47 位置引数

概要

<port association ID>

更新するポート関連付け ID

<bgpvpn>

ポートの関連付けが属する bgp vpn(名前または ID)

表13.48 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--advertise-fixed-ips

ポートの固定 ip が bgp VPN に広告されます。

--no-advertise-fixed-ips

ポートの固定 IP が BGP VPN に広告されません。

--prefix-route prefix=<cidr>[,local_pref=<integer>]

Cidr 表記でプレフィックスルートを追加します。オプションで、広告されるルートの BGP LOCAL_PREF の値を制御できます(複数のプレフィックスルートのオプション)。

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

ルートリークの bgp vpn ルートを追加します。オプションで、広告されるルートの BGP LOCAL_PREF の値を制御できます(複数の BGP VPN ルートのオプション)。

--no-prefix-route

空のプリフィックスルート一覧

--no-bgpvpn-route

Empty bgp vpn route list

13.12. bgp shared port association show

特定の BGP VPN ポートの関連付けの情報を表示します。

使用方法

openstack bgpvpn port association show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              <port association ID> <bgpvpn>

表13.49 位置引数

概要

<port association ID>

検索対象のポートの関連付け ID

<bgpvpn>

この関連付けが所属する BGP vpn(名前または ID)

表13.50 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表13.51 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表13.52 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表13.53 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表13.54 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.13. bgpvpn port association unset

BGP VPN ポートの関連付けプロパティーの設定を解除します。

使用方法

openstack bgpvpn port association unset [-h]
                                               [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                               [--prefix-route <cidr>]
                                               [--bgpvpn-route <BGP VPN ID or name>]
                                               [--all-prefix-routes]
                                               [--all-bgpvpn-routes]
                                               <port association ID> <bgpvpn>

表13.55 位置引数

概要

<port association ID>

更新するポート関連付け ID

<bgpvpn>

ポートの関連付けが属する bgp vpn(名前または ID)

表13.56 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--advertise-fixed-ips

ポートの固定 IP が BGP VPN に広告されません。

--no-advertise-fixed-ips

ポートの固定 ip が bgp VPN に広告されます。

--prefix-route <cidr>

Cidr 表記のプレフィックスルートを削除します(複数のプレフィックスルートを指定するにはオプションを繰り返し使用します)。

--bgpvpn-route <BGP VPN ID or name>

Bgp vpn ルートを削除します(複数の bgp VPN ルートの場合はオプションを繰り返し使用します)。

--all-prefix-routes

空のプリフィックスルート一覧

--all-bgpvpn-routes

Empty bgp vpn route list

13.14. bgpvpn router association create

BGP VPN ルーターの関連付けを作成します。

使用方法

openstack bgpvpn router association create [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--project <project>]
                                                  [--project-domain <project-domain>]
                                                  [--advertise_extra_routes | --no-advertise_extra_routes]
                                                  <bgpvpn> <router>

表13.57 位置引数

概要

<bgpvpn>

ルーターの関連付け(名前または ID)を適用する BGP vpn

<router>

Bgp vpn(名前または ID)を関連付けるルーター

表13.58 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--advertise_extra_routes

ルートは bgp vpn(デフォルト)に広告されます。

--no-advertise_extra_routes

ルーターからのルートは BGP VPN に広告されません。

表13.59 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表13.60 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表13.61 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表13.62 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.15. bgpvpn router association delete

特定の BGP VPN の BGP VPN ルーターの関連付けを削除します。

使用方法

openstack bgpvpn router association delete [-h]
                                                  <router association ID>
                                                  [<router association ID> ...]
                                                  <bgpvpn>

表13.63 位置引数

概要

<router association ID>

削除するルーターの関連付け ID

<bgpvpn>

ルーターの関連付けが所属する bgp vpn(名前または ID)

表13.64 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

13.16. bgpvpn router association list

特定の BGP VPN の BGP VPN ルーターの関連付けを一覧表示します。

使用方法

openstack bgpvpn router association list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--noindent]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                [--long]
                                                [--property <key=value>]
                                                <bgpvpn>

表13.65 位置引数

概要

<bgpvpn>

記載の関連付けが(名前または ID)所属する bgp vpn

表13.66 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--property <key=value>

返された bgp vpns に適用する filter プロパティー(複数のプロパティーで絞り込むには繰り返し指定します)

表13.67 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表13.68 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表13.69 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表13.70 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.17. bgpvpn router association set

BGP VPN ルーター関連付けプロパティーを設定します。

使用方法

openstack bgpvpn router association set [-h]
                                               [--advertise_extra_routes | --no-advertise_extra_routes]
                                               <router association ID>
                                               <bgpvpn>

表13.71 位置引数

概要

<router association ID>

更新するルーターの関連付け ID

<bgpvpn>

ルーターの関連付けが所属する bgp vpn(名前または ID)

表13.72 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--advertise_extra_routes

ルートは bgp vpn に広告されます。

--no-advertise_extra_routes

ルーターからのルートは BGP VPN に広告されません。

13.18. bgpvpn router association show

特定の BGP VPN ルーターの関連付けの情報を表示します。

使用方法

openstack bgpvpn router association show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                <router association ID>
                                                <bgpvpn>

表13.73 位置引数

概要

<router association ID>

検索するルーターの関連付け ID

<bgpvpn>

この関連付けが所属する BGP vpn(名前または ID)

表13.74 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表13.75 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表13.76 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表13.77 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表13.78 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.19. bgpvpn router association unset

BGP VPN ルーターの関連付けプロパティーの設定を解除します。

使用方法

openstack bgpvpn router association unset [-h]
                                                 [--advertise_extra_routes | --no-advertise_extra_routes]
                                                 <router association ID>
                                                 <bgpvpn>

表13.79 位置引数

概要

<router association ID>

更新するルーターの関連付け ID

<bgpvpn>

ルーターの関連付けが所属する bgp vpn(名前または ID)

表13.80 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--advertise_extra_routes

ルーターからのルートは BGP VPN に広告されません。

--no-advertise_extra_routes

ルートは bgp vpn に広告されます。

13.20. bgpvpn set

BGP VPN プロパティーを設定します。

使用方法

openstack bgpvpn set [-h] [--name <name>]
                            [--route-target <route-target>]
                            [--no-route-target]
                            [--import-target <import-target>]
                            [--no-import-target]
                            [--export-target <export-target>]
                            [--no-export-target]
                            [--route-distinguisher <route-distinguisher>]
                            [--no-route-distinguisher] [--vni VNI]
                            [--local-pref LOCAL_PREF]
                            <bgpvpn>

表13.81 位置引数

概要

<bgpvpn>

更新する BGP vpn(名前または ID)

表13.82 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

Bgp vpn の名前

--route-target <route-target>

インポート/エクスポートリストにルートターゲットを追加します(複数のルートターゲットを指定する場合はオプションを繰り返します)

--no-route-target

空のルートターゲット一覧

--import-target <import-target>

インポートするルートターゲットを追加します(複数のルートターゲットを指定する場合はオプションを繰り返します)。

--no-import-target

空のインポートルートターゲット一覧

--export-target <export-target>

エクスポートリストにルートターゲットを追加します(複数のルートターゲットを指定する場合はオプションを繰り返します)

--no-export-target

空のエクスポートルートターゲット一覧

--route-distinguisher <route-distinguisher>

Route Distinguisher を選択して VPN ルートを広告する一覧に Route Distinguisher を追加します (Route Distinguisher を複数指定するには、オプションを繰り返し使用します)。

--no-route-distinguisher

空のroute distinguisher 一覧

--vni VNI

VXLAN カプセル化を使用する場合は、この bgpvpn に使用する VXLAN ネットワーク ID

--local-pref LOCAL_PREF

この BGPVPN へのルート広告に使用するデフォルトの bgp local_pref。

13.21. bgpvpn show

特定の BGP VPN の情報を表示します。

使用方法

openstack bgpvpn show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <bgpvpn>

表13.83 位置引数

概要

<bgpvpn>

表示する BGP vpn(名前または ID)

表13.84 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表13.85 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表13.86 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表13.87 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表13.88 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

13.22. bgpvpn unset

BGP VPN プロパティーの設定を解除します。

使用方法

openstack bgpvpn unset [-h] [--route-target <route-target>]
                              [--all-route-target]
                              [--import-target <import-target>]
                              [--all-import-target]
                              [--export-target <export-target>]
                              [--all-export-target]
                              [--route-distinguisher <route-distinguisher>]
                              [--all-route-distinguisher] [--vni VNI]
                              [--local-pref LOCAL_PREF]
                              <bgpvpn>

表13.89 位置引数

概要

<bgpvpn>

更新する BGP vpn(名前または ID)

表13.90 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--route-target <route-target>

インポート/エクスポートリストからルートターゲットを削除します(複数のルートターゲットを指定する場合はオプションを繰り返します)。

--all-route-target

空のルートターゲット一覧

--import-target <import-target>

インポート一覧からルートターゲットを削除します(複数のルートターゲットを指定する場合はオプションを繰り返します)。

--all-import-target

空のインポートルートターゲット一覧

--export-target <export-target>

エクスポートリストからルートターゲットを削除します(複数のルートターゲットを指定する場合はオプションを繰り返します)。

--all-export-target

空のエクスポートルートターゲット一覧

--route-distinguisher <route-distinguisher>

Route Distinguisher を選択して VPN ルートを広告する一覧から Route Distinguisher を削除します (Route Distinguisher を複数指定するには、オプションを繰り返し使用します)。

--all-route-distinguisher

空のroute distinguisher 一覧

--vni VNI

VXLAN カプセル化を使用する場合は、この bgpvpn に使用する VXLAN ネットワーク ID

--local-pref LOCAL_PREF

この BGPVPN へのルート広告に使用するデフォルトの bgp local_pref。

第14章 ca

本章では、ca コマンドに含まれるコマンドについて説明します。

14.1. ca get

URI を指定して CA を取得します。

使用方法

openstack ca get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                        [--noindent] [--prefix PREFIX] [--max-width <integer>]
                        [--fit-width] [--print-empty]
                        URI

表14.1 位置引数

概要

URI

Ca の URI 参照。

表14.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表14.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表14.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表14.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表14.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

14.2. ca list

CA を一覧表示します。

使用方法

openstack ca list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                         [--quote {all,minimal,none,nonnumeric}] [--noindent]
                         [--max-width <integer>] [--fit-width] [--print-empty]
                         [--sort-column SORT_COLUMN] [--limit LIMIT]
                         [--offset OFFSET] [--name NAME]

表14.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit LIMIT, -l LIMIT

ページごとに表示する項目数に制限を指定します(デフォルト:10、最大: 100)。

--offset OFFSET, -o OFFSET

ページのオフセットを指定します(デフォルト:0)。

--name NAME, -n NAME

Ca 名を指定します(デフォルト:none)。

表14.8 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表14.9 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表14.10 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表14.11 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第15章 catalog

本章では、catalog コマンドに含まれるコマンドについて説明します。

15.1. catalog list

サービスカタログのサービスを一覧表示します。

使用方法

openstack catalog list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN]

表15.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表15.2 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表15.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表15.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表15.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

15.2. catalog show

サービスカタログの詳細を表示します。

使用方法

openstack catalog show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <service>

表15.6 位置引数

概要

<service>

表示するサービス(タイプまたは名前)

表15.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表15.8 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表15.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表15.10 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表15.11 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第16章 coe

本章では、coe コマンドに含まれるコマンドについて説明します。

16.1. coe ca rotate

クラスターがアクセスを取り消すために CA 証明書をローテーションします。

使用方法

openstack coe ca rotate [-h] <cluster>

表16.1 位置引数

概要

<cluster>

クラスターの ID または名前

表16.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

16.2. coe ca show

クラスターの CA 証明書の詳細を表示します。

使用方法

openstack coe ca show [-h] <cluster>

表16.3 位置引数

概要

<cluster>

クラスターの ID または名前

表16.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

16.3. coe ca sign

クラスターの CA 証明書を生成します。

使用方法

openstack coe ca sign [-h] <cluster> <csr>

表16.5 位置引数

概要

<cluster>

クラスターの ID または名前

<csr>

署名を取得するために magnum に送信する csr ファイルのファイルパス。

表16.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

16.4. coe cluster config

クラスターの設定を取得します。

使用方法

openstack coe cluster config [-h] [--dir <dir>] [--force]
                                    [--output-certs] [--use-certificate]
                                    [--use-keystone]
                                    <cluster>

表16.7 位置引数

概要

<cluster>

更新するクラスターの名前または UUID

表16.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--dir <dir>

証明書と設定ファイルを保存するディレクトリー。

--force

ファイルが存在する場合には、ファイルを上書きします。

--output-certs

別のファイルに証明書を出力します。

--use-certificate

設定ファイルで証明書を使用します。

--use-keystone

設定ファイルで keystone トークンを使用します。

16.5. coe cluster create

クラスターを作成します。

使用方法

openstack coe cluster create [-h] --cluster-template <cluster-template>
                                    [--discovery-url <discovery-url>]
                                    [--docker-volume-size <docker-volume-size>]
                                    [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                    [--keypair <keypair>]
                                    [--master-count <master-count>]
                                    [--node-count <node-count>]
                                    [--timeout <timeout>]
                                    [--master-flavor <master-flavor>]
                                    [--flavor <flavor>]
                                    [--fixed-network <fixed-network>]
                                    [--fixed-subnet <fixed-subnet>]
                                    [--floating-ip-enabled]
                                    [--floating-ip-disabled]
                                    <name>

表16.9 位置引数

概要

<name>

作成するクラスターの名前。

表16.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--cluster-template <cluster-template>

クラスターテンプレートの ID または名前

--discovery-url <discovery-url>

ノード検出用のカスタム配信 URL を指定します。

--docker-volume-size <docker-volume-size>

Docker ボリュームが使用するサイズ (gb 単位)。

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

クラスターテンプレートに関連付ける key=valuepairs 形式の任意のラベル。複数回の使用が可能です。

--keypair <keypair>

使用するキーペアの UUID または名前。

--master-count <master-count>

クラスターのマスターノードの数。

--node-count <node-count>

クラスターノードの数。

--timeout <timeout>

クラスター作成時間のタイムアウト。デフォルトは 60 分です。

--master-flavor <master-flavor>

クラスターのマスターノードを起動する時に使用する nova フレーバーの名前または UUID。

--flavor <flavor>

クラスターの起動時に使用する nova フレーバーの名前または UUID。

--fixed-network <fixed-network>

このクラスターテンプレートに接続するためのプライベート neutron ネットワーク名

--fixed-subnet <fixed-subnet>

クラスターに接続するためのプライベート neutron サブネット名。

--floating-ip-enabled

作成したクラスターに Floating IP が必要であるかどうかを指定します。

--floating-ip-disabled

新規クラスターでの Floating IP 作成を無効にします。

16.6. coe cluster delete

クラスターを削除します。

使用方法

openstack coe cluster delete [-h] <cluster> [<cluster> ...]

表16.11 位置引数

概要

<cluster>

削除するクラスターの ID または名前。

表16.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

16.7. coe cluster list

クラスターを一覧表示します。

使用方法

openstack coe cluster list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  [--limit <limit>] [--sort-key <sort-key>]
                                  [--sort-dir <sort-dir>]

表16.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

返すことのできるクラスターの最大数。

--sort-key <sort-key>

結果を並べ替えるコラム

--sort-dir <sort-dir>

ソートの方向。「asc」または「desc」。

表16.14 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表16.15 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表16.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表16.17 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.8. coe cluster resize

クラスターのサイズを調節します。

使用方法

openstack coe cluster resize [-h] [--nodes-to-remove <Server UUID>]
                                    [--nodegroup <nodegroup>]
                                    <cluster> node_count

表16.18 位置引数

概要

<cluster>

更新するクラスターの名前または UUID

node_count

Cluser の必要なノード数。

表16.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--nodes-to-remove <Server UUID>

削除するノードのサーバー ID。別のサーバー ID を追加するには繰り返し使用します。

--nodegroup <nodegroup>

現在のクラスターのノードグループの名前または UUID。

16.9. coe cluster show

クラスターを表示します。

使用方法

openstack coe cluster show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <cluster>

表16.20 位置引数

概要

<cluster>

表示するクラスターの ID または名前。

表16.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表16.22 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表16.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表16.24 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表16.25 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.10. coe cluster template create

クラスターテンプレートを作成します。

使用方法

openstack coe cluster template create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             --coe <coe> --image <image>
                                             --external-network
                                             <external-network>
                                             [--keypair <keypair>]
                                             [--fixed-network <fixed-network>]
                                             [--fixed-subnet <fixed-subnet>]
                                             [--network-driver <network-driver>]
                                             [--volume-driver <volume-driver>]
                                             [--dns-nameserver <dns-nameserver>]
                                             [--flavor <flavor>]
                                             [--master-flavor <master-flavor>]
                                             [--docker-volume-size <docker-volume-size>]
                                             [--docker-storage-driver <docker-storage-driver>]
                                             [--http-proxy <http-proxy>]
                                             [--https-proxy <https-proxy>]
                                             [--no-proxy <no-proxy>]
                                             [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                             [--tls-disabled] [--public]
                                             [--registry-enabled]
                                             [--server-type <server-type>]
                                             [--master-lb-enabled]
                                             [--floating-ip-enabled]
                                             [--floating-ip-disabled]
                                             [--hidden] [--visible]
                                             <name>

表16.26 位置引数

概要

<name>

作成するクラスターテンプレートの名前。

表16.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--Coe <coe>

使用するコンテナーオーケストレーションエンジンを指定します。

--image <image>

クラスター用にカスタマイズするベースイメージの名前または UUID。

--external-network <external-network>

このクラスターテンプレートに接続するための外部 neutron ネットワーク名または uuid。

--keypair <keypair>

クラスターノードに読み込む ssh キーペアの名前または UUID。

--fixed-network <fixed-network>

このクラスターモデルに接続するためのプライベート neutron ネットワーク名

--fixed-subnet <fixed-subnet>

クラスターに接続するためのプライベート neutron サブネット名。

--network-driver <network-driver>

コンテナーネットワークをインスタンス化するためのネットワークドライバー名。

--volume-driver <volume-driver>

コンテナーボリュームをインスタンス化するボリュームドライバー名。

--dns-nameserver <dns-nameserver>

このクラスターテンプレートに使用する dns ネームサーバー。

--flavor <flavor>

クラスターの起動時に使用する nova フレーバーの名前または UUID。

--master-flavor <master-flavor>

クラスターのマスターノードを起動する時に使用する nova フレーバーの名前または UUID。

--docker-volume-size <docker-volume-size>

Docker ボリュームで使用するサイズを GB 単位で指定します。

--docker-storage-driver <docker-storage-driver>

Docker ストレージドライバーを選択します。サポートされているドライバー:devicemapper、overlay。デフォルト:devicemapper

--http-proxy <http-proxy>

クラスターのノードに使用する http_proxy アドレス。

--https-proxy <https-proxy>

クラスターのノードに使用する https_proxy アドレス。

--no-proxy <no-proxy>

クラスターのノードに使用する no_proxy アドレス。

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

クラスターテンプレートに関連付ける key=value ペアの形式の任意のラベル。複数回の使用が可能です。

--tls-disabled

クラスターの tls を無効にします。

--public

クラスターテンプレートをパブリックにします。

--registry-enabled

クラスターでの docker レジストリーを有効化します。

--server-type <server-type>

Vm など、使用するサーバータイプを指定します。このリリースのデフォルトサーバータイプは vm です。

--master-lb-enabled

作成したクラスターにマスターノードのロードバランサーがあるかどうかを指定します。

--floating-ip-enabled

作成したクラスターに Floating IP が必要であるかどうかを指定します。

--floating-ip-disabled

新規クラスターでの Floating IP 作成を無効にします。

--hidden

クラスターテンプレートを非表示に指定します。

--visible

クラスターテンプレートを表示するように指定します。

表16.28 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表16.29 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表16.30 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表16.31 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.11. coe cluster template delete

クラスターテンプレートを削除します。

使用方法

openstack coe cluster template delete [-h]
                                             <cluster-templates>
                                             [<cluster-templates> ...]

表16.32 位置引数

概要

<cluster-templates>

削除するクラスターテンプレートの ID または名前

表16.33 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

16.12. coe cluster template list

クラスターテンプレートを一覧表示します。

使用方法

openstack coe cluster template list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           [--limit <limit>]
                                           [--sort-key <sort-key>]
                                           [--sort-dir <sort-dir>]
                                           [--fields <fields>]

表16.34 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

返すことのできるクラスターテンプレートの最大数。

--sort-key <sort-key>

結果を並べ替えるコラム

--sort-dir <sort-dir>

ソートの方向。「asc」または「desc」。

--fields <fields>

表示するフィールドのコンマ区切りリスト。uuid、name、coe、image_id、public、link、apiserver_port、server_type、tls_disabled、registry_enabled

表16.35 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表16.36 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表16.37 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表16.38 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.13. coe cluster template show

クラスターテンプレートを表示します。

使用方法

openstack coe cluster template show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           <cluster-template>

表16.39 位置引数

概要

<cluster-template>

表示するクラスターテンプレートの ID または名前。

表16.40 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表16.41 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表16.42 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表16.43 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表16.44 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.14. coe cluster template update

クラスターテンプレートを更新します。

使用方法

openstack coe cluster template update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <cluster-template> <op>
                                             <path=value> [<path=value> ...]

表16.45 位置引数

概要

<cluster-template>

更新するクラスターテンプレートの名前または UUID

<op>

操作:addreplace、または remove のいずれか

<path=value>

追加/置換または削除する属性(削除時にパスのみが必要)

表16.46 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表16.47 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表16.48 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表16.49 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表16.50 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.15. coe cluster update

クラスターを更新します。

使用方法

openstack coe cluster update [-h] [--rollback]
                                    <cluster> <op> <path=value>
                                    [<path=value> ...]

表16.51 位置引数

概要

<cluster>

更新するクラスターの名前または UUID

<op>

操作:addreplace、または remove のいずれか

<path=value>

追加/置換または削除する属性(削除時にパスのみが必要)

表16.52 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--rollback

更新の失敗時のクラスターをロールバックします。

16.16. coe cluster upgrade

クラスターをアップグレードします。

使用方法

openstack coe cluster upgrade [-h] [--max-batch-size <max_batch_size>]
                                     [--nodegroup <nodegroup>]
                                     <cluster> cluster_template

表16.53 位置引数

概要

<cluster>

更新するクラスターの名前または UUID

cluster_template

アップグレード先の新しいクラスターテンプレート ID 。

表16.54 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--max-batch-size <max_batch_size>

各アップグレード時の最大バッチサイズ。

--nodegroup <nodegroup>

現在のクラスターのノードグループの名前または UUID。

16.17. coe nodegroup create

ノードグループを作成します。

使用方法

openstack coe nodegroup create [-h]
                                      [--docker-volume-size <docker-volume-size>]
                                      [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                      [--node-count <node-count>]
                                      [--min-nodes <min-nodes>]
                                      [--max-nodes <max-nodes>]
                                      [--role <role>] [--image <image>]
                                      [--flavor <flavor>]
                                      <cluster> <name>

表16.55 位置引数

概要

<cluster>

作成するノードグループの名前。

<name>

作成するノードグループの名前。

表16.56 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--docker-volume-size <docker-volume-size>

Docker ボリュームが使用するサイズ (gb 単位)。

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

ノードグループに関連付ける key=valuepairs 形式の任意のラベル。複数回の使用が可能です。

--node-count <node-count>

ノードグループノード数。

--min-nodes <min-nodes>

ノードグループの最小のノード数。

--max-nodes <max-nodes>

ノードグループの最大数。

--role <role>

ノードグループのロール

--image <image>

ノードグループ向けにカスタマイズするベースイメージの名前または UUID。

--flavor <flavor>

このノードグループでノードを起動する時に使用する nova フレーバーの名前または UUID。

16.18. coe nodegroup delete

ノードグループを削除します。

使用方法

openstack coe nodegroup delete [-h]
                                      <cluster> <nodegroup> [<nodegroup> ...]

表16.57 位置引数

概要

<cluster>

ノードグループが所属するクラスターの ID または名前。

<nodegroup>

削除するノードグループの ID または名前。

表16.58 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

16.19. coe nodegroup list

ノードグループを一覧表示します。

使用方法

openstack coe nodegroup list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--limit <limit>] [--sort-key <sort-key>]
                                    [--sort-dir <sort-dir>] [--role <role>]
                                    <cluster>

表16.59 位置引数

概要

<cluster>

ノードグループが所属するクラスターの ID または名前。

表16.60 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

返すことのできるノードグループの最大数。

--sort-key <sort-key>

結果を並べ替えるコラム

--sort-dir <sort-dir>

ソートの方向。「asc」または「desc」。

--role <role>

このロールが割り当てられたクラスター内のノードグループを一覧表示します。

表16.61 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表16.62 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表16.63 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表16.64 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.20. coe nodegroup show

ノードグループを表示します。

使用方法

openstack coe nodegroup show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <cluster> <nodegroup>

表16.65 位置引数

概要

<cluster>

ノードグループが所属するクラスターの ID または名前。

<nodegroup>

表示するノードグループの ID または名前。

表16.66 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表16.67 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表16.68 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表16.69 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表16.70 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.21. coe nodegroup update

ノードグループを更新します。

使用方法

openstack coe nodegroup update [-h]
                                      <cluster> <nodegroup> <op> <path=value>
                                      [<path=value> ...]

表16.71 位置引数

概要

<cluster>

ノードグループが所属するクラスターの ID または名前。

<nodegroup>

更新するクラスターの名前または UUID

<op>

操作:addreplace、または remove のいずれか

<path=value>

追加/置換または削除する属性(削除時にパスのみが必要)

表16.72 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

16.22. coe quotas create

クォータを作成します。

使用方法

openstack coe quotas create [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

表16.73 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-id <project-id>

プロジェクト ID

--resource <resource>

リソース名。

--hard-limit <hard-limit>

最大リソース制限(デフォルト:hard-limit=1)

16.23. coe quotas delete

指定のリソースクォータを削除します。

使用方法

openstack coe quotas delete [-h] --project-id <project-id> --resource
                                   <resource>

表16.74 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-id <project-id>

プロジェクト ID

--resource <resource>

リソース名。

16.24. coe quotas list

利用可能なクォータ一覧を出力します。

使用方法

openstack coe quotas list [-h] [--marker <marker>] [--limit <limit>]
                                 [--sort-key <sort-key>]
                                 [--sort-dir <sort-dir>] [--all-tenants]

表16.75 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker <marker>

直前のページにある最後のクォータ uuid。「マーカー」の後ろのクォータの一覧を表示します。

--limit <limit>

返すことのできるクォータの最大数。

--sort-key <sort-key>

結果を並べ替えるコラム。

--sort-dir <sort-dir>

ソートの方向。「asc」または「desc」。

--all-tenants

すべてのテナントクォータの一覧を表示するように指定するフラグ。

16.25. coe quotas show

指定のプロジェクトリソースのクォータの詳細を表示します。

使用方法

openstack coe quotas show [-h] --project-id <project-id> --resource
                                 <resource>

表16.76 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-id <project-id>

プロジェクト ID

--resource <resource>

リソース名。

16.26. coe quotas update

指定のプロジェクトリソースクォータの情報を更新します。

使用方法

openstack coe quotas update [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

表16.77 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-id <project-id>

プロジェクト ID

--resource <resource>

リソース名。

--hard-limit <hard-limit>

最大リソース制限(デフォルト:hard-limit=1)

16.27. coe service list

Magnum サービスの一覧を出力します。

使用方法

openstack coe service list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]

表16.78 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表16.79 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表16.80 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表16.81 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表16.82 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

16.28. coe stats list

指定の project_id の統計を表示します。

使用方法

openstack coe stats list [-h] <project>

表16.83 位置引数

概要

<project>

プロジェクト ID

表16.84 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

第17章 command

本章では、command コマンドに含まれるコマンドについて説明します。

17.1. コマンドリスト

グループ別に認識されているコマンドを一覧表示します。

使用方法

openstack command list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN]
                              [--group <group-keyword>]

表17.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--group {keywor>

コマンドグループでフィルターされたコマンドを表示します(例:identity、volume、compute、image、network、およびその他のキーワード)。

表17.2 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表17.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表17.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表17.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第18章 complete.adoc

本章では、complete.adoc コマンドに含まれるコマンドについて説明します。

18.1. complete

バッシュ補完コマンドを出力します。

使用方法

openstack complete [-h] [--name <command_name>] [--shell <shell>]

表18.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <command_name>

コマンド補完でサポートされるコマンド名

--shell <shell>

使用するシェル。データのみの場合には none を使用します(デフォルト:bash)。

第19章 compute

本章では、compute コマンドに含まれるコマンドについて説明します。

19.1. compute agent create

コンピュートエージェントを作成します。

使用方法

openstack compute agent create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <os> <architecture> <version> <url>
                                      <md5hash> <hypervisor>

表19.1 位置引数

概要

<os>

OS のタイプ

<architecture>

アーキテクチャーのタイプ

<version>

バージョン

<url>

Url

<md5hash>

Md5 ハッシュ

<hypervisor>

ハイパーバイザーの種別

表19.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表19.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表19.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表19.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表19.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

19.2. Compute agent delete

コンピュートエージェントを削除します。

使用方法

openstack compute agent delete [-h] <id> [<id> ...]

表19.7 位置引数

概要

<id>

削除するエージェントの ID

表19.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

19.3. compute agent list

コンピュートエージェントを一覧表示します。

使用方法

openstack compute agent list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--hypervisor <hypervisor>]

表19.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--hypervisor <hypervisor>

ハイパーバイザーの種別

表19.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表19.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表19.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表19.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

19.4. compute agent set

コンピュートエージェントのプロパティーを設定します。

使用方法

openstack compute agent set [-h] [--agent-version <version>]
                                   [--url <url>] [--md5hash <md5hash>]
                                   <id>

表19.14 位置引数

概要

<id>

エージェントの ID

表19.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--agent-version <version>

エージェントのバージョン

--url <url>

エージェントの URL

--md5hash <md5hash>

エージェントの Md5 ハッシュ

19.5. compute service delete

コンピュートサービスを削除します。

使用方法

openstack compute service delete [-h] <service> [<service> ...]

表19.16 位置引数

概要

<service>

削除する Compute サービス(id のみ)。''--os-compute- api-version'' で 2.53 以降を使用している場合、ID は UUID で、同じ 2.53+ マイクロバージョンを使用してコンピュートサービスを一覧表示して取得できます。

表19.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

19.6. compute service list

コンピュートサービスを一覧表示します。''--os-compute-api-version'' 2.53 以降を使用すると、ID は UUID 値として返されます。これは、マルチセルデプロイメントでサービスを一意に識別するために使用できます。

使用方法

openstack compute service list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--host <host>] [--service <service>]
                                      [--long]

表19.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--host <host>

指定したホストでサービスを一覧表示します(名前のみ)。

--service <service>

指定したサービスバイナリーのみを一覧表示します(名前のみ)。例: ''nova-compute'', ''nova-conductor'' など。

--long

出力の追加フィールドを一覧表示します。

表19.19 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表19.20 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表19.21 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表19.22 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

19.7. compute service set

コンピュートサービス属性を設定します。

使用方法

openstack compute service set [-h] [--enable | --disable]
                                     [--disable-reason <reason>]
                                     [--up | --down]
                                     <host> <service>

表19.23 位置引数

概要

<host>

ホスト名

<service>

サービス名(バイナリー名)(例:''nova- compute'')

表19.24 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--enable

サービスを有効化します。

--disable

サービスを無効化します。

--disable-reason <reason>

サービスを無効にする理由(引用符で囲む)。--disable オプションと併用する必要があります。

--up

サービスを強制的に起動します。これには ''--os-compute-api- version'' 2.11 以降が必要です。

--down

サービスを強制的に終了します。これには ''--os-compute-api- version'' 2.11 以降が必要です。

第20章 configuration

本章では、configuration コマンドに含まれるコマンドについて説明します。

20.1. configuration show

設定を詳細表示します。

使用方法

openstack configuration show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--mask | --unmask]

表20.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--mask

パスワードのマスクを試行します(デフォルト)

--unmask

パスワードをクリアテキストで表示します。

表20.2 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表20.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表20.4 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表20.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第21章 一貫性

本章では、consistency コマンドに含まれるコマンドについて説明します。

21.1. consistency group add volume

整合性グループにボリュームを追加します。

使用方法

openstack consistency group add volume [-h]
                                              <consistency-group> <volume>
                                              [<volume> ...]

表21.1 位置引数

概要

<consistency-group>

<volume> を含む整合性グループ (名前または id)

<volume>

<consistency-group> (名前または id) に追加するボリューム (複数のボリュームを追加する場合はオプションを繰り返し使用します)

表21.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

21.2. consistency group create

新規整合性グループを作成します。

使用方法

openstack consistency group create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          (--volume-type <volume-type> | --consistency-group-source <consistency-group> | --consistency-group-snapshot <consistency-group-snapshot>)
                                          [--description <description>]
                                          [--availability-zone <availability-zone>]
                                          [<name>]

表21.3 位置引数

概要

<name>

新規整合性グループの名前(デフォルトは none)

表21.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--volume-type <volume-type>

この整合性グループのボリューム種別(名前または ID)

--consistency-group-source <consistency-group>

既存の整合性グループ(名前または ID)

--consistency-group-snapshot <consistency-group-snapshot>

既存の整合性グループのスナップショット(名前または ID)

--description <description>

この整合性グループの説明

--availability-zone <availability-zone>

この整合性グループのアベイラビリティーゾーン(ソースから整合性グループを作成する場合は利用できません)

表21.5 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表21.6 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表21.7 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表21.8 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

21.3. consistency group delete

整合性グループを削除します。

使用方法

openstack consistency group delete [-h] [--force]
                                          <consistency-group>
                                          [<consistency-group> ...]

表21.9 位置引数

概要

<consistency-group>

削除する整合性グループ(名前または ID)

表21.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--force

Error または available 以外の状態で削除を可能にします。

21.4. consistency group list

整合性グループを一覧表示します。

使用方法

openstack consistency group list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--all-projects] [--long]

表21.11 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの詳細を表示します。管理者のみ(デフォルトは False)

--long

出力の追加フィールドを一覧表示します。

表21.12 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表21.13 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表21.14 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表21.15 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

21.5. consistency group remove volume

整合性グループからボリュームを削除します。

使用方法

openstack consistency group remove volume [-h]
                                                 <consistency-group> <volume>
                                                 [<volume> ...]

表21.16 位置引数

概要

<consistency-group>

<volume>(名前または ID)を含む整合性グループ

<volume>

<consistency-group> (名前または id) から削除するボリューム (複数のボリュームを削除する場合はオプションを繰り返し使用します)

表21.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

21.6. consistency group set

整合性グループのプロパティーを設定します。

使用方法

openstack consistency group set [-h] [--name <name>]
                                       [--description <description>]
                                       <consistency-group>

表21.18 位置引数

概要

<consistency-group>

変更する整合性グループ(名前または ID)

表21.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

整合性グループの新しい名前

--description <description>

整合性グループの新たな説明

21.7. consistency group show

整合性グループの詳細を表示します。

使用方法

openstack consistency group show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <consistency-group>

表21.20 位置引数

概要

<consistency-group>

表示する整合性グループ(名前または ID)

表21.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表21.22 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表21.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表21.24 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表21.25 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

21.8. consistency group snapshot create

新規整合性グループのスナップショットを作成します。

使用方法

openstack consistency group snapshot create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--consistency-group <consistency-group>]
                                                   [--description <description>]
                                                   [<snapshot-name>]

表21.26 位置引数

概要

<snapshot-name>

新規整合性グループのスナップショット名(デフォルトは None)

表21.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--consistency-group <consistency-group>

スナップショット(名前または ID)を作成する整合性グループ(デフォルトは <snapshot-name> と同じ)

--description <description>

この整合性グループのスナップショットの説明

表21.28 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表21.29 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表21.30 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表21.31 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

21.9. consistency group snapshot delete

整合性グループのスナップショットを削除します。

使用方法

openstack consistency group snapshot delete [-h]
                                                   <consistency-group-snapshot>
                                                   [<consistency-group-snapshot> ...]

表21.32 位置引数

概要

<consistency-group-snapshot>

削除する整合性グループのスナップショット(名前または ID)

表21.33 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

21.10. consistency group snapshot list

整合性グループのスナップショットを一覧表示します。

使用方法

openstack consistency group snapshot list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]
                                                 [--all-projects] [--long]
                                                 [--status <status>]
                                                 [--consistency-group <consistency-group>]

表21.34 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの詳細を表示します。管理者のみ(デフォルトは False)

--long

出力の追加フィールドを一覧表示します。

--status <status>

ステータスで結果をフィルターします(「available」、「error」、「deleting」、「deleting」、または「error_deleting」)。

--consistency-group <consistency-group>

整合性グループ(名前または ID)で結果をフィルターします。

表21.35 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表21.36 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表21.37 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表21.38 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

21.11. consistency group snapshot show

整合性グループのスナップショットの詳細を表示します。

使用方法

openstack consistency group snapshot show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 <consistency-group-snapshot>

表21.39 位置引数

概要

<consistency-group-snapshot>

表示する整合性グループのスナップショット(名前または ID)

表21.40 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表21.41 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表21.42 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表21.43 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表21.44 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第22章 console

本章では、console コマンドに含まれるコマンドについて説明します。

22.1. console log show

サーバーのコンソール出力を表示します。

使用方法

openstack console log show [-h] [--lines <num-lines>] <server>

表22.1 位置引数

概要

<server>

コンソールログ(名前または ID)を表示するサーバー

表22.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--lines <num-lines>

ログの末尾から表示する行数(デフォルト=all)。

22.2. console url show

サーバーのリモートコンソール URL を表示します。

使用方法

openstack console url show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  [--novnc | --xvpvnc | --spice | --rdp | --serial | --mks]
                                  <server>

表22.3 位置引数

概要

<server>

URL(名前または ID)を表示するサーバー

表22.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--novnc

Novnc コンソール URL を表示します(デフォルト)

--xvpvnc

Xvpvnc コンソール URL を表示します。

--SPICE

Spice コンソールの URL を表示します。

--rdp

Rdp コンソールの URL を表示します。

--serial

シリアルコンソールの URL を表示します。

--mks

Webmks コンソールの URL を表示します。

表22.5 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表22.6 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表22.7 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表22.8 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第23章 consumer

本章では、consumer コマンドに含まれるコマンドについて説明します。

23.1. consumer create

新規コンシューマーを作成します。

使用方法

openstack consumer create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--description <description>]

表23.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

新規コンシューマーの説明

表23.2 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表23.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表23.4 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表23.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

23.2. consumer delete

コンシューマーを削除します。

使用方法

openstack consumer delete [-h] <consumer> [<consumer> ...]

表23.6 位置引数

概要

<consumer>

削除するコンシューマー

表23.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

23.3. consumer list

コンシューマーを一覧表示します。

使用方法

openstack consumer list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN]

表23.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表23.9 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表23.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表23.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表23.12 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

23.4. consumer set

コンシューマープロパティーを設定します。

使用方法

openstack consumer set [-h] [--description <description>] <consumer>

表23.13 位置引数

概要

<consumer>

変更するコンシューマー

表23.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

新規コンシューマーの説明

23.5. consumer show

コンシューマーの詳細を表示します。

使用方法

openstack consumer show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               <consumer>

表23.15 位置引数

概要

<consumer>

表示するコンシューマー

表23.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表23.17 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表23.18 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表23.19 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表23.20 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第24章 container

本章では、container コマンドに含まれるコマンドについて説明します。

24.1. container create

新規コンテナーを作成します。

使用方法

openstack container create [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  <container-name> [<container-name> ...]

表24.1 位置引数

概要

<container-name>

新しいコンテナー名

表24.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表24.3 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表24.4 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表24.5 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表24.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

24.2. container delete

コンテナーを削除します。

使用方法

openstack container delete [-h] [--recursive]
                                  <container> [<container> ...]

表24.7 位置引数

概要

<container>

削除するコンテナー

表24.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--recursive, -r

オブジェクトおよびコンテナーを再帰的に削除します。

24.3. container list

コンテナーの一覧表示

使用方法

openstack container list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--noindent] [--max-width <integer>]
                                [--fit-width] [--print-empty]
                                [--sort-column SORT_COLUMN]
                                [--prefix <prefix>] [--marker <marker>]
                                [--end-marker <end-marker>]
                                [--limit <num-containers>] [--long] [--all]

表24.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--prefix <prefix>

<prefix> を使用して一覧をフィルターします。

--marker <marker>

ページングのアンカー

--end-marker <end-marker>

ページングの終了アンカー

--limit <num-containers>

返されるコンテナーの数を制限します。

--long

出力の追加フィールドを一覧表示します。

--all

すべてのコンテナーを一覧表示します(デフォルトは 10000)。

表24.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表24.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表24.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表24.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

24.4. container save

コンテナーのコンテンツをローカルで保存します。

使用方法

openstack container save [-h] <container>

表24.14 位置引数

概要

<container>

保存するコンテナー

表24.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

24.5. container set

コンテナープロパティーを設定します。

使用方法

openstack container set [-h] --property <key=value> <container>

表24.16 位置引数

概要

<container>

変更するコンテナー

表24.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key=value>

このコンテナーにプロパティーを設定します(複数のプロパティーを設定する場合はオプションを繰り返し使用します)

24.6. container show

コンテナーの詳細を表示します。

使用方法

openstack container show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                <container>

表24.18 位置引数

概要

<container>

表示するコンテナー

表24.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表24.20 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表24.21 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表24.22 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表24.23 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

24.7. container unset

コンテナーのプロパティーの設定を解除します。

使用方法

openstack container unset [-h] --property <key> <container>

表24.24 位置引数

概要

<container>

変更するコンテナー

表24.25 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key>

コンテナーから削除するプロパティー(複数のプロパティーを削除する場合はオプションを繰り返し使用します)

第25章 credential

本章では、credential コマンドに含まれるコマンドについて説明します。

25.1. credential create

新規認証情報を作成します。

使用方法

openstack credential create [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty] [--type <type>]
                                   [--project <project>]
                                   <user> <data>

表25.1 位置引数

概要

<user>

認証情報を所有するユーザー(名前または ID)

<data>

新しい認証情報データ

表25.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--type <type>

新規の認証タイプ:cert、ec2、tp など

--project <project>

認証情報の範囲を制限するプロジェクト(名前または ID)

表25.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表25.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表25.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表25.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

25.2. credential delete

認証情報を削除します。

使用方法

openstack credential delete [-h] <credential-id> [<credential-id> ...]

表25.7 位置引数

概要

<credential-id>

削除する認証情報の ID

表25.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

25.3. credential list

認証情報を一覧表示します。

使用方法

openstack credential list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN] [--user <user>]
                                 [--user-domain <user-domain>] [--type <type>]

表25.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--user <user>

<user>(名前または ID)別に認証情報をフィルターします。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

--type <type>

タイプで認証情報をフィルターします(cert、ec2、totp など)。

表25.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表25.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表25.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表25.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

25.4. credential set

認証情報のプロパティーを設定します。

使用方法

openstack credential set [-h] --user <user> --type <type> --data <data>
                                [--project <project>]
                                <credential-id>

表25.14 位置引数

概要

<credential-id>

変更する認証情報の ID

表25.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--user <user>

認証情報を所有するユーザー(名前または ID)

--type <type>

新規の認証タイプ:cert、ec2、tp など

--data <data>

新しい認証情報データ

--project <project>

認証情報の範囲を制限するプロジェクト(名前または ID)

25.5. credential show

認証情報の詳細を表示します。

使用方法

openstack credential show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <credential-id>

表25.16 位置引数

概要

<credential-id>

表示する認証情報の ID

表25.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表25.18 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表25.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表25.20 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表25.21 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第26章 cron

本章では、cron コマンドに含まれるコマンドについて説明します。

26.1. cron trigger create

新規トリガーを作成します。

使用方法

openstack cron trigger create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--params PARAMS] [--pattern <* * * * *>]
                                     [--first-time <YYYY-MM-DD HH:MM>]
                                     [--count <integer>] [--utc]
                                     name workflow_identifier [workflow_input]

表26.1 位置引数

概要

name

Cron trigger の名前

workflow_identifier

ワークフローの名前または ID

workflow_input

ワークフロー入力

表26.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--params PARAMS

ワークフローパラメーター

--pattern <* * * * *>

Cron trigger のパターン

--first-time <YYYY-MM-DD HH:MM>

最初の実行日時。時間は、--utc も併せて指定されていない場合にローカル時間として処理されます。

--count <integer>

任意の実行数

--utc

指定した時間はすべて utc として処理する必要があります。

表26.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表26.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表26.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表26.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

26.2. cron trigger delete

トリガーを削除します。

使用方法

openstack cron trigger delete [-h] cron_trigger [cron_trigger ...]

表26.7 位置引数

概要

cron_trigger

Cron トリガーの名前。

表26.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

26.3. cron trigger list

すべての cron トリガーを一覧表示します。

使用方法

openstack cron trigger list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--marker [MARKER]] [--limit [LIMIT]]
                                   [--sort_keys [SORT_KEYS]]
                                   [--sort_dirs [SORT_DIRS]]
                                   [--filter FILTERS]

表26.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

表26.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表26.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表26.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表26.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

26.4. cron trigger show

特定の cron トリガーを表示します。

使用方法

openstack cron trigger show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   cron_trigger

表26.14 位置引数

概要

cron_trigger

Cron trigger の名前

表26.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表26.16 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表26.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表26.18 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表26.19 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第27章 datastore

本章では、datastore コマンドに含まれるコマンドについて説明します。

27.1. datastore list

利用可能なデータストアを一覧表示します。

使用方法

openstack datastore list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--noindent] [--max-width <integer>]
                                [--fit-width] [--print-empty]
                                [--sort-column SORT_COLUMN]

表27.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表27.2 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表27.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表27.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表27.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

27.2. datastore show

データストアの詳細を表示します。

使用方法

openstack datastore show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                <datastore>

表27.6 位置引数

概要

<datastore>

データストアの ID

表27.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表27.8 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表27.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表27.10 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表27.11 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

27.3. datastore version list

データストアで利用可能なバージョンを一覧表示します。

使用方法

openstack datastore version list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        <datastore>

表27.12 位置引数

概要

<datastore>

データストアの ID または名前

表27.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表27.14 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表27.15 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表27.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表27.17 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

27.4. datastore version show

データストアバージョンの詳細を表示します。

使用方法

openstack datastore version show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--datastore <datastore>]
                                        <datastore_version>

表27.18 位置引数

概要

<datastore_version>

データストアバージョンの ID または名前。

表27.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--datastore <datastore>

データストアの ID または名前。Datastore_version の ID が指定されている場合はオプションになります。

表27.20 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表27.21 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表27.22 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表27.23 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第28章 dns

本章では、dns コマンドに含まれるコマンドについて説明します。

28.1. dns quota list

クォータを一覧表示します。

使用方法

openstack dns quota list [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                [--project-id PROJECT_ID]

表28.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--project-id PROJECT_ID

プロジェクト ID のデフォルト:現在のプロジェクト

表28.2 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表28.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表28.4 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表28.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

28.2. dns quota reset

クォータをリセットします。

使用方法

openstack dns quota reset [-h] [--all-projects] [--edit-managed]
                                 [--sudo-project-id SUDO_PROJECT_ID]
                                 [--project-id PROJECT_ID]

表28.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--project-id PROJECT_ID

プロジェクト ID

28.3. dns quota set

クォータを設定します。

使用方法

openstack dns quota set [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--all-projects]
                               [--edit-managed]
                               [--sudo-project-id SUDO_PROJECT_ID]
                               [--project-id PROJECT_ID]
                               [--api-export-size <api-export-size>]
                               [--recordset-records <recordset-records>]
                               [--zone-records <zone-records>]
                               [--zone-recordsets <zone-recordsets>]
                               [--zones <zones>]

表28.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

--project-id PROJECT_ID

プロジェクト ID

--api-export-size <api-export-size>

Api-export-size クォータの新しい値

--recordset-records <recordset-records>

Recordset-records クォータの新しい値

--zone-records <zone-records>

Zone-records クォータの新しい値

--zone-recordsets <zone-recordsets>

Zone-recordsets クォータの新しい値

--zones <zones>

ゾーンクォータの新しい値

表28.8 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表28.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表28.10 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表28.11 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

28.4. dns service list

サービスステータスを一覧表示します。

使用方法

openstack dns service list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  [--hostname HOSTNAME]
                                  [--service_name SERVICE_NAME]
                                  [--status STATUS] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]

表28.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--hostname HOSTNAME

Hostname

--service_name SERVICE_NAME

サービス名

--status STATUS

Status

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表28.13 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表28.14 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表28.15 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表28.16 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

28.5. dns service show

サービスステータスの詳細を表示します。

使用方法

openstack dns service show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  id

表28.17 位置引数

概要

id

サービスのステータス ID

表28.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表28.19 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表28.20 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表28.21 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表28.22 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第29章 domain

本章では、domain コマンドに含まれるコマンドについて説明します。

29.1. domain create

新規ドメインを作成します。

使用方法

openstack domain create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--description <description>]
                               [--enable | --disable] [--or-show]
                               <domain-name>

表29.1 位置引数

概要

<domain-name>

新規ドメイン名

表29.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

新規ドメインの説明

--enable

ドメインを有効化します(デフォルト)。

--disable

ドメインを無効化します。

--or-show

既存のドメインを返します。

表29.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表29.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表29.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表29.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

29.2. domain delete

ドメインを削除します。

使用方法

openstack domain delete [-h] <domain> [<domain> ...]

表29.7 位置引数

概要

<domain>

削除するドメイン(名前または ID)

表29.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

29.3. ドメインリスト

ドメインの一覧を表示します。

使用方法

openstack domain list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN]

表29.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表29.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表29.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表29.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表29.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

29.4. domain set

ドメインプロパティーを設定します。

使用方法

openstack domain set [-h] [--name <name>] [--description <description>]
                            [--enable | --disable]
                            <domain>

表29.14 位置引数

概要

<domain>

変更するドメイン(名前または ID)

表29.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新規ドメイン名

--description <description>

新規ドメインの説明

--enable

ドメインを有効化します。

--disable

ドメインを無効化します。

29.5. domain show

ドメインの詳細を表示します。

使用方法

openstack domain show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <domain>

表29.16 位置引数

概要

<domain>

表示するドメイン(名前または ID)

表29.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表29.18 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表29.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表29.20 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表29.21 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第30章 ec2

本章では、ec2 コマンドに含まれるコマンドについて説明します。

30.1. ec2 credentials create

EC2 認証情報を作成します。

使用方法

openstack ec2 credentials create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--project <project>]
                                        [--user <user>]
                                        [--user-domain <user-domain>]
                                        [--project-domain <project-domain>]

表30.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

プロジェクトで認証情報を作成します(名前または ID、デフォルト:現在の認証プロジェクト)。

--user <user>

ユーザーの認証情報を作成します(名前または ID、デフォルト:現在の認証ユーザー)。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表30.2 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表30.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表30.4 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表30.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

30.2. ec2 credentials delete

EC2 認証情報を削除します。

使用方法

openstack ec2 credentials delete [-h] [--user <user>]
                                        [--user-domain <user-domain>]
                                        <access-key> [<access-key> ...]

表30.6 位置引数

概要

<access-key>

認証情報アクセスキー

表30.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--user <user>

ユーザーの認証情報を削除します(名前または ID)。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

30.3. ec2 credentials list

EC2 認証情報を一覧表示します。

使用方法

openstack ec2 credentials list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--user <user>]
                                      [--user-domain <user-domain>]

表30.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--user <user>

ユーザー別にリストを絞り込みます(名前または ID)。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

表30.9 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表30.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表30.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表30.12 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

30.4. ec2 credentials show

EC2 認証情報の詳細を表示します。

使用方法

openstack ec2 credentials show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--user <user>]
                                      [--user-domain <user-domain>]
                                      <access-key>

表30.13 位置引数

概要

<access-key>

認証情報アクセスキー

表30.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--user <user>

ユーザーの認証情報(名前または ID)を表示します。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

表30.15 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表30.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表30.17 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表30.18 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第31章 endpoint

本章では、endpoint コマンドに含まれるコマンドについて説明します。

31.1. endpoint add project

プロジェクトをエンドポイントに関連付けます。

使用方法

openstack endpoint add project [-h] [--project-domain <project-domain>]
                                      <endpoint> <project>

表31.1 位置引数

概要

<endpoint>

指定したプロジェクト(名前または ID)に関連付けるエンドポイント

<project>

指定のエンドポイント名または ID に関連付けるプロジェクト

表31.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

31.2. endpoint create

新規エンドポイントを作成します。

使用方法

openstack endpoint create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--region <region-id>]
                                 [--enable | --disable]
                                 <service> <interface> <url>

表31.3 位置引数

概要

<service>

新しいエンドポイント(名前または ID)に関連付けるサービス

<interface>

新規エンドポイントインターフェースタイプ(admin、public または internal)

<url>

新規エンドポイント URL

表31.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--region <region-id>

新規エンドポイントのリージョン ID

--enable

エンドポイントを有効化します(デフォルト)

--disable

エンドポイントを無効化します

表31.5 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表31.6 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表31.7 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表31.8 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

31.3. endpoint delete

エンドポイントを削除します。

使用方法

openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]

表31.9 位置引数

概要

<endpoint-id>

削除するエンドポイント(id のみ)

表31.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

31.4. endpoint group add project

プロジェクトをエンドポイントグループに追加します。

使用方法

openstack endpoint group add project [-h]
                                            [--project-domain <project-domain>]
                                            <endpoint-group> <project>

表31.11 位置引数

概要

<endpoint-group>

エンドポイントグループ(名前または ID)

<project>

関連付けるプロジェクト(名前または ID)

表31.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

31.5. endpoint group create

新規エンドポイントグループを作成します。

使用方法

openstack endpoint group create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--description DESCRIPTION]
                                       <name> <filename>

表31.13 位置引数

概要

<name>

エンドポイントグループの名前

<filename>

新しいフィルターセットを含むファイル名

表31.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description DESCRIPTION

エンドポイントグループの説明

表31.15 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表31.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表31.17 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表31.18 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

31.6. endpoint group delete

エンドポイントグループを削除します。

使用方法

openstack endpoint group delete [-h]
                                       <endpoint-group> [<endpoint-group> ...]

表31.19 位置引数

概要

<endpoint-group>

削除するエンドポイントグループ(名前または ID)

表31.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

31.7. endpoint group list

エンドポイントグループを一覧表示します。

使用方法

openstack endpoint group list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--endpointgroup <endpoint-group> | --project <project>]
                                     [--domain <domain>]

表31.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--endpointgroup <endpoint-group>

エンドポイントグループ(名前または ID)

--project <project>

プロジェクト(名前または ID)

--domain <domain>

<project> を所有するドメイン(名前または ID)

表31.22 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表31.23 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表31.24 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表31.25 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

31.8. endpoint group remove project

エンドポイントグループからプロジェクトを削除します。

使用方法

openstack endpoint group remove project [-h]
                                               [--project-domain <project-domain>]
                                               <endpoint-group> <project>

表31.26 位置引数

概要

<endpoint-group>

エンドポイントグループ(名前または ID)

<project>

削除するプロジェクト(名前または ID)

表31.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

31.9. endpoint group set

エンドポイントグループプロパティーを設定します。

使用方法

openstack endpoint group set [-h] [--name <name>]
                                    [--filters <filename>]
                                    [--description <description>]
                                    <endpoint-group>

表31.28 位置引数

概要

<endpoint-group>

変更するエンドポイントグループ(名前または ID)

表31.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

アタrシイエンドポイントグループ名

--filters <filename>

新しいフィルターセットを含むファイル名

--description <description>

新規エンドポイントグループの説明

31.10. endpoint group show

エンドポイントグループの詳細を表示します。

使用方法

openstack endpoint group show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <endpointgroup>

表31.30 位置引数

概要

<endpointgroup>

エンドポイントグループ(名前または ID)

表31.31 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表31.32 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表31.33 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表31.34 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表31.35 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

31.11. endpoint list

エンドポイントを一覧表示します。

使用方法

openstack endpoint list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN]
                               [--service <service>] [--interface <interface>]
                               [--region <region-id>]
                               [--endpoint <endpoint-group> | --project <project>]
                               [--project-domain <project-domain>]

表31.36 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--service <service>

サービス(タイプ、名前または ID)別に絞り込みます。

--interface <interface>

インターフェースタイプ別に絞り込みます(管理者、パブリック、または内部)

--region <region-id>

リージョン ID 別に絞り込みます。

--endpoint <endpoint-group>

フィルターを一覧表示するエンドポイント

--project <project>

フィルターを一覧表示するプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表31.37 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表31.38 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表31.39 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表31.40 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

31.12. endpoint remove project

エンドポイントからプロジェクトを分散します。

使用方法

openstack endpoint remove project [-h]
                                         [--project-domain <project-domain>]
                                         <endpoint> <project>

表31.41 位置引数

概要

<endpoint>

指定したプロジェクト(名前または ID)から関連付けを解除するエンドポイント

<project>

指定されたエンドポイント名または ID から関連付けを解除するプロジェクト

表31.42 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

31.13. endpoint set

エンドポイントプロパティーを設定します。

使用方法

openstack endpoint set [-h] [--region <region-id>]
                              [--interface <interface>] [--url <url>]
                              [--service <service>] [--enable | --disable]
                              <endpoint-id>

表31.43 位置引数

概要

<endpoint-id>

変更するエンドポイント(ID のみ)

表31.44 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--region <region-id>

新規エンドポイントのリージョン ID

--interface <interface>

新規エンドポイントインターフェースタイプ(admin、public または internal)

--url <url>

新規エンドポイント URL

--service <service>

新しいエンドポイントサービス(名前または ID)

--enable

エンドポイントを有効化します。

--disable

エンドポイントを無効化します

31.14. endpoint show

エンドポイントの詳細を表示します。

使用方法

openstack endpoint show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               <endpoint>

表31.45 位置引数

概要

<endpoint>

表示するエンドポイント(エンドポイント id、サービス ID、サービス名、サービスタイプ)

表31.46 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表31.47 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表31.48 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表31.49 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表31.50 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第32章 event

本章では、event コマンドに含まれるコマンドについて説明します。

32.1. event trigger create

新規トリガーを作成します。

使用方法

openstack event trigger create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--params PARAMS]
                                      name workflow_id exchange topic event
                                      [workflow_input]

表32.1 位置引数

概要

name

イベントトリガー名

workflow_id

ワークフロー id

exchange

イベントトリガーの交換

topic

イベントトリガートピック

event

イベントトリガーイベント名

workflow_input

ワークフロー入力

表32.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--params PARAMS

ワークフローパラメーター

表32.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表32.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表32.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表32.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

32.2. event trigger delete

トリガーを削除します。

使用方法

openstack event trigger delete [-h]
                                      event_trigger_id [event_trigger_id ...]

表32.7 位置引数

概要

event_trigger_id

イベントトリガーの ID。

表32.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

32.3. event trigger list

すべてのイベントトリガーを一覧表示します。

使用方法

openstack event trigger list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--marker [MARKER]] [--limit [LIMIT]]
                                    [--sort_keys [SORT_KEYS]]
                                    [--sort_dirs [SORT_DIRS]]
                                    [--filter FILTERS]

表32.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

表32.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表32.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表32.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表32.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

32.4. event trigger show

特定のイベントトリガーを表示します。

使用方法

openstack event trigger show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    event_trigger

表32.14 位置引数

概要

event_trigger

イベントトリガー ID

表32.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表32.16 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表32.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表32.18 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表32.19 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第33章 extension

本章では、extension コマンドに含まれるコマンドについて説明します。

33.1. extension list

API 拡張を一覧表示します。

使用方法

openstack extension list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--noindent] [--max-width <integer>]
                                [--fit-width] [--print-empty]
                                [--sort-column SORT_COLUMN] [--compute]
                                [--identity] [--network] [--volume] [--long]

表33.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--compute

コンピュート api の拡張機能を一覧表示します。

--identity

アイデンティティー api の拡張機能を一覧表示します。

--network

ネットワーク api の拡張機能を一覧表示します。

--volume

ブロックストレージ api の拡張機能を一覧表示します。

--long

出力の追加フィールドを一覧表示します。

表33.2 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表33.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表33.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表33.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

33.2. extension show

API 拡張機能を表示します。

使用方法

openstack extension show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                <extension>

表33.6 位置引数

概要

<bx id="1" />

表示する拡張機能。現在、ネットワーク拡張機能のみがサポートされます。(名前またはエイリアス)

表33.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表33.8 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表33.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表33.10 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表33.11 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第34章 federation

本章では、federation コマンドに含まれるコマンドについて説明します。

34.1. federation domain list

アクセス可能なドメインを一覧表示します。

使用方法

openstack federation domain list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]

表34.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表34.2 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表34.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表34.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表34.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

34.2. federation project list

アクセス可能なプロジェクトを一覧表示します。

使用方法

openstack federation project list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]

表34.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表34.7 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表34.8 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表34.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表34.10 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

34.3. federation protocol create

新規フェデレーションプロトコルを作成します。

使用方法

openstack federation protocol create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            --identity-provider
                                            <identity-provider> --mapping
                                            <mapping>
                                            <name>

表34.11 位置引数

概要

<name>

新しいフェデレーションプロトコル名(認証プロバイダーごとに一意である必要があります)

表34.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--identity-provider <identity-provider>

新しいフェデレーションプロトコル(名前または ID)をサポートする認証プロバイダー(必須)

--mapping <mapping>

使用されるマッピング(名前または ID)(必須)

表34.13 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表34.14 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表34.15 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表34.16 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

34.4. federation protocol delete

フェデレーションプロトコルを削除します。

使用方法

openstack federation protocol delete [-h] --identity-provider
                                            <identity-provider>
                                            <federation-protocol>
                                            [<federation-protocol> ...]

表34.17 位置引数

概要

<federation-protocol>

削除するフェデレーションプロトコル(名前または ID)

表34.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--identity-provider <identity-provider>

<federation-protocol>(名前または ID)をサポートする認証プロバイダー(必須)

34.5. federation protocol list

フェデレーションプロトコルを一覧表示します。

使用方法

openstack federation protocol list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          --identity-provider
                                          <identity-provider>

表34.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--identity-provider <identity-provider>

一覧表示する認証プロバイダー(名前または ID)(必須)

表34.20 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表34.21 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表34.22 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表34.23 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

34.6. federation protocol set

フェデレーションプロトコルプロパティーを設定します。

使用方法

openstack federation protocol set [-h] --identity-provider
                                         <identity-provider>
                                         [--mapping <mapping>]
                                         <name>

表34.24 位置引数

概要

<name>

変更するフェデレーションプロトコル(名前または ID)

表34.25 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--identity-provider <identity-provider>

<federation-protocol>(名前または ID)をサポートする認証プロバイダー(必須)

--mapping <mapping>

使用されるマッピング(名前または ID)

34.7. federation protocol show

フェデレーションプロトコルの詳細を表示します。

使用方法

openstack federation protocol show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          --identity-provider
                                          <identity-provider>
                                          <federation-protocol>

表34.26 位置引数

概要

<federation-protocol>

表示するフェデレーションプロトコル(名前または ID)

表34.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--identity-provider <identity-provider>

<federation-protocol>(名前または ID)をサポートする認証プロバイダー(必須)

表34.28 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表34.29 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表34.30 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表34.31 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第35章 flavor

本章では、flavor コマンドに含まれるコマンドについて説明します。

35.1. flavor create

新規フレーバーを作成します。

使用方法

openstack flavor create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--id <id>] [--ram <size-mb>]
                               [--disk <size-gb>] [--ephemeral <size-gb>]
                               [--swap <size-mb>] [--vcpus <vcpus>]
                               [--rxtx-factor <factor>] [--public | --private]
                               [--property <key=value>] [--project <project>]
                               [--description <description>]
                               [--project-domain <project-domain>]
                               <flavor-name>

表35.1 位置引数

概要

<flavor-name>

新規フレーバー名

表35.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--id <id>

一意のフレーバー ID。uuid を自動生成します(デフォルト:auto)

--ram <size-mb>

MB単位のメモリーサイズ(デフォルトは 256m)

--disk <size-gb>

GB 単位のディスクサイズ(デフォルトは 0g)

--ephemeral <size-gb>

GB 単位の一時ディスクサイズ(デフォルトは 0g)

--swap <size-mb>

MB 単位の追加のスワップ領域サイズ(デフォルト: 0m)

--vcpus <vcpus>

仮想 CPU の数(デフォルトは 1)

--rxtx-factor <factor>

Rx/tx ファクター(デフォルトは 1.0)

--public

他のプロジェクトでフレーバーが利用できます(デフォルト)

--private

他のプロジェクトでフレーバーは利用できません。

--property <key=value>

このフレーバーに追加する属性(複数の属性を設定する場合はオプションを繰り返し使用します)

--project <project>

<project> がプライベートフレーバー(名前または ID)にアクセスできるようにします(--private オプションと併せて使用する必要があります)。

--description <description>

フレーバーの説明(api バージョン 2.55 - 2.latest でサポート)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表35.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表35.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表35.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表35.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

35.2. flavor delete

フレーバーを削除します。

使用方法

openstack flavor delete [-h] <flavor> [<flavor> ...]

表35.7 位置引数

概要

<flavor>

削除するフレーバー(名前または ID)

表35.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

35.3. flavor list

フレーバーを一覧表示します。

使用方法

openstack flavor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN]
                             [--public | --private | --all] [--long]
                             [--marker <flavor-id>] [--limit <num-flavors>]

表35.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--public

パブリックフレーバーのみを一覧表示します(デフォルト)

--private

プライベートフレーバーのみを一覧表示します。

--all

パブリックまたはプライベートのすべてのフレーバーを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--marker <flavor-id>

前のページにある最後のフレーバー ID

--limit <num-flavors>

表示するフレーバーの最大数

表35.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表35.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表35.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表35.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

35.4. flavor set

フレーバーのプロパティを設定します。

使用方法

openstack flavor set [-h] [--no-property] [--property <key=value>]
                            [--project <project>]
                            [--description <description>]
                            [--project-domain <project-domain>]
                            <flavor>

表35.14 位置引数

概要

<flavor>

変更するフレーバー(名前または ID)

表35.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--no-property

このフレーバーからすべてのプロパティーを削除します(新しいプロパティを設定する前に現在のプロパティを削除するには --no-property と --property の両方を指定)。

--property <key=value>

このフレーバーに追加または変更する属性(複数の属性を設定する場合はオプションを繰り返し使用します)

--project <project>

プロジェクト(名前または ID)へのフレーバーアクセスを設定します(管理者のみ)。

--description <description>

フレーバーの説明を設定します(api バージョン 2.55 - 2.latest でサポート)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

35.5. flavor show

フレーバーの詳細を表示します。

使用方法

openstack flavor show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <flavor>

表35.16 位置引数

概要

<flavor>

表示するフレーバー(名前または ID)

表35.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表35.18 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表35.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表35.20 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表35.21 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

35.6. flavor unset

フレーバーのプロパティを設定します。

使用方法

openstack flavor unset [-h] [--property <key>] [--project <project>]
                              [--project-domain <project-domain>]
                              <flavor>

表35.22 位置引数

概要

<flavor>

変更するフレーバー(名前または ID)

表35.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key>

フレーバーから削除するプロパティー(複数プロパティーの設定を解除する場合はオプションを繰り返し使用します)

--project <project>

プロジェクト(名前または ID)からフレーバーアクセスを削除します(管理者のみ)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

第36章 floating

本章では、floating コマンドに含まれるコマンドについて説明します。

36.1. floating ip create

Floating IP を作成します。

使用方法

openstack floating ip create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--subnet <subnet>]
                                    [--port <port>]
                                    [--floating-ip-address <ip-address>]
                                    [--fixed-ip-address <ip-address>]
                                    [--qos-policy <qos-policy>]
                                    [--description <description>]
                                    [--project <project>]
                                    [--dns-domain <dns-domain>]
                                    [--dns-name <dns-name>]
                                    [--project-domain <project-domain>]
                                    [--tag <tag> | --no-tag]
                                    <network>

表36.1 位置引数

概要

<network>

Floating IP の割り当て元のネットワーク(名前または ID)

表36.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--subnet <subnet>

Floating IP(名前または ID)を作成するサブネット

--port <port>

Floating IP(名前または ID)に関連付けるポート

--floating-ip-address <ip-address>

Floating IP アドレス

--fixed-ip-address <ip-address>

Floating IP にマッピングされた Fixed IP アドレス

--qos-policy <qos-policy>

Floating IP(名前または ID)に qos ポリシーを割り当てます。

--description <description>

Floating IP の説明を設定します。

--project <project>

所有者のプロジェクト(名前または ID)

--dns-domain <dns-domain>

この Floating IP に DNS ドメインを設定します。

--dns-name <dns-name>

この Floating IP に DNS 名を設定します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--tag <tag>

Floating IP に追加するタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

Floating IP にタグを関連付けない

表36.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表36.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表36.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表36.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

36.2. floating ip delete

Floating IP を削除します。

使用方法

openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]

表36.7 位置引数

概要

<floating-ip>

削除する Floating IP(IP アドレスまたは ID)

表36.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

36.3. floating ip list

Floating IP を一覧表示します。

使用方法

openstack floating ip list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  [--network <network>] [--port <port>]
                                  [--fixed-ip-address <ip-address>]
                                  [--floating-ip-address <ip-address>]
                                  [--long] [--status <status>]
                                  [--project <project>]
                                  [--project-domain <project-domain>]
                                  [--router <router>]
                                  [--tags <tag>[,<tag>,...]]
                                  [--any-tags <tag>[,<tag>,...]]
                                  [--not-tags <tag>[,<tag>,...]]
                                  [--not-any-tags <tag>[,<tag>,...]]

表36.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--network <network>

指定されたネットワーク(名前または ID)に従って Floating IP を一覧表示します。

--port <port>

指定ポート(名前または ID)に従って Floating IP を一覧表示します。

--fixed-ip-address <ip-address>

指定の Fixed IP アドレスに従って、Floating IP を一覧表示します。

--floating-ip-address <ip-address>

指定の Floating IP アドレスに従って Floating IP を一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--status <status>

指定されたステータス(ACTIVE, DOWN) に従って Floating IP を一覧表示します。

--project <project>

指定のプロジェクト(名前または ID)に従って Floating IP を一覧表示します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--router <router>

指定のルーター(名前または ID)に従って Floating IP を一覧表示します。

--tags <tag>[,<tag>,…​]

指定されたタグ(タグのコンマ区切りリスト)がすべて割り当てられた Floating IP を一覧表示します。

--any-tags <tag>[,<tag>,…​]

指定されたタグ(タグのコンマ区切りリスト)のいずれかが割り当てられた Floating IP を一覧表示します。

--not-tags <tag>[,<tag>,…​]

指定されたタグ(タグのコンマ区切りリスト)がすべて割り当てられた Floating IP を除外します。

--not-any-tags <tag>[,<tag>,…​]

指定されたタグ(タグのコンマ区切りリスト)のいずれかが割り当てられた Floating IP を除外します。

表36.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表36.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表36.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表36.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

36.4. floating ip pool list

Floating IP アドレスのプールを一覧表示します。

使用方法

openstack floating ip pool list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]

表36.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表36.15 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表36.16 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表36.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表36.18 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

36.5. floating ip port forwarding create

Floating IP ポート転送を作成します。

使用方法

openstack floating ip port forwarding create [-h]
                                                    [-f {json,shell,table,value,yaml}]
                                                    [-c COLUMN] [--noindent]
                                                    [--prefix PREFIX]
                                                    [--max-width <integer>]
                                                    [--fit-width]
                                                    [--print-empty]
                                                    --internal-ip-address
                                                    <internal-ip-address>
                                                    --port <port>
                                                    --internal-protocol-port
                                                    <port-number>
                                                    --external-protocol-port
                                                    <port-number> --protocol
                                                    <protocol>
                                                    <floating-ip>

表36.19 位置引数

概要

<floating-ip>

ポート転送が属する Floating IP(IP アドレスまたは ID)

表36.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--internal-ip-address <internal-ip-address>

Floating IP ポート転送に関連付けられたネットワークポートの Fixed ipv4 アドレス

--port <port>

Floating IP ポート転送に関連付けられたネットワークポートの名前または ID

--internal-protocol-port <port-number>

Floating IP ポート転送に関連付けられたネットワークポートの Fixed IPv4 アドレスのプロトコルポート番号

--external-protocol-port <port-number>

ポート転送の Floating IP アドレスのプロトコルポート番号

--protocol <protocol>

Floating IP ポート転送で使用されるプロトコル:TCP、UDP

表36.21 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表36.22 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表36.23 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表36.24 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

36.6. Floating ip port forwarding delete

Floating IP ポート転送を削除します。

使用方法

openstack floating ip port forwarding delete [-h]
                                                    <floating-ip>
                                                    <port-forwarding-id>
                                                    [<port-forwarding-id> ...]

表36.25 位置引数

概要

<floating-ip>

ポート転送が属する Floating IP(IP アドレスまたは ID)

<port-forwarding-id>

削除する Floating IP ポート転送の ID

表36.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

36.7. floating ip port forwarding list

Floating IP ポート転送を一覧表示します。

使用方法

openstack floating ip port forwarding list [-h]
                                                  [-f {csv,json,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--quote {all,minimal,none,nonnumeric}]
                                                  [--noindent]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--sort-column SORT_COLUMN]
                                                  [--port <port>]
                                                  [--external-protocol-port <port-number>]
                                                  [--protocol protocol]
                                                  <floating-ip>

表36.27 位置引数

概要

<floating-ip>

ポート転送が属する Floating IP(IP アドレスまたは ID)

表36.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--port <port>

内部ネットワークポートの ID または名前でリストの結果をフィルターします。

--external-protocol-port <port-number>

Floating IP のプロトコルポート番号で結果を絞り込みます。

--protocol protocol

ポートプロトコルでリストの結果をフィルターします。

表36.29 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表36.30 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表36.31 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表36.32 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

36.8. floating ip port forwarding set

Floating IP ポート転送プロパティを設定します。

使用方法

openstack floating ip port forwarding set [-h] [--port <port>]
                                                 [--internal-ip-address <internal-ip-address>]
                                                 [--internal-protocol-port <port-number>]
                                                 [--external-protocol-port <port-number>]
                                                 [--protocol <protocol>]
                                                 <floating-ip>
                                                 <port-forwarding-id>

表36.33 位置引数

概要

<floating-ip>

ポート転送が属する Floating IP(IP アドレスまたは ID)

<port-forwarding-id>

Floating IP ポート転送の ID

表36.34 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--port <port>

Floating IP ポート転送に関連付けられたネットワークポートの ID

--internal-ip-address <internal-ip-address>

Floating IP ポート転送に関連付けられたネットワークポートの Fixed ipv4 アドレス

--internal-protocol-port <port-number>

Floating IP ポート転送に関連付けられたネットワークポートの Fixed IPv4 アドレスのtcp/udp/otherプロトコルポート番号

--external-protocol-port <port-number>

ポート転送の Floating IP アドレスのtcp/udp/otherプロトコルポート番号

--protocol <protocol>

Floating IP ポート転送で使用されるプロトコル

36.9. floating ip port forwarding show

Floating IP ポート転送の詳細を表示します。

使用方法

openstack floating ip port forwarding show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  <floating-ip>
                                                  <port-forwarding-id>

表36.35 位置引数

概要

<floating-ip>

ポート転送が属する Floating IP(IP アドレスまたは ID)

<port-forwarding-id>

Floating IP ポート転送の ID

表36.36 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表36.37 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表36.38 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表36.39 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表36.40 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

36.10. floating ip set

Floating IP 属性を設定します。

使用方法

openstack floating ip set [-h] [--port <port>]
                                 [--fixed-ip-address <ip-address>]
                                 [--qos-policy <qos-policy> | --no-qos-policy]
                                 [--tag <tag>] [--no-tag]
                                 <floating-ip>

表36.41 位置引数

概要

<floating-ip>

変更する Floating IP(IP アドレスまたは ID)

表36.42 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--port <port>

Floating IP をポートに関連付けます(名前または ID)。

--fixed-ip-address <ip-address>

ポートの Fixed IP(ポートに複数の IP がある場合のみ必要)

--qos-policy <qos-policy>

Floating IP(名前または ID)に qos ポリシーを割り当てます。

--no-qos-policy

Floating IP に割り当てられた qos ポリシーを削除します。

--tag <tag>

Floating IP に追加するタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

Floating IPに関連付けられたタグを消去します。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。

36.11. floating ip show

Floating IP の詳細を表示します。

使用方法

openstack floating ip show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <floating-ip>

表36.43 位置引数

概要

<floating-ip>

表示する Floating IP(IP アドレスまたは ID)

表36.44 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表36.45 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表36.46 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表36.47 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表36.48 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

36.12. floating ip unset

Floating IP 属性の設定を解除します。

使用方法

openstack floating ip unset [-h] [--port] [--qos-policy]
                                   [--tag <tag> | --all-tag]
                                   <floating-ip>

表36.49 位置引数

概要

<floating-ip>

関連付けを解除する Floating IP(IP アドレスまたは ID)

表36.50 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--port

Floating IP に関連付けられたポートの関連付けを解除します。

--qos-policy

Floating IP に割り当てられた qos ポリシーを削除します。

--tag <tag>

Floating IP から削除するタグ(複数のタグを削除する場合はオプションを繰り返し使用します)

--all-tag

Floating IP に関連付けられたすべてのタグを消去します。

第37章 group

本章では、group コマンドに含まれるコマンドについて説明します。

37.1. group add user

ユーザーをグループに追加します。

使用方法

openstack group add user [-h] [--group-domain <group-domain>]
                                [--user-domain <user-domain>]
                                <group> <user> [<user> ...]

表37.1 位置引数

概要

<group>

<user>が含まれるグループ(名前または ID)

<user>

<group>(名前または ID)に追加するユーザー(複数のユーザーを追加する場合はオプションを繰り返し使用します)

表37.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--group-domain <group-domain>

グループが所属するドメイン(名前または ID)。グループ名の競合が発生した場合に、使用できます。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

37.2. group contains user

グループ内のユーザーメンバーシップを確認します。

使用方法

openstack group contains user [-h] [--group-domain <group-domain>]
                                     [--user-domain <user-domain>]
                                     <group> <user>

表37.3 位置引数

概要

<group>

チェックするグループ(名前または ID)

<user>

確認するユーザー(名前または ID)

表37.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--group-domain <group-domain>

グループが所属するドメイン(名前または ID)。グループ名の競合が発生した場合に、使用できます。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

37.3. group create

新規グループを作成します。

使用方法

openstack group create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--domain <domain>]
                              [--description <description>] [--or-show]
                              <group-name>

表37.5 位置引数

概要

<group-name>

新しいグループ名

表37.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

新しいグループが含まれるドメイン(名前または ID)

--description <description>

新しいグループの説明

--or-show

既存グループを返します。

表37.7 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表37.8 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表37.9 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表37.10 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

37.4. group delete

グループを削除します。

使用方法

openstack group delete [-h] [--domain <domain>] <group> [<group> ...]

表37.11 位置引数

概要

<group>

削除するグループ(名前または ID)

表37.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

グループが含まれるドメイン(名前または ID)

37.5. group list

グループの一覧表示

使用方法

openstack group list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--domain <domain>] [--user <user>]
                            [--user-domain <user-domain>] [--long]

表37.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

<domain>でグループリストをフィルターします(名前または ID)。

--user <user>

<user>でグループリストをフィルターします(名前または ID)。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

--long

出力の追加フィールドを一覧表示します。

表37.14 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表37.15 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表37.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表37.17 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

37.6. group remove user

グループからユーザーを削除します。

使用方法

openstack group remove user [-h] [--group-domain <group-domain>]
                                   [--user-domain <user-domain>]
                                   <group> <user> [<user> ...]

表37.18 位置引数

概要

<group>

<user>が含まれるグループ(名前または ID)

<user>

<group> (名前または id) から削除するユーザー (複数のボリュームを削除する場合はオプションを繰り返し使用します)

表37.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--group-domain <group-domain>

グループが所属するドメイン(名前または ID)。グループ名の競合が発生した場合に、使用できます。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

37.7. group set

グループ属性を設定します。

使用方法

openstack group set [-h] [--domain <domain>] [--name <name>]
                           [--description <description>]
                           <group>

表37.20 位置引数

概要

<group>

変更するグループ(名前または ID)

表37.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

<group>が含まれるドメイン(名前または ID)

--name <name>

新しいグループ名

--description <description>

新しいグループの説明

37.8. group show

グループの詳細を表示します。

使用方法

openstack group show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--domain <domain>]
                            <group>

表37.22 位置引数

概要

<group>

表示するグループ(名前または ID)

表37.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

<group>が含まれるドメイン(名前または ID)

表37.24 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表37.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表37.26 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表37.27 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第38章 help.adoc

本章では、help.adoc コマンドに含まれるコマンドについて説明します。

38.1. help

別のコマンドの詳細なヘルプを出力します。

使用方法

openstack help [-h] [cmd [cmd ...]]

表38.1 位置引数

概要

cmd

コマンドの名前

表38.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

第39章 host

本章では、host コマンドに含まれるコマンドについて説明します。

39.1. host list

ホストを一覧表示します。

使用方法

openstack host list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           [--zone <zone>]

表39.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--zone <zone>

アベイラビリティーゾーン内のホストのみを返します。

表39.2 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表39.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表39.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

39.2. host set

ホスト属性を設定します。

使用方法

openstack host set [-h] [--enable | --disable]
                          [--enable-maintenance | --disable-maintenance]
                          <host>

表39.6 位置引数

概要

<host>

変更するホスト(名前のみ)

表39.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--enable

ホストを有効にします。

--disable

ホストを無効にします。

--enable-maintenance

ホストのメンテナンスモードを有効にします。

--disable-maintenance

ホストのメンテナンスモードを無効にします。

39.3. host show

ホストの詳細を表示します。

使用方法

openstack host show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           <host>

表39.8 位置引数

概要

<host>

ホスト名

表39.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表39.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表39.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表39.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表39.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第40章 hypervisor

本章では、hypervisor コマンドに含まれるコマンドについて説明します。

40.1. hypervisor list

ハイパーバイザーを一覧表示します。

使用方法

openstack hypervisor list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN]
                                 [--matching <hostname>] [--long]

表40.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--matching <hostname>

<hostname> 部分文字列を使用してハイパーバイザーをフィルターします。

--long

出力の追加フィールドを一覧表示します。

表40.2 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表40.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表40.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

40.2. hypervisor show

ハイパーバイザーの詳細を表示します。

使用方法

openstack hypervisor show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <hypervisor>

表40.6 位置引数

概要

<hypervisor>

表示するハイパーバイザー(名前または ID)

表40.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表40.8 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.10 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表40.11 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

40.3. hypervisor stats show

ハイパーバイザーの統計情報を表示します。

使用方法

openstack hypervisor stats show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]

表40.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表40.13 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表40.14 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表40.15 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表40.16 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第41章 identity

本章では、identity コマンドに含まれるコマンドについて説明します。

41.1. identity provider create

新規認証プロバイダーを作成します。

使用方法

openstack identity provider create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--remote-id <remote-id> | --remote-id-file <file-name>]
                                          [--description <description>]
                                          [--domain <domain>]
                                          [--enable | --disable]
                                          <name>

表41.1 位置引数

概要

<name>

新しい認証プロバイダー名(一意である必要があります)

表41.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--remote-id <remote-id>

認証プロバイダーに関連付けるリモート ID(複数の値を指定する場合はオプションを繰り返し使用します)

--remote-id-file <file-name>

認証プロバイダーに関連付ける多数のリモート ID が含まれるファイルの名前(行ごとに 1 つ)

--description <description>

新規の認証プロバイダーの説明

--domain <domain>

認証プロバイダーに関連付けるドメイン。指定されていない場合、ドメインが自動的に作成されます。(名前または ID)

--enable

認証プロバイダーを有効にします(デフォルト)。

--disable

認証プロバイダーを無効にします。

表41.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表41.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

41.2. identity provider delete

認証プロバイダーを削除します。

使用方法

openstack identity provider delete [-h]
                                          <identity-provider>
                                          [<identity-provider> ...]

表41.7 位置引数

概要

<identity-provider>

削除する認証プロバイダー

表41.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

41.3. identity provider list

認証プロバイダーを一覧表示します。

使用方法

openstack identity provider list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]

表41.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表41.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表41.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表41.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

41.4. identity provider set

認証プロバイダー属性を設定します。

使用方法

openstack identity provider set [-h] [--description <description>]
                                       [--remote-id <remote-id> | --remote-id-file <file-name>]
                                       [--enable | --disable]
                                       <identity-provider>

表41.14 位置引数

概要

<identity-provider>

変更する認証プロバイダー

表41.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

認証プロバイダーの説明を設定します。

--remote-id <remote-id>

認証プロバイダーに関連付けるリモート ID(複数の値を指定する場合はオプションを繰り返し使用します)

--remote-id-file <file-name>

認証プロバイダーに関連付ける多数のリモート ID が含まれるファイルの名前(行ごとに 1 つ)

--enable

認証プロバイダーを有効にします。

--disable

認証プロバイダーを無効にします。

41.5. identity provider show

認証プロバイダーの詳細を表示します。

使用方法

openstack identity provider show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <identity-provider>

表41.16 位置引数

概要

<identity-provider>

表示する認証プロバイダー

表41.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表41.18 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表41.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表41.20 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表41.21 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第42章 image

本章では、image コマンドに含まれるコマンドについて説明します。

42.1. image add project

プロジェクトをイメージに関連付けます。

使用方法

openstack image add project [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   [--project-domain <project-domain>]
                                   <image> <project>

表42.1 位置引数

概要

<image>

共有するイメージ(名前または ID)

<project>

イメージに関連付けるプロジェクト(id)

表42.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表42.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表42.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表42.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表42.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

42.2. image create

イメージを作成/アップロードします。

使用方法

openstack image create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--id <id>]
                              [--container-format <container-format>]
                              [--disk-format <disk-format>]
                              [--min-disk <disk-gb>] [--min-ram <ram-mb>]
                              [--file <file> | --volume <volume>] [--force]
                              [--sign-key-path <sign-key-path>]
                              [--sign-cert-id <sign-cert-id>]
                              [--protected | --unprotected]
                              [--public | --private | --community | --shared]
                              [--property <key=value>] [--tag <tag>]
                              [--project <project>]
                              [--project-domain <project-domain>]
                              <image-name>

表42.7 位置引数

概要

<image-name>

新しいイメージ名

表42.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--id <id>

予約するイメージ ID

--Container-format <container-format>

イメージコンテナーの形式。サポートされるオプションは ami、ari、aki、bare、docker、ova、ovf です。デフォルトの形式は bare です。

--disk-format <disk-format>

イメージディスクの形式。サポートされるオプションは ami、ari、aki、vhd、vmdk、raw、qcow2、vhdx、vdi、iso、ploop です。デフォルトの形式は raw です。

--min-disk <disk-gb>

イメージのブートに必要な最小ディスクサイズ(ギガバイト単位)

--min-ram <ram-mb>

イメージのブートに必要な最小RAMサイズ(メガバイト単位)

--file <file>

ローカルファイルからイメージをアップロードします。

--volume <volume>

ボリュームからイメージを作成します。

--force

ボリュームが使用中の場合にイメージ作成を強制的に実行します(--volume と共に使用する場合にのみ意味があります)。

--sign-key-path <sign-key-path>

指定した秘密鍵を使用してイメージを署名します。--sign-cert-id と併用する場合にのみ使用します。

--Sign-cert-id <sign-cert-id>

指定された証明書の uuid は、公開鍵に対応し、署名の検証に使用されるキーマネージャーの証明書への参照です。--sign-key-path と併用する場合にのみ使用します。

--protected

イメージが削除されないようにします。

--unprotected

イメージの削除を許可します(デフォルト)

--public

イメージは一般に公開されます。

--private

イメージは一般に公開されません(デフォルト)。

--community

イメージはコミュニティーに公開されます。

--shared

イメージを共有可能です。

--property <key=value>

このイメージにプロパティーを設定します(複数のプロパティーを設定する場合はオプションを繰り返し使用します)。

--tag <tag>

このイメージにタグを設定します(複数のタグを設定する場合はオプションを繰り返し使用します)。

--project <project>

このイメージの代替プロジェクトを設定します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表42.9 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表42.10 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表42.11 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表42.12 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

42.3. image delete

イメージを削除します。

使用方法

openstack image delete [-h] <image> [<image> ...]

表42.13 位置引数

概要

<image>

削除するイメージ(名前または ID)

表42.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

42.4. image list

利用可能なイメージを一覧表示します。

使用方法

openstack image list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--public | --private | --community | --shared]
                            [--property <key=value>] [--name <name>]
                            [--status <status>]
                            [--member-status <member-status>] [--tag <tag>]
                            [--long] [--sort <key>[:<direction>]]
                            [--limit <num-images>] [--marker <image>]

表42.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--public

パブリックイメージのみを一覧表示します。

--private

プライベートイメージのみを一覧表示します。

--community

コミュニティーイメージのみを一覧表示します。

--shared

共有イメージのみを一覧表示します。

--property <key=value>

プロパティーに基づいて出力をフィルターします(複数のプロパティーでフィルタリングする場合はオプションを繰り返し使用します)

--name <name>

名前に基づいてイメージをフィルターします。

--status <status>

ステータスに基づいてイメージをフィルタリングします。

--member-status <member-status>

メンバーステータスをもとにイメージをフィルターします。サポートされるオプションは、accepted、pending、rejected、all です。

--tag <tag>

タグに基づいてイメージをフィルターします。

--long

出力の追加フィールドを一覧表示します。

--sort <key>[:<direction>]

選択した鍵と方向(asc または desc)で出力をソートします(デフォルト:name:asc)。複数のキーと方向をコンマで区切ることができます。

--limit <num-images>

表示するイメージの最大数。

--marker <image>

前のページにある最後のイメージ。マーカーの後にイメージの一覧を表示します。指定されていない場合には、すべてのイメージを表示します(名前または ID)。

表42.16 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表42.17 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表42.18 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表42.19 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

42.5. image member list

イメージに関連付けられたプロジェクトを一覧表示します。

使用方法

openstack image member list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--project-domain <project-domain>]
                                   <image>

表42.20 位置引数

概要

<image>

イメージ(名前または ID)

表42.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表42.22 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表42.23 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表42.24 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表42.25 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

42.6. image remove project

イメージとプロジェクトの関連付けを解除します。

使用方法

openstack image remove project [-h] [--project-domain <project-domain>]
                                      <image> <project>

表42.26 位置引数

概要

<image>

共有を解除するイメージ(名前または ID)

<project>

イメージとの関連付けを解除するプロジェクト(名前または ID)

表42.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

42.7. image save

イメージをローカルに保存します。

使用方法

openstack image save [-h] [--file <filename>] <image>

表42.28 位置引数

概要

<image>

保存するイメージ(名前または ID)

表42.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--file <filename>

ダウンロードしたイメージを保存するファイル名(デフォルト:stdout)

42.8. image set

イメージ属性を設定します。

使用方法

openstack image set [-h] [--name <name>] [--min-disk <disk-gb>]
                           [--min-ram <ram-mb>]
                           [--container-format <container-format>]
                           [--disk-format <disk-format>]
                           [--protected | --unprotected]
                           [--public | --private | --community | --shared]
                           [--property <key=value>] [--tag <tag>]
                           [--architecture <architecture>]
                           [--instance-id <instance-id>]
                           [--kernel-id <kernel-id>] [--os-distro <os-distro>]
                           [--os-version <os-version>]
                           [--ramdisk-id <ramdisk-id>]
                           [--deactivate | --activate] [--project <project>]
                           [--project-domain <project-domain>]
                           [--accept | --reject | --pending]
                           <image>

表42.30 位置引数

概要

<image>

変更するイメージ(名前または ID)

表42.31 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新しいイメージ名

--min-disk <disk-gb>

イメージのブートに必要な最小ディスクサイズ(ギガバイト単位)

--min-ram <ram-mb>

イメージのブートに必要な最小RAMサイズ(メガバイト単位)

--Container-format <container-format>

イメージコンテナーの形式。サポートされるオプションは ami、ari、aki、bare、docker、ova、ovf です。

--disk-format <disk-format>

イメージディスクの形式。サポートされるオプションは ami、ari、aki、vhd、vmdk、raw、qcow2、vhdx、vdi、iso、ploop です。

--protected

イメージが削除されないようにします。

--unprotected

イメージの削除を許可します(デフォルト)

--public

イメージは一般に公開されます。

--private

イメージは一般に公開されません(デフォルト)。

--community

イメージはコミュニティーに公開されます。

--shared

イメージを共有可能です。

--property <key=value>

このイメージにプロパティーを設定します(複数のプロパティーを設定する場合はオプションを繰り返し使用します)。

--tag <tag>

このイメージにタグを設定します(複数のタグを設定する場合はオプションを繰り返し使用します)。

--architecture <architecture>

オペレーティングシステムのアーキテクチャー

--instance-id <instance-id>

このイメージの作成に使用するサーバーインスタンスの ID

--kernel-id <kernel-id>

このディスクイメージのブートに使用するカーネルイメージの ID

--os-distro <os-distro>

オペレーティングシステムのディストリビューション名

--os-version <os-version>

オペレーティングシステムディストリビューションのバージョン

--ramdisk-id <ramdisk-id>

このディスクイメージのブートに使用するramdiskイメージの ID

--deactivate

イメージを非アクティブ化します。

--activate

イメージをアクティベートします。

--project <project>

このイメージの代替プロジェクトを設定します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--accept

イメージメンバーシップを許可します。

--reject

イメージメンバーシップを拒否します。

--pending

イメージのメンバーシップを 保留中にリセットします。

42.9. image show

イメージの詳細を表示します。

使用方法

openstack image show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--human-readable]
                            <image>

表42.32 位置引数

概要

<image>

表示するイメージ(名前または ID)

表42.33 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--human-readable

人間が解読しやすい形式でイメージサイズを出力します。

表42.34 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表42.35 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表42.36 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表42.37 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

42.10. image unset

イメージタグおよび属性の設定を解除します。

使用方法

openstack image unset [-h] [--tag <tag>] [--property <property-key>]
                             <image>

表42.38 位置引数

概要

<image>

変更するイメージ(名前または ID)

表42.39 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--tag <tag>

このイメージのタグ設定を解除します(複数のタグの設定を解除する場合はオプションを繰り返し使用します)。

--property <property-key>

このイメージのプロパティーの設定を解除します(複数のプロパティー設定を解除する場合はオプションを繰り返し使用します)。

第43章 implied

本章では、implied コマンドに含まれるコマンドについて説明します。

43.1. implied role create

以前のロールと暗黙的なロール間の関連付けを作成します。

使用方法

openstack implied role create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     --implied-role <role>
                                     <role>

表43.1 位置引数

概要

<role>

別のロールを暗示するロール(名前または ID)

表43.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--implied-role <role>

別のロールによって暗示される<role>(名前または id)

表43.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表43.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表43.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

43.2. implied role delete

以前のロールと暗黙的なロール間の関連付けを削除します。

使用方法

openstack implied role delete [-h] --implied-role <role> <role>

表43.7 位置引数

概要

<role>

別のロールを暗示するロール(名前または ID)

表43.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--implied-role <role>

別のロールによって暗示される<role>(名前または id)

43.3. implied role list

暗黙的なロールを一覧表示します。

使用方法

openstack implied role list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]

表43.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表43.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表43.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表43.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表43.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第44章 ip

本章では、ip コマンドに含まれるコマンドについて説明します。

44.1. ip availability list

ネットワークの IP の可用性を一覧表示します。

使用方法

openstack ip availability list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--ip-version <ip-version>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]

表44.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--ip-version <ip-version>

指定した ip バージョンのネットワーク(デフォルトは 4)の ip の可用性を一覧表示します。

--project <project>

指定されたプロジェクトの ip の可用性を一覧表示します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表44.2 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表44.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表44.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表44.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

44.2. ip availability show

ネットワーク IP の可用性の詳細を表示します。

使用方法

openstack ip availability show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <network>

表44.6 位置引数

概要

<network>

特定のネットワークの ip 可用性を表示します(名前または ID)。

表44.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表44.8 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表44.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表44.10 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表44.11 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第45章 keypair

本章では、keypair コマンドに含まれるコマンドについて説明します。

45.1. keypair create

サーバーの ssh アクセス用に新しい公開鍵または秘密鍵を作成します。

使用方法

openstack keypair create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                [--public-key <file> | --private-key <file>]
                                <name>

表45.1 位置引数

概要

<name>

新しい公開鍵または秘密鍵名

表45.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--public-key <file>

追加する公開鍵のファイル名。使用されていない場合は、秘密鍵を作成します。

--private-key <file>

保存する秘密鍵のファイル名。使用されていない場合は、秘密鍵をコンソールに出力します。

表45.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表45.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表45.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表45.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

45.2. keypair delete

公開鍵または秘密鍵を削除します。

使用方法

openstack keypair delete [-h] <key> [<key> ...]

表45.7 位置引数

概要

<key>

削除する鍵の名前(名前のみ)

表45.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

45.3. keypair list

鍵のフィンガープリントを一覧表示します。

使用方法

openstack keypair list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN]

表45.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表45.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表45.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表45.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表45.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

45.4. keypair show

鍵の詳細を表示します。

使用方法

openstack keypair show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--public-key]
                              <key>

表45.14 位置引数

概要

<key>

表示する公開鍵または秘密鍵(名前のみ)

表45.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--public-key

生成された鍵とペアになったベア公開鍵のみを表示します。

表45.16 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表45.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表45.18 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表45.19 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第46章 l2gw

本章では、l2gw コマンドに含まれるコマンドについて説明します。

46.1. l2gw connection create

l2gateway-connection を作成します。

使用方法

openstack l2gw connection create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--default-segmentation-id SEG_ID]
                                        <GATEWAY-NAME/UUID>
                                        <NETWORK-NAME/UUID>

表46.1 位置引数

概要

<GATEWAY-NAME/UUID>

論理ゲートウェイの説明的な名前。

<NETWORK-NAME/UUID>

ネットワーク名または uuid

表46.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--default-segmentation-id SEG_ID

l2-gateway-create コマンドでセグメンテーション ID が指定されていなかったインターフェースに適用されるデフォルトのセグメンテーション ID。

表46.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表46.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表46.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表46.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

46.2. l2gw connection delete

指定した l2gateway-connection を削除します。

使用方法

openstack l2gw connection delete [-h]
                                        <L2_GATEWAY_CONNECTIONS>
                                        [<L2_GATEWAY_CONNECTIONS> ...]

表46.7 位置引数

概要

<L2_GATEWAY_CONNECTIONS>

削除する l2_gateway_connections(s)の ID。

表46.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

46.3. l2gw connection list

l2gateway-connections を一覧表示します。

使用方法

openstack l2gw connection list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--project <project>]
                                      [--project-domain <project-domain>]

表46.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表46.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表46.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表46.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表46.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

46.4. l2gw connection show

指定した l2gateway-connection の情報を表示します。

使用方法

openstack l2gw connection show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <L2_GATEWAY_CONNECTION>

表46.14 位置引数

概要

<L2_GATEWAY_CONNECTION>

検索する l2_gateway_connection の ID。

表46.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表46.16 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表46.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表46.18 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表46.19 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

46.5. l2gw create

l2gateway リソースを作成します。

使用方法

openstack l2gw create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--project <project>]
                             [--project-domain <project-domain>]
                             [--device name=name,interface_names=INTERFACE-DETAILS]
                             <GATEWAY-NAME>

表46.20 位置引数

概要

<GATEWAY-NAME>

論理ゲートウェイの説明的な名前。

表46.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--device name=name,interface_names=INTERFACE-DETAILS

l2gateway のデバイス名およびインターフェース名。INTERFACE-DETAILS の形式は"<interface_name1>;[<inte rface_name2>][です。

表46.22 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表46.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表46.24 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表46.25 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

46.6. l2gw delete

指定の l2gateway を削除します。

使用方法

openstack l2gw delete [-h] <L2_GATEWAY> [<L2_GATEWAY> ...]

表46.26 位置引数

概要

<L2_GATEWAY>

削除する l2_gateway の IDまたは名前。

表46.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

46.7. l2gw list

特定のプロジェクトに属する l2gateway を一覧表示します。

使用方法

openstack l2gw list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           [--project <project>]
                           [--project-domain <project-domain>]

表46.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表46.29 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表46.30 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表46.31 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表46.32 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

46.8. l2gw show

指定の l2gateway の情報を表示します。

使用方法

openstack l2gw show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty]
                           <L2_GATEWAY>

表46.33 位置引数

概要

<L2_GATEWAY>

検索する l2_gateway の ID または名前。

表46.34 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表46.35 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表46.36 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表46.37 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表46.38 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

46.9. l2gw update

指定の l2gateway を更新します。

使用方法

openstack l2gw update [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--name name]
                             [--device name=name,interface_names=INTERFACE-DETAILS]
                             <L2_GATEWAY>

表46.39 位置引数

概要

<L2_GATEWAY>

更新する l2_gateway の ID または名前。

表46.40 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name name

論理ゲートウェイの説明的な名前。

--device name=name,interface_names=INTERFACE-DETAILS

l2gateway のデバイス名およびインターフェース名。INTERFACE-DETAILS の形式は"<interface_name1>;[<inte rface_name2>][です。

表46.41 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表46.42 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表46.43 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表46.44 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第47章 limit

本章では、limit コマンドに含まれるコマンドについて説明します。

47.1. limit create

制限を作成します。

使用方法

openstack limit create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--description <description>]
                              [--region <region>] --project <project>
                              --service <service> --resource-limit
                              <resource-limit>
                              <resource-name>

表47.1 位置引数

概要

<resource-name>

制限するリソースの名前

表47.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

制限の説明

--region <region>

影響する制限のリージョン。

--project <project>

リソース制限を関連付けるプロジェクト

--service <service>

制限するリソースに関するサービス

--resource-limit <resource-limit>

仮定するプロジェクトのリソース制限

表47.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表47.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表47.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表47.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

47.2. limit delete

制限を削除します。

使用方法

openstack limit delete [-h] <limit-id> [<limit-id> ...]

表47.7 位置引数

概要

<limit-id>

削除の制限(id)

表47.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

47.3. limit list

制限を一覧表示します。

使用方法

openstack limit list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--service <service>]
                            [--resource-name <resource-name>]
                            [--region <region>] [--project <project>]

表47.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--service <service>

制限するリソースに関するサービス

--resource-name <resource-name>

制限するリソースの名前

--region <region>

影響する登録された制限のリージョン。

--project <project>

プロジェクトに関連付けられたリソース制限を一覧表示します。

表47.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表47.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表47.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表47.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

47.4. limit set

制限に関する情報を更新します。

使用方法

openstack limit set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--description <description>]
                           [--resource-limit <resource-limit>]
                           <limit-id>

表47.14 位置引数

概要

<limit-id>

更新する制限(id)

表47.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

制限の説明

--resource-limit <resource-limit>

仮定するプロジェクトのリソース制限

表47.16 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表47.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表47.18 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表47.19 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

47.5. limit show

制限の詳細を表示します。

使用方法

openstack limit show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty]
                            <limit-id>

表47.20 位置引数

概要

<limit-id>

表示する制限(id)

表47.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表47.22 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表47.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表47.24 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表47.25 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第48章 limits

本章では、limits コマンドに含まれるコマンドについて説明します。

48.1. limits show

コンピュートおよびブロックストレージの制限を表示します。

使用方法

openstack limits show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] (--absolute | --rate)
                             [--reserved] [--project <project>]
                             [--domain <domain>]

表48.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--absolute

絶対制限を表示します。

--rate

流量制御の表示

--reserved

予約数を含めます [--absoluteと共に使用する場合にのみ有効]。

--project <project>

特定のプロジェクト(名前または ID)の制限を表示します [--absoluteと共に使用する場合にのみ有効]。

--domain <domain>

プロジェクトが属するドメイン(名前または ID)[--absoluteと共に使用する場合にのみ有効]。

表48.2 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表48.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表48.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表48.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第49章 loadbalancer

本章では、loadbalancer コマンドに含まれるコマンドについて説明します。

49.1. loadbalancer amphora configure

amphora エージェントの設定を更新します。

使用方法

openstack loadbalancer amphora configure [-h] <amphora-id>

表49.1 位置引数

概要

<amphora-id>

設定する amphora の UUID

表49.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

49.2. loadbalancer amphora failover

amphora を強制的にフェイルオーバーします。

使用方法

openstack loadbalancer amphora failover [-h] <amphora-id>

表49.3 位置引数

概要

<amphora-id>

amphora の UUID

表49.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

49.3. loadbalancer amphora list

amphora を一覧表示します。

使用方法

openstack loadbalancer amphora list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           [--loadbalancer <loadbalancer>]
                                           [--compute-id <compute-id>]
                                           [--role {BACKUP,MASTER,STANDALONE}]
                                           [--status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}]

表49.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--loadbalancer <loadbalancer>

ロードバランサーでフィルタリングします(名前または ID)。

--compute-id <compute-id>

コンピュート ID でフィルタリングします。

--role {BACKUP,MASTER,STANDALONE}

ロールでフィルタリングします。

--status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}, --provisioning-status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}

amphora のプロビジョニングステータスでフィルタリングします。

表49.6 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表49.7 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表49.8 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.9 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.4. loadbalancer amphora show

1 つの amphora の詳細を表示します。

使用方法

openstack loadbalancer amphora show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           <amphora-id>

表49.10 位置引数

概要

<amphora-id>

amphora の UUID

表49.11 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.12 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.13 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.14 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.15 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.5. loadbalancer create

ロードバランサーを作成します。

使用方法

openstack loadbalancer create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--name <name>]
                                     [--description <description>]
                                     [--vip-address <vip_address>]
                                     [--vip-port-id <vip_port_id>]
                                     [--vip-subnet-id <vip_subnet_id>]
                                     [--vip-network-id <vip_network_id>]
                                     [--vip-qos-policy-id <vip_qos_policy_id>]
                                     [--project <project>]
                                     [--provider <provider>]
                                     [--enable | --disable]
                                     [--flavor <flavor>]

表49.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新しいロードバランサー名。

--description <description>

ロードバランサーの説明を設定します。

--vip-address <vip_address>

vip ip アドレスを設定します。

--vip-qos-policy-id <vip_qos_policy_id>

vip port に qos policy id を設定します。設定を解除する場合は none にします。

--project <project>

ロードバランサーのプロジェクト(名前または id)。

--provider <provider>

ロードバランサーのプロバイダー名。

--enable

ロードバランサーを有効にします(デフォルト)。

--disable

ロードバランサーを無効にします。

--flavor <flavor>

ロードバランサーのフレーバーの名前または ID。

表49.17 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.18 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.19 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.20 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

表49.21 VIP ネットワーク

概要

少なくとも以下の引数のいずれかが必要です。--vip-port-id <vip_port_id>

ロードバランサーのポートを設定します(名前または id)。

--vip-subnet-id <vip_subnet_id>

ロードバランサーにサブネットを設定します(名前または ID)。

--vip-network-id <vip_network_id>

ロードバランサーにネットワークを設定します(名前または id)。

49.6. loadbalancer delete

ロードバランサーを削除します。

使用方法

openstack loadbalancer delete [-h] [--cascade] <load_balancer>

表49.22 位置引数

概要

<load_balancer>

削除するロードバランサー(名前または ID)

表49.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--cascade

削除をロードバランサーのすべての子要素に適用します。

49.7. loadbalancer failover

ロードバランサーのフェイルオーバーをトリガーします。

使用方法

openstack loadbalancer failover [-h] <load_balancer>

表49.24 位置引数

概要

<load_balancer>

ロードバランサーの名前または uuid

表49.25 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

49.8. loadbalancer flavor create

octavia フレーバーを作成します。

使用方法

openstack loadbalancer flavor create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            --name <name> --flavorprofile
                                            <flavor_profile>
                                            [--description <description>]
                                            [--enable | --disable]

表49.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新規フレーバー名。

--flavorprofile <flavor_profile>

フレーバーを追加するフレーバープロファイル(名前または ID)

--description <description>

フレーバーの説明を設定します。

--enable

フレーバーを有効にします。

--disable

フレーバーを無効にします。

表49.27 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.28 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.29 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.30 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.9. loadbalancer flavor delete

フレーバーを削除します。

使用方法

openstack loadbalancer flavor delete [-h] <flavor>

表49.31 位置引数

概要

<flavor>

削除するフレーバー(名前または ID)

表49.32 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

49.10. loadbalancer flavor list

フレーバーを一覧表示します。

使用方法

openstack loadbalancer flavor list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          [--name <name>]
                                          [--flavorprofile <flavor_profile>]
                                          [--enable | --disable]

表49.33 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

名前に従ってフレーバーを一覧表示します。

--flavorprofile <flavor_profile>

フレーバープロファイルに従ってフレーバーを一覧表示します。

--enable

有効なフレーバーを一覧表示します。

--disable

無効なフレーバーを一覧表示します。

表49.34 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表49.35 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表49.36 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.37 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.11. loadbalancer flavor set

フレーバーを更新します。

使用方法

openstack loadbalancer flavor set [-h] [--name <name>]
                                         [--enable | --disable]
                                         <flavor>

表49.38 位置引数

概要

<flavor>

更新するフレーバーの名前または uuid

表49.39 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

フレーバーの名前を設定します。

--enable

フレーバーを有効にします。

--disable

フレーバーを無効にします。

49.12. loadbalancer flavor show

1 つのフレーバーの詳細を表示します。

使用方法

openstack loadbalancer flavor show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <flavor>

表49.40 位置引数

概要

<flavor>

フレーバーの名前または uuid

表49.41 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.42 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.43 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.44 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.45 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.13. loadbalancer flavor unset

ヘルスモニター設定を消去します。

使用方法

openstack loadbalancer flavor unset [-h] [--description] <flavor>

表49.46 位置引数

概要

<flavor>

更新するフレーバー(名前または ID)

表49.47 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description

フレーバーの説明を消去します。

49.14. loadbalancer flavorprofile create

octavia フレーバープロファイルを作成します。

使用方法

openstack loadbalancer flavorprofile create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty] --name
                                                   <name> --provider <provider
                                                   name> --flavor-data
                                                   <flavor_data>

表49.48 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新規 octavia フレーバープロファイル名。

--provider <provider name>

フレーバープロファイルのプロバイダー名。

--flavor-data <flavor_data>

フレーバーメタデータが含まれる json 文字列。

表49.49 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.50 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.51 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.52 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.15. loadbalancer flavorprofile delete

フレーバープロファイルを削除します。

使用方法

openstack loadbalancer flavorprofile delete [-h] <flavor_profile>

表49.53 位置引数

概要

<flavor_profile>

削除するフレーバープロファイル(名前または ID)

表49.54 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

49.16. loadbalancer flavorprofile list

フレーバープロファイルを一覧表示します。

使用方法

openstack loadbalancer flavorprofile list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]
                                                 [--name <name>]
                                                 [--provider <provider_name>]

表49.55 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

フレーバープロファイル名でフレーバープロファイルを一覧表示します。

--provider <provider_name>

プロバイダーに従ってフレーバープロファイルを一覧表示します。

表49.56 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表49.57 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表49.58 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.59 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.17. loadbalancer flavorprofile set

フレーバープロファイルを更新します。

使用方法

openstack loadbalancer flavorprofile set [-h] [--name <name>]
                                                [--provider <provider_name>]
                                                [--flavor-data <flavor_data>]
                                                <flavor_profile>

表49.60 位置引数

概要

<flavor_profile>

更新するフレーバープロファイルの名前または uuid。

表49.61 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

フレーバープロファイルの名前を設定します。

--provider <provider_name>

フレーバープロファイルのプロバイダーを設定します。

--flavor-data <flavor_data>

フレーバープロファイルのフレーバーデータを設定します。

49.18. loadbalancer flavorprofile show

1 つのフレーバープロファイルの詳細を表示します。

使用方法

openstack loadbalancer flavorprofile show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 <flavor_profile>

表49.62 位置引数

概要

<flavor_profile>

表示するフレーバープロファイルの名前または uuid

表49.63 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.64 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.65 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.66 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.67 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.19. loadbalancer healthmonitor create

ヘルスモニターを作成します。

使用方法

openstack loadbalancer healthmonitor create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--name <name>] --delay
                                                   <delay>
                                                   [--domain-name <domain_name>]
                                                   [--expected-codes <codes>]
                                                   [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
                                                   [--http-version <http_version>]
                                                   --timeout <timeout>
                                                   --max-retries <max_retries>
                                                   [--url-path <url_path>]
                                                   --type
                                                   {PING,HTTP,TCP,HTTPS,TLS-HELLO,UDP-CONNECT}
                                                   [--max-retries-down <max_retries_down>]
                                                   [--enable | --disable]
                                                   <pool>

表49.68 位置引数

概要

<pool>

ヘルスモニターのプールを設定します(名前または ID)。

表49.69 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ヘルスモニター名を設定します。

--delay <delay>

プローブをメンバーに送信する間隔を秒単位で設定します。

--domain-name <domain_name>

HTTP ヘルスチェックのバックエンドサーバーに、http ホストヘッダーにインジェクトされるドメイン名を設定します。

--expected-codes <codes>

正常であることを宣言するためのメンバーからの応答で予想される http ステータスコードの一覧を設定します。

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

ヘルスモニターがリクエストに使用する http メソッドを設定します。

--http-version <http_version>

http バージョンを設定します。

--timeout <timeout>

モニターが接続を待つ最大のタイムアウト時間を秒単位で設定します。この値は delay 値よりも小さくなければなりません。

--max-retries <max_retries>

メンバーの稼働ステータスを ONLINE に変更するのに必要な正常なチェックの数。

--url-path <url_path>

バックエンドメンバーの健全性をテストするためにモニターによって送信されるリクエストの http url パスを設定します。

--type {PING,HTTP,TCP,HTTPS,TLS-HELLO,UDP-CONNECT}

ヘルスモニターのタイプを設定します。

--max-retries-down <max_retries_down>

メンバーのオペレーティングステータスを ERROR に変更する前に許容されるチェックの失敗数を設定します。

--enable

ヘルスモニターを有効にします(デフォルト)。

--disable

ヘルスモニターを無効にします。

表49.70 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.71 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.72 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.73 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.20. loadbalancer healthmonitor delete

ヘルスモニターを削除します。

使用方法

openstack loadbalancer healthmonitor delete [-h] <health_monitor>

表49.74 位置引数

概要

<health_monitor>

削除するヘルスモニター(名前または ID)

表49.75 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

49.21. loadbalancer healthmonitor list

ヘルスモニターを一覧表示します。

使用方法

openstack loadbalancer healthmonitor list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]

表49.76 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.77 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表49.78 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表49.79 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.80 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.22. loadbalancer healthmonitor set

ヘルスモニターを更新します。

使用方法

openstack loadbalancer healthmonitor set [-h] [--name <name>]
                                                [--delay <delay>]
                                                [--domain-name <domain_name>]
                                                [--expected-codes <codes>]
                                                [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
                                                [--http-version <http_version>]
                                                [--timeout <timeout>]
                                                [--max-retries <max_retries>]
                                                [--max-retries-down <max_retries_down>]
                                                [--url-path <url_path>]
                                                [--enable | --disable]
                                                <health_monitor>

表49.81 位置引数

概要

<health_monitor>

更新するヘルスモニター(名前または ID)

表49.82 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ヘルスモニター名を設定します。

--delay <delay>

プローブをメンバーに送信する間隔を秒単位で設定します。

--domain-name <domain_name>

HTTP ヘルスチェックのバックエンドサーバーに、http ホストヘッダーにインジェクトされるドメイン名を設定します。

--expected-codes <codes>

正常であることを宣言するためのメンバーからの応答で予想される http ステータスコードの一覧を設定します。

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

ヘルスモニターがリクエストに使用する http メソッドを設定します。

--http-version <http_version>

http バージョンを設定します。

--timeout <timeout>

モニターが接続を待つ最大のタイムアウト時間を秒単位で設定します。この値は delay 値よりも小さくなければなりません。

--max-retries <max_retries>

メンバーの稼働ステータスを ONLINE に変更するのに必要な正常なチェックの数を設定します。

--max-retries-down <max_retries_down>

メンバーのオペレーティングステータスを ERROR に変更する前に許容されるチェックの失敗数を設定します。

--url-path <url_path>

バックエンドメンバーの健全性をテストするためにモニターによって送信されるリクエストの http url パスを設定します。

--enable

ヘルスモニターを有効にします。

--disable

ヘルスモニターを無効にします。

49.23. loadbalancer healthmonitor show

単一のヘルスモニターの詳細を表示します。

使用方法

openstack loadbalancer healthmonitor show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 <health_monitor>

表49.83 位置引数

概要

<health_monitor>

ヘルスモニターの名前または uuid。

表49.84 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.85 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.86 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.87 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.88 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.24. loadbalancer healthmonitor unset

ヘルスモニター設定を消去します。

使用方法

openstack loadbalancer healthmonitor unset [-h] [--domain-name]
                                                  [--expected-codes]
                                                  [--http-method]
                                                  [--http-version]
                                                  [--max-retries-down]
                                                  [--name] [--url-path]
                                                  <health_monitor>

表49.89 位置引数

概要

<health_monitor>

更新するヘルスモニター(名前または ID)

表49.90 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain-name

ヘルスモニターのドメイン名を消去します。

--expected-codes

ヘルスモニターの想定されるコードを api のデフォルトにリセットします。

--http-method

ヘルスモニターの http メソッドを api のデフォルトにリセットします。

--http-version

ヘルスモニターの http バージョンを api のデフォルトにリセットします。

--max-retries-down

ヘルスモニターの最大リトライ数を api のデフォルトにリセットして下げます。

--name

ヘルスモニター名を消去します。

--url-path

ヘルスモニター URL パスを消去します。

49.25. loadbalancer l7policy create

l7policy を作成します。

使用方法

openstack loadbalancer l7policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--name <name>]
                                              [--description <description>]
                                              --action
                                              {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}
                                              [--redirect-pool <pool> | --redirect-url <url> | --redirect-prefix <url>]
                                              [--redirect-http-code <redirect_http_code>]
                                              [--position <position>]
                                              [--enable | --disable]
                                              <listener>

表49.91 位置引数

概要

<listener>

l7policy をに追加するリスナー(名前または id)。

表49.92 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

l7policy 名を設定します。

--description <description>

l7policy の説明を設定します。

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}

ポリシーのアクションを設定します。

--redirect-pool <pool>

要求をリダイレクトするプールを設定します(名前または ID)。

--redirect-url <url>

要求のリダイレクト先となる URL を設定します。

--redirect-prefix <url>

要求のリダイレクト先となる url プレフィックスを設定します。

--redirect-http-code <redirect_http_code>

redirect_url またはREDIRECT_PREFIX アクションの http 応答コードを設定します。

--position <position>

この l7 ポリシーのシーケンス番号。

--enable

l7policyを有効にします(デフォルト)。

--disable

l7policy を無効にします。

表49.93 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.94 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.95 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.96 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.26. loadbalancer l7policy delete

l7policy を削除します。

使用方法

openstack loadbalancer l7policy delete [-h] <policy>

表49.97 位置引数

概要

<policy>

削除するL7policy(名前または ID)。

表49.98 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

49.27. loadbalancer l7policy list

l7policies を一覧表示します。

使用方法

openstack loadbalancer l7policy list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]

表49.99 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.100 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表49.101 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表49.102 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.103 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.28. loadbalancer l7policy set

l7policy を更新します。

使用方法

openstack loadbalancer l7policy set [-h] [--name <name>]
                                           [--description <description>]
                                           [--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}]
                                           [--redirect-pool <pool> | --redirect-url <url> | --redirect-prefix <url>]
                                           [--redirect-http-code <redirect_http_code>]
                                           [--position <position>]
                                           [--enable | --disable]
                                           <policy>

表49.104 位置引数

概要

<policy>

更新する L7policy(名前または ID)。

表49.105 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

l7policy 名を設定します。

--description <description>

l7policy の説明を設定します。

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}

ポリシーのアクションを設定します。

--redirect-pool <pool>

要求をリダイレクトするプールを設定します(名前または ID)。

--redirect-url <url>

要求のリダイレクト先となる URL を設定します。

--redirect-prefix <url>

要求のリダイレクト先となる url プレフィックスを設定します。

--redirect-http-code <redirect_http_code>

redirect_url またはREDIRECT_PREFIX アクションの http 応答コードを設定します。

--position <position>

この l7 ポリシーのシーケンス番号を設定します。

--enable

l7policy を有効にします。

--disable

l7policy を無効にします。

49.29. loadbalancer l7policy show

1 つの l7policy の詳細を表示します。

使用方法

openstack loadbalancer l7policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <policy>

表49.106 位置引数

概要

<policy>

l7policy の名前または uuid

表49.107 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.108 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.109 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.110 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.111 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.30. loadbalancer l7policy unset

l7policy 設定を消去します。

使用方法

openstack loadbalancer l7policy unset [-h] [--description] [--name]
                                             [--redirect-http-code]
                                             <policy>

表49.112 位置引数

概要

<policy>

更新する L7policy(名前または ID)。

表49.113 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description

l7policy の説明を消去します。

--name

l7policy 名を消去します。

--redirect-http-code

l7policy リダイレクト http コードを消去します。

49.31. loadbalancer l7rule create

l7rule を作成します。

使用方法

openstack loadbalancer l7rule create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            --compare-type
                                            {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}
                                            [--invert] --value <value>
                                            [--key <key>] --type
                                            {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}
                                            [--enable | --disable]
                                            <l7policy>

表49.114 位置引数

概要

<l7policy>

l7rule を追加する L7policy(名前または ID)。

表49.115 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

l7rule の比較タイプを設定します。

--invert

l7ruleを反転します。

--value <value>

照合するルールの値を設定します。

--key <key>

照合するl7rule の値のキーを設定します。

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}

l7rule のタイプを設定します。

--enable

l7ruleを有効にします(デフォルト)。

--disable

l7rule を無効にします。

表49.116 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.117 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.118 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.119 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.32. loadbalancer l7rule delete

l7rule を削除します。

使用方法

openstack loadbalancer l7rule delete [-h] <l7policy> <rule_id>

表49.120 位置引数

概要

<l7policy>

ルールを削除するL7policy(名前または ID)

<rule_id>

削除する L7rule。

表49.121 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

49.33. loadbalancer l7rule list

l7policy の l7rules を一覧表示します。

使用方法

openstack loadbalancer l7rule list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          <l7policy>

表49.122 位置引数

概要

<l7policy>

ルールを一覧表示するL7policy(名前または ID)

表49.123 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.124 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表49.125 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表49.126 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.127 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.34. loadbalancer l7rule set

l7rule を更新します。

使用方法

openstack loadbalancer l7rule set [-h]
                                         [--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}]
                                         [--invert] [--value <value>]
                                         [--key <key>]
                                         [--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}]
                                         [--enable | --disable]
                                         <l7policy> <l7rule_id>

表49.128 位置引数

概要

<l7policy>

l7ruleを更新するl7policy(名前または id)

<l7rule_id>

更新する L7rule。

表49.129 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

l7rule の比較タイプを設定します。

--invert

l7ruleを反転します。

--value <value>

照合するルールの値を設定します。

--key <key>

照合するl7rule の値のキーを設定します。

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}

l7rule のタイプを設定します。

--enable

l7rule を有効にします。

--disable

l7rule を無効にします。

49.35. loadbalancer l7rule show

1 つの l7ruleの詳細を表示します。

使用方法

openstack loadbalancer l7rule show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <l7policy> <l7rule_id>

表49.130 位置引数

概要

<l7policy>

ルールを表示するL7policy(名前または ID)。

<l7rule_id>

表示する L7rule。

表49.131 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.132 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.133 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.134 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.135 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.36. loadbalancer l7rule unset

l7rule の設定を消去します。

使用方法

openstack loadbalancer l7rule unset [-h] [--invert] [--key]
                                           <l7policy> <l7rule_id>

表49.136 位置引数

概要

<l7policy>

更新する L7policy(名前または ID)。

<l7rule_id>

更新する L7rule。

表49.137 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--invert

l7rule を反転して api のデフォルトにリセットします。

--key

l7rule キーを消去します。

49.37. loadbalancer list

ロードバランサーを一覧表示します。

使用方法

openstack loadbalancer list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN] [--name <name>]
                                   [--enable | --disable]
                                   [--project <project-id>]
                                   [--vip-network-id <vip_network_id>]
                                   [--vip-subnet-id <vip_subnet_id>]
                                   [--vip-qos-policy-id <vip_qos_policy_id>]
                                   [--vip-port-id <vip_port_id>]
                                   [--provisioning-status {ACTIVE,DELETED,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE}]
                                   [--operating-status {ONLINE,DRAINING,OFFLINE,DEGRADED,ERROR,NO_MONITOR}]
                                   [--provider <provider>] [--flavor <flavor>]

表49.138 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

名前に従ってロードバランサーを一覧表示します。

--enable

有効なロードバランサーを一覧表示します。

--disable

無効にされたロードバランサーを一覧表示します。

--project <project-id>

プロジェクトに従ってロードバランサーを一覧表示します(名前または ID)。

--vip-network-id <vip_network_id>

vip ネットワークに従ってロードバランサーを一覧表示します(名前または ID)。

--vip-subnet-id <vip_subnet_id>

vip サブネットに従ってロードバランサーを一覧表示します(名前または ID)。

--vip-qos-policy-id <vip_qos_policy_id>

vip qos ポリシーに従ってロードバランサーを一覧表示します(名前または ID)。

--vip-port-id <vip_port_id>

vip ポートに従ってロードバランサーを一覧表示します(名前または ID)。

--provisioning-status {ACTIVE,DELETED,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE}

プロビジョニングのステータスに従ってロードバランサーを一覧表示します。

--operating-status {ONLINE,DRAINING,OFFLINE,DEGRADED,ERROR,NO_MONITOR}

動作ステータスに従ってロードバランサーを一覧表示します。

--provider <provider>

プロバイダーに従ってロードバランサーを一覧表示します。

--flavor <flavor>

フレーバーに従ってロードバランサーを一覧表示します。

表49.139 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表49.140 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表49.141 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.142 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.38. loadbalancer listener create

リスナーを作成します。

使用方法

openstack loadbalancer listener create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--name <name>]
                                              [--description <description>]
                                              --protocol
                                              {TCP,HTTP,HTTPS,TERMINATED_HTTPS,UDP}
                                              [--connection-limit <limit>]
                                              [--default-pool <pool>]
                                              [--default-tls-container-ref <container_ref>]
                                              [--sni-container-refs [<container_ref> [<container_ref> ...]]]
                                              [--insert-headers <header=value,...>]
                                              --protocol-port <port>
                                              [--timeout-client-data <timeout>]
                                              [--timeout-member-connect <timeout>]
                                              [--timeout-member-data <timeout>]
                                              [--timeout-tcp-inspect <timeout>]
                                              [--enable | --disable]
                                              [--client-ca-tls-container-ref <container_ref>]
                                              [--client-authentication {NONE,OPTIONAL,MANDATORY}]
                                              [--client-crl-container-ref <client_crl_container_ref>]
                                              [--allowed-cidr [<allowed_cidr>]]
                                              <loadbalancer>

表49.143 位置引数

概要

<loadbalancer>

リスナーのロードバランサー(名前または id)

表49.144 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

リスナー名を設定します。

--description <description>

このリスナーの説明を設定します。

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,UDP}

リスナーのプロトコル。

--connection-limit <limit>

このリスナーで許可される接続の最大数を設定します。

--default-pool <pool>

L7 ポリシーが一致しない場合、リスナーによって使用されるプールの名前または ID を設定します。

--default-tls-container-ref <container_ref>

TERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--sni-container-refs [<container_ref> [<container_ref> …​]]

Server Name Indication を使用するTERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI の一覧。

--insert-headers <header=value,…​>

バックエンドメンバーに送信される前にリクエストに挿入するオプションヘッダーのディクショナリー。

--protocol-port <port>

リスナーのプロトコルポート番号を設定します。

--timeout-client-data <timeout>

フロントエンドクライアントの停止状態タイムアウト(ミリ秒単位)。デフォルト: 50000。

--timeout-member-connect <timeout>

バックエンドメンバーの接続タイムアウト(ミリ秒単位)。Default: 5000。

--timeout-member-data <timeout>

バックエンドメンバーの停止状態タイムアウト(ミリ秒単位)。デフォルト: 50000。

--timeout-tcp-inspect <timeout>

コンテンツの検査用に追加の tcp パケットを待機する時間(ミリ秒単位)。デフォルト: 0

--enable

リスナーを有効にします(デフォルト)。

--disable

リスナーを無効にします。

--client-ca-tls-container-ref <container_ref>

TERMINATED_TLS リスナーのCA証明書が含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--client-authentication {NONE,OPTIONAL,MANDATORY}

TERMINATED_TLS リスナーのtls クライアントの認証検証オプション。

--client-crl-container-ref <client_crl_container_ref>

TERMINATED_TLS リスナーのCA失効リストファイルが含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--allowed-cidr [<allowed_cidr>]

リスナーへのアクセスを許可する CIDR(複数回設定できます)。

表49.145 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.146 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.147 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.148 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.39. loadbalancer listener delete

リスナーを削除します。

使用方法

openstack loadbalancer listener delete [-h] <listener>

表49.149 位置引数

概要

<listener>

削除するリスナー(名前または ID)

表49.150 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

49.40. loadbalancer listener list

リスナーの一覧を表示します。

使用方法

openstack loadbalancer listener list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]
                                            [--name <name>]
                                            [--loadbalancer <loadbalancer>]
                                            [--enable | --disable]
                                            [--project <project>]

表49.151 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

リスナー名でリスナーを一覧表示します。

--loadbalancer <loadbalancer>

ロードバランサーでフィルタリングします(名前または ID)。

--enable

有効なリスナーを一覧表示します。

--disable

無効なリスナーを一覧表示します。

--project <project>

プロジェクト ID でリスナーを一覧表示します。

表49.152 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表49.153 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表49.154 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.155 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.41. loadbalancer listener set

リスナーを更新します。

使用方法

openstack loadbalancer listener set [-h] [--name <name>]
                                           [--description <description>]
                                           [--connection-limit <limit>]
                                           [--default-pool <pool>]
                                           [--default-tls-container-ref <container-ref>]
                                           [--sni-container-refs [<container-ref> [<container-ref> ...]]]
                                           [--insert-headers <header=value>]
                                           [--timeout-client-data <timeout>]
                                           [--timeout-member-connect <timeout>]
                                           [--timeout-member-data <timeout>]
                                           [--timeout-tcp-inspect <timeout>]
                                           [--enable | --disable]
                                           [--client-ca-tls-container-ref <container_ref>]
                                           [--client-authentication {NONE,OPTIONAL,MANDATORY}]
                                           [--client-crl-container-ref <client_crl_container_ref>]
                                           [--allowed-cidr [<allowed_cidr>]]
                                           <listener>

表49.156 位置引数

概要

<listener>

変更するリスナー(名前または ID)。

表49.157 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

リスナー名を設定します。

--description <description>

このリスナーの説明を設定します。

--connection-limit <limit>

このリスナーで許可される接続の最大数。デフォルト値は -1 で、無限接続を表します。

--default-pool <pool>

l7 ポリシーが一致していない場合、リスナーによって使用されるプールの ID。

--default-tls-container-ref <container-ref>

TERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--sni-container-refs [<container-ref> [<container-ref> …​]]

Server Name Indication を使用するTERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI の一覧。

--insert-headers <header=value>

バックエンドメンバーに送信される前にリクエストに挿入するオプションヘッダーのディクショナリー。

--timeout-client-data <timeout>

フロントエンドクライアントの停止状態タイムアウト(ミリ秒単位)。デフォルト: 50000。

--timeout-member-connect <timeout>

バックエンドメンバーの接続タイムアウト(ミリ秒単位)。Default: 5000。

--timeout-member-data <timeout>

バックエンドメンバーの停止状態タイムアウト(ミリ秒単位)。デフォルト: 50000。

--timeout-tcp-inspect <timeout>

コンテンツの検査用に追加の tcp パケットを待機する時間(ミリ秒単位)。デフォルト: 0

--enable

リスナーを有効にします。

--disable

リスナーを無効にします。

--client-ca-tls-container-ref <container_ref>

TERMINATED_TLS リスナーのCA証明書が含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--client-authentication {NONE,OPTIONAL,MANDATORY}

TERMINATED_TLS リスナーのtls クライアントの認証検証オプション。

--client-crl-container-ref <client_crl_container_ref>

TERMINATED_TLS リスナーのCA失効リストファイルが含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--allowed-cidr [<allowed_cidr>]

リスナーへのアクセスを許可する CIDR(複数回設定できます)。

49.42. loadbalancer listener show

単一のリスナーの詳細を表示します。

使用方法

openstack loadbalancer listener show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <listener>

表49.158 位置引数

概要

<listener>

リスナーの名前または uuid

表49.159 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.160 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.161 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.162 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.163 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.43. loadbalancer listener stats show

リスナーの現在の統計を表示します。

使用方法

openstack loadbalancer listener stats show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  <listener>

表49.164 位置引数

概要

<listener>

リスナーの名前または uuid

表49.165 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.166 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.167 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.168 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.169 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.44. loadbalancer listener unset

リスナーの設定を消去します。

使用方法

openstack loadbalancer listener unset [-h] [--name] [--description]
                                             [--connection-limit]
                                             [--default-pool]
                                             [--default-tls-container-ref]
                                             [--sni-container-refs]
                                             [--insert-headers]
                                             [--timeout-client-data]
                                             [--timeout-member-connect]
                                             [--timeout-member-data]
                                             [--timeout-tcp-inspect]
                                             [--client-ca-tls-container-ref]
                                             [--client-authentication]
                                             [--client-crl-container-ref]
                                             [--allowed-cidrs]
                                             <listener>

表49.170 位置引数

概要

<listener>

変更するリスナー(名前または ID)。

表49.171 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name

リスナー名を削除します。

--description

このリスナーの説明を消去します。

--connection-limit

接続制限を api のデフォルトにリセットします。

--default-pool

リスナーからデフォルトのプールを削除します。

--default-tls-container-ref

リスナーからデフォルトの tls コンテナー参照を削除します。

--sni-container-refs

リスナーから tls sniコンテナー参照を削除します。

--insert-headers

リスナーから挿入ヘッダーを消去します。

--timeout-client-data

クライアントデータタイムアウトを api のデフォルトにリセットします。

--timeout-member-connect

メンバー接続タイムアウトを api のデフォルトにリセットします。

--timeout-member-data

メンバーデータタイムアウトを api のデフォルトにリセットします。

--timeout-tcp-inspect

tcp インスペクションタイムアウトを api のデフォルトにリセットします。

--client-ca-tls-container-ref

リスナーからクライアント ca tls コンテナー参照を消去します。

--client-authentication

クライアント認証設定を api のデフォルトにリセットします。

--client-crl-container-ref

リスナーからクライアントの crl コンテナーの参照をクリアします。

--allowed-cidrs

リスナーから許可されるすべての cidr を消去します。

49.45. loadbalancer member create

プールにメンバーを作成します。

使用方法

openstack loadbalancer member create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--name <name>]
                                            [--disable-backup | --enable-backup]
                                            [--weight <weight>] --address
                                            <ip_address>
                                            [--subnet-id <subnet_id>]
                                            --protocol-port <protocol_port>
                                            [--monitor-port <monitor_port>]
                                            [--monitor-address <monitor_address>]
                                            [--enable | --disable]
                                            <pool>

表49.172 位置引数

概要

<pool>

メンバーを作成するプールの ID または名前。

表49.173 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

メンバーの名前。

--disable-backup

メンバーバックアップを無効にします(デフォルト)。

--enable-backup

メンバーバックアップを有効にします。

--weight <weight>

プールの他のメンバーと比較して、提供する要求または接続の部分を決定するメンバーの重み。

--address <ip_address>

バックエンドメンバーサーバーの IP アドレス

--subnet-id <subnet_id>

メンバーサービスがアクセスできるサブネット ID。

--protocol-port <protocol_port>

バックエンドメンバーサーバーがリッスンするプロトコルポート番号。

--monitor-port <monitor_port>

バックエンドメンバーの正常性モニタリングに使用する別のプロトコルポート。

--monitor-address <monitor_address>

バックエンドメンバーの正常性モニタリングに使用する別の IP アドレス。

--enable

メンバーを有効にします(デフォルト)。

--disable

メンバーを無効にします。

表49.174 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.175 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.176 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.177 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.46. loadbalancer member delete

プールからメンバーを削除します。

使用方法

openstack loadbalancer member delete [-h] <pool> <member>

表49.178 位置引数

概要

<pool>

メンバーを削除するプール名または id。

<member>

削除するメンバーの名前または ID。

表49.179 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

49.47. loadbalancer member list

プール内のメンバーを一覧表示します。

使用方法

openstack loadbalancer member list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          <pool>

表49.180 位置引数

概要

<pool>

メンバーを一覧表示するプール名または id。

表49.181 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.182 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表49.183 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表49.184 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.185 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.48. loadbalancer member set

メンバーを更新します。

使用方法

openstack loadbalancer member set [-h] [--name <name>]
                                         [--disable-backup | --enable-backup]
                                         [--weight <weight>]
                                         [--monitor-port <monitor_port>]
                                         [--monitor-address <monitor_address>]
                                         [--enable | --disable]
                                         <pool> <member>

表49.186 位置引数

概要

<pool>

更新するメンバーが属するプール(名前または ID)。

<member>

更新するメンバーの名前または ID

表49.187 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

メンバーの名前を設定します。

--disable-backup

メンバーバックアップを無効にします(デフォルト)。

--enable-backup

メンバーバックアップを有効にします。

--weight <weight>

プール内のメンバーの重みを設定します。

--monitor-port <monitor_port>

バックエンドメンバーの正常性モニタリングに使用する別のプロトコルポート。

--monitor-address <monitor_address>

バックエンドメンバーの正常性モニタリングに使用する別の IP アドレス。

--enable

admin_state_up を true に設定します。

--disable

admin_state_up を false に設定します。

49.49. loadbalancer member show

1 つのメンバーの詳細を表示します。

使用方法

openstack loadbalancer member show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <pool> <member>

表49.188 位置引数

概要

<pool>

メンバーを表示するプール名または id。

<member>

表示するメンバーの名前または ID。

表49.189 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.190 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.191 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.192 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.193 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.50. loadbalancer member unset

メンバーの設定を消去します。

使用方法

openstack loadbalancer member unset [-h] [--backup] [--monitor-address]
                                           [--monitor-port] [--name]
                                           [--weight]
                                           <pool> <member>

表49.194 位置引数

概要

<pool>

更新するメンバーが属するプール(名前または ID)。

<member>

変更するメンバー(名前または ID)

表49.195 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--backup

バックアップメンバーフラグを消去します。

--monitor-address

メンバーモニターアドレスを消去します。

--monitor-port

メンバーモニターポートを消去します。

--name

メンバー名を消去します。

--weight

メンバーの重みを api のデフォルトにリセットします。

49.51. loadbalancer pool create

プールを作成します。

使用方法

openstack loadbalancer pool create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--name <name>]
                                          [--description <description>]
                                          --protocol
                                          {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY,UDP}
                                          (--listener <listener> | --loadbalancer <load_balancer>)
                                          [--session-persistence <session persistence>]
                                          --lb-algorithm
                                          {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT}
                                          [--enable | --disable]
                                          [--tls-container-ref <container-ref>]
                                          [--ca-tls-container-ref <ca_tls_container_ref>]
                                          [--crl-container-ref <crl_container_ref>]
                                          [--enable-tls | --disable-tls]

表49.196 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

プール名を設定します。

--description <description>

プールの説明を設定します。

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY,UDP}

プールプロトコルを設定します。

--listener <listener>

プールを追加するリスナー(名前または ID)。

--loadbalancer <load_balancer>

プールを追加するロードバランサー(名前または ID)

--session-persistence <session persistence>

リスナーのセッション永続性を設定します(key=value)。

--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT}

使用するロードバランシングアルゴリズム。

--enable

プールを有効にします(デフォルト)。

--disable

プールを無効にします。

--tls-container-ref <container-ref>

バックエンドメンバーサーバーへのトラフィックを再暗号化するための``tls_enabled``プールの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの参照。

--ca-tls-container-ref <ca_tls_container_ref>

バックエンドメンバーサーバー証明書を確認するための``tls_enabled``プールのCA証明書が含まれるキーマネージャーサービスシークレットコンテナーへの参照。

--crl-container-ref <crl_container_ref>

バックエンドメンバーサーバー証明書を検証するための``tls_enabled``プールのCA失効リストファイルが含まれるキーマネージャーサービスシークレットコンテナーへの参照。

--enable-tls

バックエンドメンバーの再暗号化を有効にします。

--disable-tls

バックエンドメンバーの再暗号化を無効にします。

表49.197 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.198 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.199 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.200 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.52. loadbalancer pool delete

プールを削除します。

使用方法

openstack loadbalancer pool delete [-h] <pool>

表49.201 位置引数

概要

<pool>

削除するプール(名前または ID)

表49.202 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

49.53. loadbalancer pool list

プールを一覧表示します。

使用方法

openstack loadbalancer pool list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--loadbalancer <loadbalancer>]

表49.203 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--loadbalancer <loadbalancer>

ロードバランサーでフィルタリングします(名前または ID)。

表49.204 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表49.205 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表49.206 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.207 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.54. loadbalancer pool set

プールを更新します。

使用方法

openstack loadbalancer pool set [-h] [--name <name>]
                                       [--description <description>]
                                       [--session-persistence <session_persistence>]
                                       [--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT}]
                                       [--enable | --disable]
                                       [--tls-container-ref <container-ref>]
                                       [--ca-tls-container-ref <ca_tls_container_ref>]
                                       [--crl-container-ref <crl_container_ref>]
                                       [--enable-tls | --disable-tls]
                                       <pool>

表49.208 位置引数

概要

<pool>

更新するプール(名前または ID)。

表49.209 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

プールの名前を設定します。

--description <description>

プールの説明を設定します。

--session-persistence <session_persistence>

リスナーのセッション永続性を設定します(key=value)。

--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT}

使用するロードバランシングアルゴリズムを設定します。

--enable

プールを有効にします。

--disable

プールを無効にします。

--tls-container-ref <container-ref>

TERMINATED_TLSリスナーからバックエンドサーバーへのトラフィックを再暗号化するためのTERMINATED_TLSプールの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへのuri。

--ca-tls-container-ref <ca_tls_container_ref>

sslトラフィックのバックエンドサーバー証明書を確認するためのTERMINATED_TLS リスナーのCA証明書が含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--crl-container-ref <crl_container_ref>

sslトラフィックのバックエンドサーバー証明書を検証するためのTERMINATED_TLS リスナーのCA失効リストファイルが含まれるキーマネージャーサービスシークレットコンテナーへの URI。

--enable-tls

バックエンドの関連メンバーの再暗号化を有効にします。

--disable-tls

バックエンドの関連メンバーの再暗号化を無効にします。

49.55. loadbalancer pool show

単一プールの詳細を表示します。

使用方法

openstack loadbalancer pool show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <pool>

表49.210 位置引数

概要

<pool>

プールの名前または uuid。

表49.211 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.212 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.213 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.214 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.215 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.56. loadbalancer pool unset

プールの設定を消去します。

使用方法

openstack loadbalancer pool unset [-h] [--name] [--description]
                                         [--ca-tls-container-ref]
                                         [--crl-container-ref]
                                         [--session-persistence]
                                         [--tls-container-ref]
                                         <pool>

表49.216 位置引数

概要

<pool>

変更するプール(名前または ID)。

表49.217 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name

プール名を消去します。

--description

このプールの説明を消去します。

--ca-tls-container-ref

このプールの認証局の証明書参照を消去します。

--crl-container-ref

このプールの証明書失効リスト参照を消去します。

--session-persistence

プールのセッションの永続性を無効にします。

--tls-container-ref

このプールの証明書参照を消去します。

49.57. loadbalancer provider capability list

指定したプロバイダードライバーのフレーバーの機能を一覧表示します。

使用方法

openstack loadbalancer provider capability list [-h]
                                                       [-f {csv,json,table,value,yaml}]
                                                       [-c COLUMN]
                                                       [--quote {all,minimal,none,nonnumeric}]
                                                       [--noindent]
                                                       [--max-width <integer>]
                                                       [--fit-width]
                                                       [--print-empty]
                                                       [--sort-column SORT_COLUMN]
                                                       <provider_name>

表49.218 位置引数

概要

<provider_name>

プロバイダードライバーの名前。

表49.219 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.220 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表49.221 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表49.222 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.223 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.58. loadbalancer provider list

プロバイダーの一覧を表示します。

使用方法

openstack loadbalancer provider list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]

表49.224 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.225 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表49.226 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表49.227 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.228 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.59. loadbalancer quota defaults show

クォータのデフォルトを表示します。

使用方法

openstack loadbalancer quota defaults show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]

表49.229 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.230 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.231 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.232 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.233 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.60. loadbalancer quota list

クォータを一覧表示します。

使用方法

openstack loadbalancer quota list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]
                                         [--project <project-id>]

表49.234 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project-id>

プロジェクトの名前または uuid。

表49.235 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表49.236 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表49.237 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.238 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.61. loadbalancer quota reset

クォータをデフォルトのクォータにリセットします。

使用方法

openstack loadbalancer quota reset [-h] <project>

表49.239 位置引数

概要

<project>

クォータをリセットするプロジェクト(名前または ID)

表49.240 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

49.62. loadbalancer quota set

クォータを更新します。

使用方法

openstack loadbalancer quota set [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--healthmonitor <health_monitor>]
                                        [--listener <listener>]
                                        [--loadbalancer <load_balancer>]
                                        [--member <member>] [--pool <pool>]
                                        <project>

表49.241 位置引数

概要

<project>

プロジェクトの名前または uuid。

表49.242 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.243 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.244 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.245 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.246 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

表49.247 クォータの制限

概要

以下の引数のいずれかが必要です。--healthmonitor <health_monitor>

ヘルスモニタークォータの新しい値。値が -1 の場合は無制限を意味します。

--listener <listener>

リスナークォータの新しい値。値が -1 の場合は無制限を意味します。

--loadbalancer <load_balancer>

ロードバランサークォータ制限の新しい値。値が -1 の場合は無制限を意味します。

--member <member>

メンバークォータ制限の新しい値。値が -1 の場合は無制限を意味します。

--pool <pool>

プールクォータ制限の新しい値。値が -1 の場合は無制限を意味します。

49.63. loadbalancer quota show

プロジェクトのクォータの詳細を表示します。

使用方法

openstack loadbalancer quota show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <project>

表49.248 位置引数

概要

<project>

プロジェクトの名前または uuid。

表49.249 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.250 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.251 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.252 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.253 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.64. loadbalancer quota unset

クォータの設定を消去します。

使用方法

openstack loadbalancer quota unset [-h] [--loadbalancer] [--listener]
                                          [--pool] [--member]
                                          [--healthmonitor]
                                          <project>

表49.254 位置引数

概要

<project>

プロジェクトの名前または uuid。

表49.255 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--loadbalancer

ロードバランサークォータをデフォルトにリセットします。

--listener

リスナーのクォータをデフォルトにリセットします。

--pool

プールクォータをデフォルトにリセットします。

--member

メンバークォータをデフォルトにリセットします。

--healthmonitor

ヘルスモニタークォータをデフォルトにリセットします。

49.65. loadbalancer set

ロードバランサーを更新します。

使用方法

openstack loadbalancer set [-h] [--name <name>]
                                  [--description <description>]
                                  [--vip-qos-policy-id <vip_qos_policy_id>]
                                  [--enable | --disable]
                                  <load_balancer>

表49.256 位置引数

概要

<load_balancer>

更新するロードバランサーの名前または uuid

表49.257 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ロードバランサー名を設定します。

--description <description>

ロードバランサーの説明を設定します。

--vip-qos-policy-id <vip_qos_policy_id>

vip port に qos policy id を設定します。設定を解除する場合は none にします。

--enable

ロードバランサーを有効にします。

--disable

ロードバランサーを無効にします。

49.66. loadbalancer show

単一のロードバランサーの詳細を表示します。

使用方法

openstack loadbalancer show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <load_balancer>

表49.258 位置引数

概要

<load_balancer>

ロードバランサーの名前または uuid

表49.259 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.260 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.261 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.262 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.263 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.67. loadbalancer stats show

ロードバランサーの現在の統計を表示します。

使用方法

openstack loadbalancer stats show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <load_balancer>

表49.264 位置引数

概要

<load_balancer>

ロードバランサーの名前または uuid

表49.265 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表49.266 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表49.267 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表49.268 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表49.269 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

49.68. loadbalancer status show

json 形式でのロードバランサーのステータスツリーを表示します。

使用方法

openstack loadbalancer status show [-h] <load_balancer>

表49.270 位置引数

概要

<load_balancer>

ロードバランサーの名前または uuid

表49.271 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

49.69. loadbalancer unset

ロードバランサーの設定を消去します。

使用方法

openstack loadbalancer unset [-h] [--name] [--description]
                                    [--vip-qos-policy-id]
                                    <load_balancer>

表49.272 位置引数

概要

<load_balancer>

更新するロードバランサーの名前または uuid

表49.273 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name

ロードバランサー名を消去します。

--description

ロードバランサーの説明を消去します。

--vip-qos-policy-id

ロードバランサー qos ポリシーを消去します。

第50章 mapping

本章では、mapping コマンドに含まれるコマンドについて説明します。

50.1. mapping create

新規マッピングを作成します。

使用方法

openstack mapping create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] --rules <filename>
                                <name>

表50.1 位置引数

概要

<name>

新しいマッピング名(一意である必要があります)

表50.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--rules <filename>

一連のマッピングルールが含まれるファイル名(必須)

表50.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表50.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表50.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表50.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

50.2. mapping delete

マッピングを削除します。

使用方法

openstack mapping delete [-h] <mapping> [<mapping> ...]

表50.7 位置引数

概要

<mapping>

削除するマッピング

表50.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

50.3. mapping list

マッピングを一覧表示します。

使用方法

openstack mapping list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN]

表50.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表50.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表50.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表50.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表50.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

50.4. mapping set

マッピングの属性を設定します。

使用方法

openstack mapping set [-h] [--rules <filename>] <name>

表50.14 位置引数

概要

<name>

変更するマッピング

表50.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--rules <filename>

新しいマッピングルールセットが含まれるファイル名

50.5. mapping show

マッピングの詳細を表示します。

使用方法

openstack mapping show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <mapping>

表50.16 位置引数

概要

<mapping>

表示するパッピング

表50.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表50.18 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表50.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表50.20 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表50.21 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第51章 messaging

本章では、messaging コマンドに含まれるコマンドについて説明します。

51.1. messaging claim create

要求を作成し、要求されたメッセージの一覧を返します。

使用方法

openstack messaging claim create [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--ttl <ttl>] [--grace <grace>]
                                        [--limit <limit>]
                                        <queue_name>

表51.1 位置引数

概要

<queue_name>

要求するキューの名前

表51.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--ttl <ttl>

要求の存続期間(秒単位)

--grace <grace>

メッセージの猶予期間(秒単位)

--limit <limit>

制限まで、メッセージのセットを要求します。

表51.3 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表51.4 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表51.5 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.2. messaging claim query

要求の詳細を表示します。

使用方法

openstack messaging claim query [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       <queue_name> <claim_id>

表51.7 位置引数

概要

<queue_name>

要求されたキューの名前

<claim_id>

要求の ID

表51.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表51.9 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表51.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表51.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.12 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.3. messaging claim release

要求を削除します。

使用方法

openstack messaging claim release [-h] <queue_name> <claim_id>

表51.13 位置引数

概要

<queue_name>

要求されたキューの名前

<claim_id>

削除する要求 ID

表51.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

51.4. messaging claim renew

要求を更新します。

使用方法

openstack messaging claim renew [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--ttl <ttl>] [--grace <grace>]
                                       <queue_name> <claim_id>

表51.15 位置引数

概要

<queue_name>

要求されたキューの名前

<claim_id>

要求 ID

表51.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--ttl <ttl>

要求の存続期間(秒単位)

--grace <grace>

メッセージの猶予期間(秒単位)

表51.17 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表51.18 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表51.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.20 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.5. messaging flavor create

プールのフレーバーを作成します。

使用方法

openstack messaging flavor create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         [--pool_list <pool_list>]
                                         [--capabilities <capabilities>]
                                         <flavor_name>

表51.21 位置引数

概要

<flavor_name>

フレーバーの名前

表51.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--pool_list <pool_list>

フレーバーのプール一覧

--capabilities <capabilities>

フレーバー固有の機能を記述します。このオプションはクライアント api バージョン が 2 より前の場合のみ利用可能です。

表51.23 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.24 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.25 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表51.26 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.6. messaging flavor delete

プールのフレーバーを削除します。

使用方法

openstack messaging flavor delete [-h] <flavor_name>

表51.27 位置引数

概要

<flavor_name>

フレーバーの名前

表51.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

51.7. messaging flavor list

利用可能なプールのフレーバーを一覧表示します。

使用方法

openstack messaging flavor list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--marker <flavor_name>]
                                       [--limit <limit>] [--detailed]

表51.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker <flavor_name>

フレーバーのページングマーカー

--limit <limit>

ページサイズの制限

--detailed

フレーバーの詳細な機能を表示する場合

表51.30 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表51.31 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表51.32 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.33 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.8. messaging flavor show

プールフレーバーの詳細を表示します。

使用方法

openstack messaging flavor show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <flavor_name>

表51.34 位置引数

概要

<flavor_name>

表示するフレーバー(名前)

表51.35 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表51.36 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.37 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.38 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表51.39 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.9. messaging flavor update

フレーバーの属性を更新します。

使用方法

openstack messaging flavor update [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         [--pool_list <pool_list>]
                                         [--capabilities <capabilities>]
                                         <flavor_name>

表51.40 位置引数

概要

<flavor_name>

フレーバーの名前

表51.41 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--pool_list <pool_list>

フレーバーが存在するプールのリスト

--capabilities <capabilities>

フレーバー固有の機能を説明します。

表51.42 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.43 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.44 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表51.45 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.10. messaging health

Zaqar サーバーの詳細なヘルスステータスを表示します。

使用方法

openstack messaging health [-h]

表51.46 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

51.11. messaging homedoc

Zaqar サーバーの詳細なリソースドキュメントを表示します。

使用方法

openstack messaging homedoc [-h]

表51.47 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

51.12. messaging message list

指定のキューのすべてのメッセージを一覧表示します。

使用方法

openstack messaging message list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--message-ids <message_ids>]
                                        [--limit <limit>] [--echo]
                                        [--include-claimed]
                                        [--include-delayed]
                                        [--client-id <client_id>]
                                        <queue_name>

表51.48 位置引数

概要

<queue_name>

キューの名前

表51.49 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--message-ids <message_ids>

取得するメッセージの ID の一覧

--limit <limit>

取得するメッセージの最大数。

--echo

このクライアント自体のメッセージを受信するかどうか。

--include-claimed

要求されたメッセージを含めるかどうか。

--include-delayed

遅延メッセージを含めるかどうか。

--client-id <client_id>

各クライアントインスタンスの UUID。

表51.50 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表51.51 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表51.52 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.53 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.13. messaging message post

指定のキューのメッセージを投稿します。

使用方法

openstack messaging message post [-h] [--client-id <client_id>]
                                        <queue_name> <messages>

表51.54 位置引数

概要

<queue_name>

キューの名前

<messages>

投稿されるメッセージ。

表51.55 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--client-id <client_id>

各クライアントインスタンスの UUID。

51.14. messaging ping

Zaqar サーバーが稼働しているかどうかを確認します。

使用方法

openstack messaging ping [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]

表51.56 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表51.57 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.58 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.59 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表51.60 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.15. messaging pool create

プールを作成します。

使用方法

openstack messaging pool create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] [--flavor <flavor>]
                                       [--pool_options <pool_options>]
                                       <pool_name> <pool_uri> <pool_weight>

表51.61 位置引数

概要

<pool_name>

プールの名前

<pool_uri>

ストレージエンジン URI

<pool_weight>

プールの重み

表51.62 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--flavor <flavor>

プールのフレーバー

--pool_options <pool_options>

ストレージ固有のオプションに関連するオプションの要求コンポーネント

表51.63 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.64 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.65 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表51.66 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.16. messaging pool delete

プールを削除します。

使用方法

openstack messaging pool delete [-h] <pool_name>

表51.67 位置引数

概要

<pool_name>

プールの名前

表51.68 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

51.17. messaging pool list

利用可能なプールを一覧表示します。

使用方法

openstack messaging pool list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--marker <pool_name>] [--limit <limit>]
                                     [--detailed]

表51.69 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker <pool_name>

プールのページングマーカー

--limit <limit>

ページサイズの制限

--detailed

詳細出力

表51.70 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表51.71 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表51.72 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.73 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.18. messaging pool show

プールの詳細を表示します。

使用方法

openstack messaging pool show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <pool_name>

表51.74 位置引数

概要

<pool_name>

表示するプール(名前)

表51.75 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表51.76 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.77 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.78 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表51.79 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.19. messaging pool update

プール属性を更新します。

使用方法

openstack messaging pool update [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] [--pool_uri <pool_uri>]
                                       [--pool_weight <pool_weight>]
                                       [--flavor <flavor>]
                                       [--pool_options <pool_options>]
                                       <pool_name>

表51.80 位置引数

概要

<pool_name>

プールの名前

表51.81 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--pool_uri <pool_uri>

ストレージエンジン URI

--pool_weight <pool_weight>

プールの重み

--flavor <flavor>

プールのフレーバー

--pool_options <pool_options>

ストレージ固有のオプションに関連するオプションの要求コンポーネント

表51.82 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.83 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.84 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表51.85 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.20. messaging queue create

キューを作成します。

使用方法

openstack messaging queue create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <queue_name>

表51.86 位置引数

概要

<queue_name>

キューの名前

表51.87 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表51.88 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.89 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.90 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表51.91 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.21. messaging queue delete

キューを削除します。

使用方法

openstack messaging queue delete [-h] <queue_name>

表51.92 位置引数

概要

<queue_name>

キューの名前

表51.93 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

51.22. messaging queue get metadata

キューのメタデータを取得します。

使用方法

openstack messaging queue get metadata [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              <queue_name>

表51.94 位置引数

概要

<queue_name>

キューの名前

表51.95 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表51.96 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.97 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.98 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表51.99 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.23. messaging queue list

利用可能なキューを一覧表示します。

使用方法

openstack messaging queue list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--marker <queue_id>] [--limit <limit>]
                                      [--detailed]

表51.100 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker <queue_id>

キューのページングマーカー

--limit <limit>

ページサイズの制限

--detailed

キューの詳細情報を表示する場合

表51.101 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表51.102 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表51.103 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.104 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.24. messaging queue purge

キューをパージします。

使用方法

openstack messaging queue purge [-h]
                                       [--resource_types <resource_types>]
                                       <queue_name>

表51.105 位置引数

概要

<queue_name>

キューの名前

表51.106 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource_types <resource_types>

パージするリソースタイプ。

51.25. messaging queue set metadata

キューのメタデータを設定します。

使用方法

openstack messaging queue set metadata [-h]
                                              <queue_name> <queue_metadata>

表51.107 位置引数

概要

<queue_name>

キューの名前

<queue_metadata>

キューメタデータ。キューのメタデータはすべて queue_metadata に置き換えられます。

表51.108 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

51.26. messaging queue signed url

事前に署名された URL を作成します。

使用方法

openstack messaging queue signed url [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--paths <paths>]
                                            [--ttl-seconds <ttl_seconds>]
                                            [--methods <methods>]
                                            <queue_name>

表51.109 位置引数

概要

<queue_name>

キューの名前

表51.110 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--paths <paths>

許可されるパスのコンマ区切りリスト。オプション:messages、subscriptions、claims

--ttl-seconds <ttl_seconds>

署名の有効期限が切れるまでの期間(秒単位)

--methods <methods>

許可する HTTP メソッドのコンマ区切りリスト。オプション:GET、HEAD、OPTIONS、POST、PUT、DELETE

表51.111 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.112 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.113 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表51.114 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.27. messaging queue stats

キューの統計値を取得します。

使用方法

openstack messaging queue stats [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <queue_name>

表51.115 位置引数

概要

<queue_name>

キューの名前

表51.116 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表51.117 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.118 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.119 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表51.120 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.28. messaging subscription create

キューのサブスクリプションを作成します。

使用方法

openstack messaging subscription create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--options <options>]
                                               <queue_name> <subscriber> <ttl>

表51.121 位置引数

概要

<queue_name>

サブスクライブするキューの名前

<subscriber>

通知されるサブスクライバー

<ttl>

サブスクリプションの存続期間(秒単位)

表51.122 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--options <options>

json 形式のサブスクリプションのメタデータ

表51.123 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.124 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.125 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表51.126 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.29. messaging subscription delete

サブスクリプションを削除します。

使用方法

openstack messaging subscription delete [-h]
                                               <queue_name> <subscription_id>

表51.127 位置引数

概要

<queue_name>

サブスクリプションのキューの名前

<subscription_id>

サブスクリプションの ID

表51.128 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

51.30. messaging subscription list

利用可能なサブスクリプションを一覧表示します。

使用方法

openstack messaging subscription list [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--noindent]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--sort-column SORT_COLUMN]
                                             [--marker <subscription_id>]
                                             [--limit <limit>]
                                             <queue_name>

表51.129 位置引数

概要

<queue_name>

サブスクライブするキューの名前

表51.130 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker <subscription_id>

サブスクリプションのページングマーカー、前のページにある最後のサブスクリプションの ID

--limit <limit>

ページサイズの制限。デフォルト値は 20 です。

表51.131 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表51.132 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表51.133 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.134 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.31. messaging subscription show

サブスクリプションの詳細を表示します。

使用方法

openstack messaging subscription show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <queue_name> <subscription_id>

表51.135 位置引数

概要

<queue_name>

サブスクライブするキューの名前

<subscription_id>

サブスクリプションの ID

表51.136 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表51.137 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.138 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.139 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表51.140 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

51.32. messaging subscription update

サブスクリプションを更新します。

使用方法

openstack messaging subscription update [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--subscriber <subscriber>]
                                               [--ttl <ttl>]
                                               [--options <options>]
                                               <queue_name> <subscription_id>

表51.141 位置引数

概要

<queue_name>

サブスクライブするキューの名前

<subscription_id>

サブスクリプションの ID

表51.142 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--subscriber <subscriber>

通知されるサブスクライバー

--ttl <ttl>

サブスクリプションの存続期間(秒単位)

--options <options>

json 形式のサブスクリプションのメタデータ

表51.143 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表51.144 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表51.145 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表51.146 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第52章 metric

本章では、metric コマンドに含まれるコマンドについて説明します。

52.1. metric aggregates

集約されたメトリクスの計測値を取得します。

使用方法

openstack metric aggregates [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--resource-type RESOURCE_TYPE]
                                   [--start START] [--stop STOP]
                                   [--granularity GRANULARITY]
                                   [--needed-overlap NEEDED_OVERLAP]
                                   [--groupby GROUPBY] [--fill FILL]
                                   operations [search]

表52.1 位置引数

概要

operations

時系列に適用する操作

search

リソースをフィルターするクエリー。構文は、属性、演算子、および値の組み合わせです。たとえば、id=90d58eea-70d7-4294-a49a-170dcdf44c3c は特定の ID でリソースをフィルターします。より複雑なクエリーを構築することができます(例:not (flavor_id!="1" and memory>=24))。"" を使用して、データを文字列として解釈するように強制します。サポートされる演算子は not、and、∧、or、∨、>=、⇐、!=、>、<、=、==、eq、ne、lt、gt、ge、le、in、like、≠、≥、≤、like、in です。

表52.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-type RESOURCE_TYPE

問い合わせるリソースタイプ

--start START

期間の開始

--stop STOP

期間の終了

--granularity GRANULARITY

取得する際の詳細度

--needed-overlap NEEDED_OVERLAP

データポイント間での重複の割合

--groupby GROUPBY

リソースをグループ化するために使用する属性

--fill FILL

シリーズのサブセットに値がない状態でタイムスタンプをバックフィルする際に使用する値。値は浮動小数点または null である必要があります。

表52.3 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表52.4 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表52.5 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.2. metric archive-policy create

アーカイブポリシーを作成します。

使用方法

openstack metric archive-policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty] -d
                                              <DEFINITION> [-b BACK_WINDOW]
                                              [-m AGGREGATION_METHODS]
                                              name

表52.7 位置引数

概要

name

アーカイブポリシーの名前

表52.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-D <DEFINITION>、--definition <DEFINITION>

名前と値を:で区切った、アーカイブポリシー定義の (,で区切られた)2 つの属性

-b BACK_WINDOW, --back-window BACK_WINDOW

アーカイブポリシーのバックウィンドウ

-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS

アーカイブポリシーの集約メソッド

表52.9 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.10 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.11 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.12 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.3. metric archive-policy delete

アーカイブポリシーを削除します。

使用方法

openstack metric archive-policy delete [-h] name

表52.13 位置引数

概要

name

アーカイブポリシーの名前

表52.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

52.4. metric archive-policy list

アーカイブポリシーを一覧表示します。

使用方法

openstack metric archive-policy list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]

表52.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表52.16 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表52.17 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表52.18 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.19 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.5. metric archive-policy-rule create

アーカイブポリシールールを作成します。

使用方法

openstack metric archive-policy-rule create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty] -a
                                                   ARCHIVE_POLICY_NAME -m
                                                   METRIC_PATTERN
                                                   name

表52.20 位置引数

概要

name

ルール名

表52.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME

アーカイブポリシー名

-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN

照合するメトリクス名のワイルドカード

表52.22 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.24 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.25 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.6. metric archive-policy-rule delete

アーカイブポリシールールを削除します。

使用方法

openstack metric archive-policy-rule delete [-h] name

表52.26 位置引数

概要

name

アーカイブポリシールールの名前

表52.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

52.7. metric archive-policy-rule list

アーカイブポリシールールを一覧表示します。

使用方法

openstack metric archive-policy-rule list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]

表52.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表52.29 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表52.30 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表52.31 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.32 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.8. metric archive-policy-rule show

アーカイブポリシールールを表示します。

使用方法

openstack metric archive-policy-rule show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 name

表52.33 位置引数

概要

name

アーカイブポリシールールの名前

表52.34 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表52.35 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.36 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.37 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.38 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.9. metric archive-policy show

アーカイブポリシーを表示します。

使用方法

openstack metric archive-policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            name

表52.39 位置引数

概要

name

アーカイブポリシーの名前

表52.40 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表52.41 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.42 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.43 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.44 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.10. metric archive-policy update

アーカイブポリシーを更新します。

使用方法

openstack metric archive-policy update [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty] -d
                                              <DEFINITION>
                                              name

表52.45 位置引数

概要

name

アーカイブポリシーの名前

表52.46 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-D <DEFINITION>、--definition <DEFINITION>

名前と値を:で区切った、アーカイブポリシー定義の (,で区切られた)2 つの属性

表52.47 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.48 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.49 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.50 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.11. metric benchmark measures add

測定の追加のベンチマークテストを行います。

使用方法

openstack metric benchmark measures add [-h]
                                               [--resource-id RESOURCE_ID]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--workers WORKERS] --count
                                               COUNT [--batch BATCH]
                                               [--timestamp-start TIMESTAMP_START]
                                               [--timestamp-end TIMESTAMP_END]
                                               [--wait]
                                               metric

表52.51 位置引数

概要

metric

メトリクスの ID または名前

表52.52 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--workers WORKERS, -w WORKERS

使用するワーカー数

--count COUNT, -n COUNT

送信する合計計測値の数

--batch BATCH, -b BATCH

各バッチで送信する計測値の数

--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START

使用する最初のタイムスタンプ

--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END

使用する最終タイムスタンプ

--wait

全計測が処理されるのを待ちます。

表52.53 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.54 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.55 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.56 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.12. metric benchmark measures show

measurements show のベンチマークテストを行います。

使用方法

openstack metric benchmark measures show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                [--utc]
                                                [--resource-id RESOURCE_ID]
                                                [--aggregation AGGREGATION]
                                                [--start START] [--stop STOP]
                                                [--granularity GRANULARITY]
                                                [--refresh]
                                                [--resample RESAMPLE]
                                                [--workers WORKERS] --count
                                                COUNT
                                                metric

表52.57 位置引数

概要

metric

メトリクスの ID または名前

表52.58 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--utc

タイムスタンプを utc として返します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--aggregation AGGREGATION

取得する集約

--start START

期間の開始

--stop STOP

期間の終了

--granularity GRANULARITY

取得する際の詳細度

--refresh

すべての既知の計測値を強制的に集計します。

--resample RESMYBACKUPDIRLE

時系列を再サンプリングする粒度(秒単位)

--workers WORKERS, -w WORKERS

使用するワーカー数

--count COUNT, -n COUNT

送信する合計計測値の数

表52.59 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表52.60 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.61 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.62 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.13. metric benchmark metric create

メトリクス作成のベンチマークテストを行います。

使用方法

openstack metric benchmark metric create [-h]
                                                [--resource-id RESOURCE_ID]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--archive-policy-name ARCHIVE_POLICY_NAME]
                                                [--workers WORKERS] --count
                                                COUNT [--keep]

表52.63 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

アーカイブポリシーの名前

--workers WORKERS, -w WORKERS

使用するワーカー数

--count COUNT, -n COUNT

作成するメトリクスの数

--keep, -k

作成されたメトリクスを保持します。

表52.64 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.65 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.66 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.67 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.14. metric benchmark metric show

metric show のベンチマークテストを行います。

使用方法

openstack metric benchmark metric show [-h] [--resource-id RESOURCE_ID]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--workers WORKERS] --count
                                              COUNT
                                              metric [metric ...]

表52.68 位置引数

概要

metric

メトリクス ID または名前

表52.69 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--workers WORKERS, -w WORKERS

使用するワーカー数

--count COUNT, -n COUNT

取得するメトリクスの数

表52.70 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.71 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.72 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.73 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.15. metric capabilities list

機能を一覧表示します。

使用方法

openstack metric capabilities list [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]

表52.74 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表52.75 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.76 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.77 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.78 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.16. metric create

メトリクスを作成します。

使用方法

openstack metric create [-h] [--resource-id RESOURCE_ID]
                               [-f {json,shell,table,value,yaml}] [-c COLUMN]
                               [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               [--archive-policy-name ARCHIVE_POLICY_NAME]
                               [--unit UNIT]
                               [METRIC_NAME]

表52.79 位置引数

概要

METRIC_NAME

メトリクスの名前

表52.80 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

アーカイブポリシーの名前

--unit UNIT, -u UNIT

メトリクスの単位

表52.81 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.82 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.83 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.84 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.17. metric delete

メトリクスを削除します。

使用方法

openstack metric delete [-h] [--resource-id RESOURCE_ID]
                               metric [metric ...]

表52.85 位置引数

概要

metric

メトリクスの ID または名前

表52.86 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

52.18. metric list

メトリクスを一覧表示します。

使用方法

openstack metric list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--limit <LIMIT>]
                             [--marker <MARKER>] [--sort <SORT>]

表52.87 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <LIMIT>

返すメトリクスの数(デフォルトはサーバーのデフォルトです)

--marker <MARKER>

前の一覧の最後のアイテム。この値の後に来る結果を返します。

--sort <SORT>

メトリクス属性のソート(例:user_id:desc- nullslast)

表52.88 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表52.89 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表52.90 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.91 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.19. metric measures add

計測値をメトリクスに追加します。

使用方法

openstack metric measures add [-h] [--resource-id RESOURCE_ID] -m
                                     MEASURE
                                     metric

表52.92 位置引数

概要

metric

メトリクスの ID または名前

表52.93 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

-m MEASURE、--measure MEASURE

@で区切った計測のタイムスタンプおよび値

52.20. metric measures aggregation

集約されたメトリクスの計測値を取得します。

使用方法

openstack metric measures aggregation [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--noindent]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--sort-column SORT_COLUMN]
                                             [--utc] -m METRIC [METRIC ...]
                                             [--aggregation AGGREGATION]
                                             [--reaggregation REAGGREGATION]
                                             [--start START] [--stop STOP]
                                             [--granularity GRANULARITY]
                                             [--needed-overlap NEEDED_OVERLAP]
                                             [--query QUERY]
                                             [--resource-type RESOURCE_TYPE]
                                             [--groupby GROUPBY] [--refresh]
                                             [--resample RESAMPLE]
                                             [--fill FILL]

表52.94 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--utc

タイムスタンプを utc として返します。

-m METRIC [METRIC …​], --metric METRIC [METRIC …​]

メトリクス ID またはメトリクス名

--aggregation AGGREGATION

取得する粒度集約機能

--reaggregation REAGGREGATION

取得する groupBy 集約機能

--start START

期間の開始

--stop STOP

期間の終了

--granularity GRANULARITY

取得する際の詳細度

--needed-overlap NEEDED_OVERLAP

要求される各メトリクスのデータポイントの割合(パーセント)

--query QUERY

リソースをフィルターするクエリー。構文は、属性、演算子、および値の組み合わせです。たとえば、id=90d58eea-70d7-4294-a49a-170dcdf44c3c は特定の ID でリソースをフィルターします。より複雑なクエリーを構築することができます(例:not (flavor_id!="1" and memory>=24))。"" を使用して、データを文字列として解釈するように強制します。サポートされる演算子は not、and、∧、or、∨、>=、⇐、!=、>、<、=、==、eq、ne、lt、gt、ge、le、in、like、≠、≥、≤、like、in です。

--resource-type RESOURCE_TYPE

問い合わせるリソースタイプ

--groupby GROUPBY

リソースをグループ化するために使用する属性

--refresh

すべての既知の計測値を強制的に集計します。

--resample RESMYBACKUPDIRLE

時系列を再サンプリングする粒度(秒単位)

--fill FILL

シリーズのサブセットに値がない状態でタイムスタンプをバックフィルする際に使用する値。値は浮動小数点または null である必要があります。

表52.95 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表52.96 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表52.97 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.98 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.21. metric measures batch-metrics

使用方法

openstack metric measures batch-metrics [-h] file

表52.99 位置引数

概要

file

バッチ処理またはstdinの測定値が含まれるファイル(形式は Gnocchi REST API のドキュメントを参照してください)。

表52.100 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

52.22. metric measures batch-resources-metrics

使用方法

openstack metric measures batch-resources-metrics [-h]
                                                         [--create-metrics]
                                                         file

表52.101 位置引数

概要

file

バッチ処理またはstdinの測定値が含まれるファイル(形式は Gnocchi REST API のドキュメントを参照してください)。

表52.102 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--create-metrics

不明なメトリクスを作成します。

52.23. metric measures show

メトリクスの測定値を取得します。

使用方法

openstack metric measures show [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN] [--utc]
                                      [--resource-id RESOURCE_ID]
                                      [--aggregation AGGREGATION]
                                      [--start START] [--stop STOP]
                                      [--granularity GRANULARITY] [--refresh]
                                      [--resample RESAMPLE]
                                      metric

表52.103 位置引数

概要

metric

メトリクスの ID または名前

表52.104 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--utc

タイムスタンプを utc として返します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--aggregation AGGREGATION

取得する集約

--start START

期間の開始

--stop STOP

期間の終了

--granularity GRANULARITY

取得する際の詳細度

--refresh

すべての既知の計測値を強制的に集計します。

--resample RESMYBACKUPDIRLE

時系列を再サンプリングする粒度(秒単位)

表52.105 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表52.106 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表52.107 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.108 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.24. metric metric create

非推奨:メトリクスを作成します。

使用方法

openstack metric metric create [-h] [--resource-id RESOURCE_ID]
                                      [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--archive-policy-name ARCHIVE_POLICY_NAME]
                                      [--unit UNIT]
                                      [METRIC_NAME]

表52.109 位置引数

概要

METRIC_NAME

メトリクスの名前

表52.110 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

アーカイブポリシーの名前

--unit UNIT, -u UNIT

メトリクスの単位

表52.111 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.112 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.113 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.114 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.25. metric metric delete

非推奨:メトリクスを削除します。

使用方法

openstack metric metric delete [-h] [--resource-id RESOURCE_ID]
                                      metric [metric ...]

表52.115 位置引数

概要

metric

メトリクスの ID または名前

表52.116 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

52.26. metric metric list

非推奨:メトリクスを一覧表示します。

使用方法

openstack metric metric list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--limit <LIMIT>] [--marker <MARKER>]
                                    [--sort <SORT>]

表52.117 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <LIMIT>

返すメトリクスの数(デフォルトはサーバーのデフォルトです)

--marker <MARKER>

前の一覧の最後のアイテム。この値の後に来る結果を返します。

--sort <SORT>

メトリクス属性のソート(例:user_id:desc- nullslast)

表52.118 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表52.119 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表52.120 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.121 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.27. metric metric show

非推奨:メトリクスを表示します。

使用方法

openstack metric metric show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    [--resource-id RESOURCE_ID]
                                    metric

表52.122 位置引数

概要

metric

メトリクスの ID または名前

表52.123 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

表52.124 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.125 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.126 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.127 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.28. metric resource batch delete

属性値に基づいてリソースのバッチを削除します。

使用方法

openstack metric resource batch delete [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--type RESOURCE_TYPE]
                                              query

表52.128 位置引数

概要

query

リソースをフィルターするクエリー。構文は、属性、演算子、および値の組み合わせです。たとえば、id=90d58eea-70d7-4294-a49a-170dcdf44c3c は特定の ID でリソースをフィルターします。より複雑なクエリーを構築することができます(例:not (flavor_id!="1" and memory>=24))。"" を使用して、データを文字列として解釈するように強制します。サポートされる演算子は not、and、∧、or、∨、>=、⇐、!=、>、<、=、==、eq、ne、lt、gt、ge、le、in、like、≠、≥、≤、like、in です。

表52.129 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

表52.130 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.131 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.132 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.133 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.29. metric resource create

リソースを作成します。

使用方法

openstack metric resource create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--type RESOURCE_TYPE]
                                        [-a ATTRIBUTE] [-m ADD_METRIC]
                                        [-n CREATE_METRIC]
                                        resource_id

表52.134 位置引数

概要

resource_id

リソースの ID

表52.135 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

-a MYBACKUPDIR、--attribute MYBACKUPDIR

:で区切った属性の名前および値

-m ADD_METRIC, --add-metric ADD_METRIC

追加するメトリクスのName:id

-n CREATE_METRIC, --create-metric CREATE_METRIC

作成するメトリックの Name:archive_policy_name

表52.136 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.137 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.138 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.139 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.30. metric resource delete

リソースを削除します。

使用方法

openstack metric resource delete [-h] resource_id

表52.140 位置引数

概要

resource_id

リソースの ID

表52.141 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

52.31. metric resource history

リソースの履歴を表示します。

使用方法

openstack metric resource history [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]
                                         [--details] [--limit <LIMIT>]
                                         [--marker <MARKER>] [--sort <SORT>]
                                         [--type RESOURCE_TYPE]
                                         resource_id

表52.142 位置引数

概要

resource_id

リソースの ID

表52.143 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--details

汎用リソースの属性をすべて表示します。

--limit <LIMIT>

返すリソースの数(デフォルトはサーバーのデフォルトです)。

--marker <MARKER>

前の一覧の最後のアイテム。この値の後に来る結果を返します。

--sort <SORT>

リソース属性のソート(例:user_id:desc- nullslast)

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

表52.144 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表52.145 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表52.146 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.147 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.32. metric resource list

リソースを一覧表示します。

使用方法

openstack metric resource list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN] [--details]
                                      [--history] [--limit <LIMIT>]
                                      [--marker <MARKER>] [--sort <SORT>]
                                      [--type RESOURCE_TYPE]

表52.148 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--details

汎用リソースの属性をすべて表示します。

--history

リソースの履歴を表示します。

--limit <LIMIT>

返すリソースの数(デフォルトはサーバーのデフォルトです)。

--marker <MARKER>

前の一覧の最後のアイテム。この値の後に来る結果を返します。

--sort <SORT>

リソース属性のソート(例:user_id:desc- nullslast)

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

表52.149 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表52.150 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表52.151 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.152 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.34. metric resource show

リソースを表示します。

使用方法

openstack metric resource show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--type RESOURCE_TYPE]
                                      resource_id

表52.159 位置引数

概要

resource_id

リソースの ID

表52.160 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

表52.161 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.162 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.163 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.164 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.35. metric resource-type create

リソース種別を作成します。

使用方法

openstack metric resource-type create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [-a ATTRIBUTE]
                                             name

表52.165 位置引数

概要

name

リソース種別の名前

表52.166 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-a MYBACKUPDIR、--attribute MYBACKUPDIR

属性定義、attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:…​ 例: display_name:string:true:max_length=255

表52.167 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.168 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.169 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.170 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.36. metric resource-type delete

リソース種別を削除します。

使用方法

openstack metric resource-type delete [-h] name

表52.171 位置引数

概要

name

リソース種別の名前

表52.172 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

52.37. metric resource-type list

リソース種別を一覧表示します。

使用方法

openstack metric resource-type list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]

表52.173 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表52.174 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表52.175 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表52.176 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.177 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.38. metric resource-type show

リソース種別を表示します。

使用方法

openstack metric resource-type show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           name

表52.178 位置引数

概要

name

リソース種別の名前

表52.179 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表52.180 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.181 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.182 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.183 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.39. metric resource-type update

リソース種別を作成します。

使用方法

openstack metric resource-type update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [-a ATTRIBUTE]
                                             [-r REMOVE_ATTRIBUTE]
                                             name

表52.184 位置引数

概要

name

リソース種別の名前

表52.185 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-a MYBACKUPDIR、--attribute MYBACKUPDIR

属性定義、attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:…​ 例: display_name:string:true:max_length=255

-r REMOVE_ATTRIBUTE, --remove-attribute REMOVE_ATTRIBUTE

属性名

表52.186 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.187 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.188 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.189 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.40. metric resource update

リソースを更新します。

使用方法

openstack metric resource update [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--type RESOURCE_TYPE]
                                        [-a ATTRIBUTE] [-m ADD_METRIC]
                                        [-n CREATE_METRIC] [-d DELETE_METRIC]
                                        resource_id

表52.190 位置引数

概要

resource_id

リソースの ID

表52.191 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

-a MYBACKUPDIR、--attribute MYBACKUPDIR

:で区切った属性の名前および値

-m ADD_METRIC, --add-metric ADD_METRIC

追加するメトリクスのName:id

-n CREATE_METRIC, --create-metric CREATE_METRIC

作成するメトリックの Name:archive_policy_name

-d DELETE_METRIC, --delete-metric DELETE_METRIC

削除するメトリクスの名前

表52.192 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.193 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.194 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.195 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.41. metric server version

Gnocchi サーバーのバージョンを表示します。

使用方法

openstack metric server version [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]

表52.196 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表52.197 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.198 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.199 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.200 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.42. metric show

メトリクスを表示します。

使用方法

openstack metric show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--resource-id RESOURCE_ID]
                             metric

表52.201 位置引数

概要

metric

メトリクスの ID または名前

表52.202 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

表52.203 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.204 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.205 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.206 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

52.43. metric status

測定値処理のステータスを表示します。

使用方法

openstack metric status [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]

表52.207 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表52.208 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表52.209 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表52.210 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表52.211 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第53章 module

本章では、module コマンドに含まれるコマンドについて説明します。

53.1. module list

モジュールのバージョンを一覧表示します。

使用方法

openstack module list [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--all]

表53.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all

バージョン情報を持つモジュールをすべて表示します。

表53.2 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表53.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表53.4 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表53.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第54章 network

本章では、network コマンドに含まれるコマンドについて説明します。

54.1. network agent add network

エージェントにネットワークを追加します。

使用方法

openstack network agent add network [-h] [--dhcp] <agent-id> <network>

表54.1 位置引数

概要

<agent-id>

ネットワークが追加されるエージェント(id のみ)

<network>

エージェントに追加されるネットワーク(名前または ID)

表54.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--dhcp

dhcp エージェントにネットワークを追加します。

54.2. network agent add router

エージェントにルーターを追加します。

使用方法

openstack network agent add router [-h] [--l3] <agent-id> <router>

表54.3 位置引数

概要

<agent-id>

ルーターが追加されるエージェント(id のみ)

<router>

エージェントに追加されるルーター(名前または ID)

表54.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--l3

ルーターを l3 エージェントに追加します。

54.3. network agent delete

ネットワークエージェントを削除します。

使用方法

openstack network agent delete [-h]
                                      <network-agent> [<network-agent> ...]

表54.5 位置引数

概要

<network-agent>

削除するネットワークエージェント(id のみ)

表54.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.4. network agent list

ネットワークエージェントの一覧を表示します。

使用方法

openstack network agent list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--agent-type <agent-type>]
                                    [--host <host>]
                                    [--network <network> | --router <router>]
                                    [--long]

表54.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--agent-type <agent-type>

指定したエージェントタイプのエージェントのみを一覧表示します。サポートされるエージェントタイプは、bgp、dhcp、open-vswitch、linux-bridge、ofa、l3、loadbalancer、metering、metadata、macvtap、nic です。

--host <host>

指定されたホストで実行されているエージェントのみを一覧表示します。

--network <network>

ネットワークをホストするエージェント(名前または ID)を一覧表示します。

--router <router>

このルーターをホストするエージェントを一覧表示します(名前または ID)。

--long

出力の追加フィールドを一覧表示します。

表54.8 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.9 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.10 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.11 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.5. network agent remove network

エージェントからネットワークを削除します。

使用方法

openstack network agent remove network [-h] [--dhcp]
                                              <agent-id> <network>

表54.12 位置引数

概要

<agent-id>

ネットワークを削除するエージェント(id のみ)

<network>

エージェントから削除されるネットワーク(名前または ID)

表54.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--dhcp

dhcp エージェントからネットワークを削除します。

54.6. network agent remove router

エージェントからルーターを削除します。

使用方法

openstack network agent remove router [-h] [--l3] <agent-id> <router>

表54.14 位置引数

概要

<agent-id>

ルーターを削除するエージェント(id のみ)

<router>

エージェントから削除されるルーター(名前または ID)

表54.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--l3

l3 エージェントからルーターを削除します。

54.7. network agent set

ネットワークエージェントの属性を設定します。

使用方法

openstack network agent set [-h] [--description <description>]
                                   [--enable | --disable]
                                   <network-agent>

表54.16 位置引数

概要

<network-agent>

変更するネットワークエージェント(id のみ)

表54.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ネットワークエージェントの説明を設定します。

--enable

ネットワークエージェントを有効にします。

--disable

ネットワークエージェントを無効にします。

54.8. network agent show

ネットワークエージェントの詳細を表示します。

使用方法

openstack network agent show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <network-agent>

表54.18 位置引数

概要

<network-agent>

表示するネットワークエージェント(id のみ)

表54.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.20 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.21 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.22 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.23 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.9. network auto allocated topology create

プロジェクトの自動割り当てトポロジーを作成します。

使用方法

openstack network auto allocated topology create [-h]
                                                        [-f {json,shell,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--noindent]
                                                        [--prefix PREFIX]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]
                                                        [--check-resources]
                                                        [--or-show]

表54.24 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

指定されたプロジェクトに対して自動的に割り当てられたトポロジーを返します。デフォルトは現在のプロジェクトです。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--check-resources

自動割り当てトポロジーの要件を検証します。トポロジーを返しません。

--or-show

トポロジーが存在する場合は、トポロジーの情報を返します(デフォルト)。

表54.25 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.26 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.27 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.28 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.10. network auto allocated topology delete

プロジェクトの自動割り当てトポロジーを削除します。

使用方法

openstack network auto allocated topology delete [-h]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]

表54.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

特定のプロジェクトに対して自動的に割り当てられたトポロジーを削除します。デフォルトは現在のプロジェクトです。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

54.11. network create

新規ネットワークを作成します。

使用方法

openstack network create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--share | --no-share]
                                [--enable | --disable] [--project <project>]
                                [--description <description>] [--mtu <mtu>]
                                [--project-domain <project-domain>]
                                [--availability-zone-hint <availability-zone>]
                                [--enable-port-security | --disable-port-security]
                                [--external | --internal]
                                [--default | --no-default]
                                [--qos-policy <qos-policy>]
                                [--transparent-vlan | --no-transparent-vlan]
                                [--provider-network-type <provider-network-type>]
                                [--provider-physical-network <provider-physical-network>]
                                [--provider-segment <provider-segment>]
                                [--dns-domain <dns-domain>]
                                [--tag <tag> | --no-tag]
                                <name>

表54.30 位置引数

概要

<name>

新しいネットワーク名

表54.31 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--share

プロジェクト間でネットワークを共有します。

--no-share

プロジェクト間でネットワークを共有しません。

--enable

ネットワークを有効にします(デフォルト)。

--disable

ネットワークを無効にします。

--project <project>

所有者のプロジェクト(名前または ID)

--description <description>

ネットワークの説明を設定します。

--mtu <mtu>

ネットワークのmtuを設定します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--availability-zone-hint <availability-zone>

このネットワークを作成するアベイラビリティーゾーン(Network Availability Zone 拡張機能が必要、複数のアベイラビリティーゾーンに設定するにはオプションを繰り返します)

--enable-port-security

このネットワークで作成されたポートで、デフォルトでポートセキュリティーを有効にします(デフォルト)。

--disable-port-security

このネットワークで作成されたポートで、デフォルトでポートセキュリティーを無効にします。

--external

このネットワークを外部ネットワークとして設定します(external-net 拡張機能が必要)

--internal

このネットワークを内部ネットワークとして設定します(デフォルト)。

--default

このネットワークをデフォルトの外部ネットワークとして使用するかどうかを指定します。

--no-default

ネットワークをデフォルトの外部ネットワークとして使用しません(デフォルト)。

--qos-policy <qos-policy>

このネットワークにアタッチする QoS ポリシー(名前または ID)

--transparent-vlan

ネットワーク vlan を透過的にします。

--no-transparent-vlan

ネットワーク vlan を透過的にしません。

--provider-network-type <provider-network-type>

仮想ネットワークが実装される物理メカニズム。例:flat、geneve、gre、local、vlan、vxlan

--provider-physical-network <provider-physical-network>

仮想ネットワークが実装される物理ネットワークの名前

--provider-segment <provider-segment>

vlan ネットワークの VLAN id、または GENEVE/GRE/VXLAN ネットワークのトンネル ID

--dns-domain <dns-domain>

このネットワークに dns ドメインを設定します(dns 統合拡張が必要です)。

--tag <tag>

ネットワークに追加するタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

ネットワークにタグを関連付けません。

表54.32 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.33 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.34 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.35 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.12. network delete

ネットワークを削除します。

使用方法

openstack network delete [-h] <network> [<network> ...]

表54.36 位置引数

概要

<network>

削除するネットワーク(名前または ID)

表54.37 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.13. network flavor add profile

サービスプロファイルをネットワークフレーバーに追加します。

使用方法

openstack network flavor add profile [-h] <flavor> <service-profile>

表54.38 位置引数

概要

<flavor>

ネットワークフレーバー(名前または ID)

<service-profile>

サービスプロファイル(id のみ)

表54.39 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.14. network flavor create

新規ネットワークフレーバーを作成します。

使用方法

openstack network flavor create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] --service-type
                                       <service-type>
                                       [--description DESCRIPTION]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       [--enable | --disable]
                                       <name>

表54.40 位置引数

概要

<name>

フレーバーの名前

表54.41 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--service-type <service-type>

フレーバーを適用するサービス種別 (例:vpn)。ロードされた例は openstack network service provider list を参照してください。

--description DESCRIPTION

フレーバーの説明

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--enable

フレーバーを有効にします(デフォルト)。

--disable

フレーバーを無効にします。

表54.42 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.43 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.44 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.45 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.15. network flavor delete

ネットワークフレーバーを削除します。

使用方法

openstack network flavor delete [-h] <flavor> [<flavor> ...]

表54.46 位置引数

概要

<flavor>

削除するフレーバー(名前または ID)

表54.47 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.16. network flavor list

ネットワークフレーバーを一覧表示します。

使用方法

openstack network flavor list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]

表54.48 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.49 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.50 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.51 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.52 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.17. network flavor profile create

新規ネットワークフレーバープロファイルを作成します。

使用方法

openstack network flavor profile create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--project <project>]
                                               [--project-domain <project-domain>]
                                               [--description <description>]
                                               [--enable | --disable]
                                               [--driver DRIVER]
                                               [--metainfo METAINFO]

表54.53 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--description <description>

フレーバープロファイルの説明

--enable

フレーバープロファイルを有効にします。

--disable

フレーバープロファイルを無効にします。

--driver DRIVER

ドライバーへの Python モジュールパス。これは、--metainfo がない場合は必須です (逆の場合も同様)。

--metainfo METAINFO

フレーバープロファイルの metainfo。これは、--driver がない場合は必須です (逆の場合も同様)。

表54.54 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.55 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.56 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.57 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.18. network flavor profile delete

ネットワークフレーバープロファイルを削除します。

使用方法

openstack network flavor profile delete [-h]
                                               <flavor-profile>
                                               [<flavor-profile> ...]

表54.58 位置引数

概要

<flavor-profile>

削除するフレーバープロファイル(id のみ)

表54.59 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.19. network flavor profile list

ネットワークフレーバープロファイルを一覧表示します。

使用方法

openstack network flavor profile list [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--noindent]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--sort-column SORT_COLUMN]

表54.60 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.61 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.62 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.63 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.64 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.20. network flavor profile set

ネットワークフレーバープロファイル属性を設定します。

使用方法

openstack network flavor profile set [-h]
                                            [--project-domain <project-domain>]
                                            [--description <description>]
                                            [--enable | --disable]
                                            [--driver DRIVER]
                                            [--metainfo METAINFO]
                                            <flavor-profile>

表54.65 位置引数

概要

<flavor-profile>

更新するフレーバープロファイル(id のみ)

表54.66 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--description <description>

フレーバープロファイルの説明

--enable

フレーバープロファイルを有効にします。

--disable

フレーバープロファイルを無効にします。

--driver DRIVER

ドライバーへの Python モジュールパス。これは、--metainfo がない場合は必須です (逆の場合も同様)。

--metainfo METAINFO

フレーバープロファイルの metainfo。これは、--driver がない場合は必須です (逆の場合も同様)。

54.21. network flavor profile show

ネットワークフレーバープロファイルの詳細を表示します。

使用方法

openstack network flavor profile show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <flavor-profile>

表54.67 位置引数

概要

<flavor-profile>

表示するフレーバープロファイル(id のみ)

表54.68 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.69 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.70 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.71 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.72 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.22. network flavor remove profile

ネットワークフレーバーからサービスプロファイルを削除します。

使用方法

openstack network flavor remove profile [-h] <flavor> <service-profile>

表54.73 位置引数

概要

<flavor>

ネットワークフレーバー(名前または ID)

<service-profile>

サービスプロファイル(id のみ)

表54.74 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.23. network flavor set

ネットワークフレーバー属性を設定します。

使用方法

openstack network flavor set [-h] [--description DESCRIPTION]
                                    [--disable | --enable] [--name <name>]
                                    <flavor>

表54.75 位置引数

概要

<flavor>

更新するフレーバー(名前または ID)

表54.76 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description DESCRIPTION

ネットワークフレーバーの説明を設定します。

--disable

ネットワークフレーバーを無効にします。

--enable

ネットワークフレーバーを有効にします。

--name <name>

フレーバー名を設定します。

54.24. network flavor show

ネットワークフレーバーの詳細を表示します。

使用方法

openstack network flavor show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <flavor>

表54.77 位置引数

概要

<flavor>

表示するフレーバー(名前または ID)

表54.78 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.79 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.80 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.81 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.82 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.25. network list

ネットワークを一覧表示します。

使用方法

openstack network list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN]
                              [--external | --internal] [--long]
                              [--name <name>] [--enable | --disable]
                              [--project <project>]
                              [--project-domain <project-domain>]
                              [--share | --no-share] [--status <status>]
                              [--provider-network-type <provider-network-type>]
                              [--provider-physical-network <provider-physical-network>]
                              [--provider-segment <provider-segment>]
                              [--agent <agent-id>] [--tags <tag>[,<tag>,...]]
                              [--any-tags <tag>[,<tag>,...]]
                              [--not-tags <tag>[,<tag>,...]]
                              [--not-any-tags <tag>[,<tag>,...]]

表54.83 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--external

外部ネットワークを一覧表示します。

--internal

内部ネットワークを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--name <name>

名前に従ってネットワークを一覧表示します。

--enable

有効なネットワークの一覧を表示します。

--disable

無効なネットワークの一覧を表示します。

--project <project>

プロジェクトに従ってネットワークを一覧表示します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--share

プロジェクト間で共有されるネットワークを一覧表示します。

--no-share

プロジェクト間で共有されていないネットワークの一覧を表示します。

--status <status>

ステータス(activeBUILDDOWNERROR)に従ってネットワークを一覧表示します。

--provider-network-type <provider-network-type>

物理メカニズムに従ってネットワークを一覧表示します。サポートされているオプションは flat、geneve、gre、local、vlan、vxlan です。

--provider-physical-network <provider-physical-network>

物理ネットワークの名前に従ってネットワークを一覧表示します。

--provider-segment <provider-segment>

vlan ネットワークの vlan id か、GENEVE/GRE/VXLAN ネットワークの Tunnel ID に従ってネットワークを一覧表示します。

--agent <agent-id>

エージェントがホストするネットワークの一覧を表示します(id のみ)。

--tags <tag>[,<tag>,…​]

指定したすべてのタグ(タグのコンマ区切りリスト)が設定されたネットワークを一覧表示します。

--any-tags <tag>[,<tag>,…​]

指定したタグ(タグのコンマ区切りリスト)のいずれかが設定されたネットワークを一覧表示します。

--not-tags <tag>[,<tag>,…​]

指定したすべてのタグ(タグのコンマ区切りリスト)が設定されたネットワークを除外します。

--not-any-tags <tag>[,<tag>,…​]

指定したタグ(タグのコンマ区切りリスト)のいずれかが設定されたネットワークを除外します。

表54.84 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.85 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.86 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.87 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.26. network log create

新規ネットワークログを作成指定します。

使用方法

openstack network log create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    [--description <description>]
                                    [--enable | --disable]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--event {ALL,ACCEPT,DROP}]
                                    --resource-type <resource-type>
                                    [--resource <resource>]
                                    [--target <target>]
                                    <name>

表54.88 位置引数

概要

<name>

ネットワークログの名前

表54.89 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ネットワークログの説明

--enable

このログを有効にします(デフォルトは無効)。

--disable

このログを無効にします。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--event {ALL,ACCEPT,DROP}

ログと共に保存するイベント

--resource-type <resource-type>

ネットワークログのタイプ。サポートされる種別は、$ openstack network loggable resources list で確認することができます。

--resource <resource>

ロギングに使用されるリソース(セキュリティーグループまたはファイアウォールグループ)の名前または ID--target オプションを使用して、ロギングターゲットの組み合わせを制御できます。

--target <target>

ロギング用のポート(名前または ID)。ロギングターゲットの組み合わせは、--resource オプションで制御できます。

表54.90 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.91 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.92 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.93 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.27. network log delete

ネットワークログを削除します。

使用方法

openstack network log delete [-h] <network-log> [<network-log> ...]

表54.94 位置引数

概要

<network-log>

削除するネットワークログ(名前または ID)

表54.95 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.28. network log list

ネットワークログを一覧表示します。

使用方法

openstack network log list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN] [--long]

表54.96 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

表54.97 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.98 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.99 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.100 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.29. network log set

ネットワークログの属性を設定します。

使用方法

openstack network log set [-h] [--description <description>]
                                 [--enable | --disable] [--name <name>]
                                 <network-log>

表54.101 位置引数

概要

<network-log>

設定するネットワークログ(名前または ID)

表54.102 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ネットワークログの説明

--enable

このログを有効にします(デフォルトは無効)。

--disable

このログを無効にします。

--name <name>

ネットワークログの名前

54.30. network log show

ネットワークログの詳細を表示します。

使用方法

openstack network log show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <network-log>

表54.103 位置引数

概要

<network-log>

表示するネットワークログ(名前または ID)

表54.104 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.105 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.106 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.107 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.108 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.31. network loggable resources list

サポートされるログ可能なリソースを一覧表示します。

使用方法

openstack network loggable resources list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]
                                                 [--long]

表54.109 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

表54.110 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.111 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.112 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.113 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.32. network meter create

ネットワークメーターを作成します。

使用方法

openstack network meter create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--description <description>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--share | --no-share]
                                      <name>

表54.114 位置引数

概要

<name>

メーターの名前

表54.115 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

メーターの説明を作成します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--share

プロジェクト間でメーターを共有します。

--no-share

プロジェクト間でメーターを共有しません。

表54.116 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.117 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.118 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.119 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.33. network meter delete

ネットワークメーターを削除します。

使用方法

openstack network meter delete [-h] <meter> [<meter> ...]

表54.120 位置引数

概要

<meter>

削除するメーター(名前または ID)

表54.121 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.34. network meter list

ネットワークメーターを一覧表示します。

使用方法

openstack network meter list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]

表54.122 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.123 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.124 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.125 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.126 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.35. network meter rule create

新しいメータールールを作成します。

使用方法

openstack network meter rule create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--project <project>]
                                           [--project-domain <project-domain>]
                                           [--exclude | --include]
                                           [--ingress | --egress]
                                           --remote-ip-prefix
                                           <remote-ip-prefix>
                                           <meter>

表54.127 位置引数

概要

<meter>

このメータリングルールに関連付けるラベル(名前または ID)

表54.128 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--exclude

トラフィック数からリモート ip プレフィックスを除外します。

--include

トラフィック数にリモート ip プレフィックスを含めます(デフォルト)。

--ingress

受信ネットワークトラフィックにルールを適用します(デフォルト)。

--egress

発信ネットワークトラフィックにルールを適用します。

--remote-ip-prefix <remote-ip-prefix>

このルールに関連付けるリモート IP プレフィックス

表54.129 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.130 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.131 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.132 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.36. network meter rule delete

メータールールを削除します。

使用方法

openstack network meter rule delete [-h]
                                           <meter-rule-id>
                                           [<meter-rule-id> ...]

表54.133 位置引数

概要

<meter-rule-id>

削除するメータールール(id のみ)

表54.134 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.37. network meter rule list

メータールールを一覧表示します。

使用方法

openstack network meter rule list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]

表54.135 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.136 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.137 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.138 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.139 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.38. network meter rule show

メータールールの詳細を表示削除します。

使用方法

openstack network meter rule show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <meter-rule-id>

表54.140 位置引数

概要

<meter-rule-id>

メータールール(id のみ)

表54.141 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.142 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.143 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.144 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.145 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.39. network meter show

ネットワークメーターを表示します。

使用方法

openstack network meter show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <meter>

表54.146 位置引数

概要

<meter>

表示するメーター(名前または ID)

表54.147 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.148 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.149 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.150 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.151 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.40. network onboard subnets

サブネットプールにネットワークサブネットをオンボードします。

使用方法

openstack network onboard subnets [-h] <network> <subnetpool>

表54.152 位置引数

概要

<network>

このネットワークに関連付けられた全サブネットをオンボードします。

<subnetpool>

サブネットをオンボーディングするターゲットサブネットプール

表54.153 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.41. network qos policy create

QoS ポリシーを作成します。

使用方法

openstack network qos policy create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--description <description>]
                                           [--share | --no-share]
                                           [--project <project>]
                                           [--project-domain <project-domain>]
                                           [--default | --no-default]
                                           <name>

表54.154 位置引数

概要

<name>

作成する qos ポリシーの名前

表54.155 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

qos ポリシーの説明

--share

他のプロジェクトから qos ポリシーにアクセスできるようにします。

--no-share

他のプロジェクトから qos ポリシーにアクセスできないようにします(デフォルト)。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--default

これをデフォルトのネットワーク qos ポリシーとして設定します。

--no-default

これをデフォルト以外のネットワーク qos ポリシーとして設定します。

表54.156 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.157 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.158 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.159 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.42. network qos policy delete

Qos ポリシーを削除します。

使用方法

openstack network qos policy delete [-h]
                                           <qos-policy> [<qos-policy> ...]

表54.160 位置引数

概要

<qos-policy>

削除する QoS ポリシー(名前または ID)

表54.161 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.43. network qos policy list

QoS ポリシーを一覧表示します。

使用方法

openstack network qos policy list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]
                                         [--project <project>]
                                         [--project-domain <project-domain>]
                                         [--share | --no-share]

表54.162 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

プロジェクトに従ってqosポリシーを一覧表示します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--share

プロジェクト間で共有されるQoS ポリシーを一覧表示します。

--no-share

プロジェクト間で共有されない qos ポリシーを一覧表示します。

表54.163 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.164 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.165 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.166 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.44. network qos policy set

QoS ポリシー属性を設定します。

使用方法

openstack network qos policy set [-h] [--name <name>]
                                        [--description <description>]
                                        [--share | --no-share]
                                        [--default | --no-default]
                                        <qos-policy>

表54.167 位置引数

概要

<qos-policy>

変更する QoS ポリシー(名前または ID)

表54.168 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

qos ポリシー名を設定します。

--description <description>

qos ポリシーの説明

--share

他のプロジェクトから qos ポリシーにアクセスできるようにします。

--no-share

他のプロジェクトから qos ポリシーにアクセスできないようにします。

--default

これをデフォルトのネットワーク qos ポリシーとして設定します。

--no-default

これをデフォルト以外のネットワーク qos ポリシーとして設定します。

54.45. network qos policy show

QoS ポリシーの詳細を表示します。

使用方法

openstack network qos policy show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <qos-policy>

表54.169 位置引数

概要

<qos-policy>

表示する QoS ポリシー(名前または ID)

表54.170 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.171 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.172 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.173 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.174 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.46. network qos rule create

新規 Network QoS ルールを作成します。

使用方法

openstack network qos rule create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty] [--type <type>]
                                         [--max-kbps <max-kbps>]
                                         [--max-burst-kbits <max-burst-kbits>]
                                         [--dscp-mark <dscp-mark>]
                                         [--min-kbps <min-kbps>]
                                         [--ingress | --egress]
                                         <qos-policy>

表54.175 位置引数

概要

<qos-policy>

ルールが含まれる QoS ポリシー(名前または id)

表54.176 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--type <type>

QoS ルールタイプ(minimum-bandwidth、dscp-marking、bandwidth-limit)

--max-kbps <max-kbps>

最大帯域幅(kbps)

--max-burst-kbits <max-burst-kbits>

キロビット単位の最大バースト。0 または指定しない場合は帯域幅の制限の 80% で、通常の TCP トラフィックで機能します。詳細は、QoS ユーザーワークフローを確認します。

--dscp-mark <dscp-mark>

DSCP mark: 値 は 0、8 - 56 の偶数を指定できます(42、44、50、52、および 54 を除く)。

--min-kbps <min-kbps>

確保される最小帯域幅(kbps単位)

--ingress

プロジェクト視点からの受信トラフィックの方向

--egress

プロジェクト視点からの送信トラフィックの方向

表54.177 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.178 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.179 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.180 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.47. network qos rule delete

ネットワーク QoS ルールを削除します。

使用方法

openstack network qos rule delete [-h] <qos-policy> <rule-id>

表54.181 位置引数

概要

<qos-policy>

ルールが含まれる QoS ポリシー(名前または id)

<rule-id>

削除するネットワーク qos ルール(id)

表54.182 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.48. network qos rule list

ネットワーク QoS ルールを一覧表示します。

使用方法

openstack network qos rule list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       <qos-policy>

表54.183 位置引数

概要

<qos-policy>

ルールが含まれる QoS ポリシー(名前または id)

表54.184 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.185 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.186 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.187 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.188 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.49. network qos rule set

ネットワーク QoS ルール属性を設定します。

使用方法

openstack network qos rule set [-h] [--max-kbps <max-kbps>]
                                      [--max-burst-kbits <max-burst-kbits>]
                                      [--dscp-mark <dscp-mark>]
                                      [--min-kbps <min-kbps>]
                                      [--ingress | --egress]
                                      <qos-policy> <rule-id>

表54.189 位置引数

概要

<qos-policy>

ルールが含まれる QoS ポリシー(名前または id)

<rule-id>

削除するネットワーク qos ルール(id)

表54.190 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--max-kbps <max-kbps>

最大帯域幅(kbps)

--max-burst-kbits <max-burst-kbits>

キロビット単位の最大バースト。0 または指定しない場合は帯域幅の制限の 80% で、通常の TCP トラフィックで機能します。詳細は、QoS ユーザーワークフローを確認します。

--dscp-mark <dscp-mark>

DSCP mark: 値 は 0、8 - 56 の偶数を指定できます(42、44、50、52、および 54 を除く)。

--min-kbps <min-kbps>

確保される最小帯域幅(kbps単位)

--ingress

プロジェクト視点からの受信トラフィックの方向

--egress

プロジェクト視点からの送信トラフィックの方向

54.50. network qos rule show

ネットワーク QoS ルールの詳細を表示します。

使用方法

openstack network qos rule show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <qos-policy> <rule-id>

表54.191 位置引数

概要

<qos-policy>

ルールが含まれる QoS ポリシー(名前または id)

<rule-id>

削除するネットワーク qos ルール(id)

表54.192 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.193 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.194 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.195 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.196 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.51. network qos rule type list

QoS ルール種別の一覧を表示します。

使用方法

openstack network qos rule type list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]

表54.197 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.198 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.199 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.200 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.201 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.52. network qos rule type show

サポート対象の QoS ルール種別の詳細を表示します。

使用方法

openstack network qos rule type show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <qos-rule-type-name>

表54.202 位置引数

概要

<qos-rule-type-name>

qos ルール種別の名前

表54.203 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.204 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.205 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.206 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.207 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.53. network rbac create

ネットワーク RBAC ポリシーを作成します。

使用方法

openstack network rbac create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty] --type
                                     <type> --action <action>
                                     (--target-project <target-project> | --target-all-projects)
                                     [--target-project-domain <target-project-domain>]
                                     [--project <project>]
                                     [--project-domain <project-domain>]
                                     <rbac-object>

表54.208 位置引数

概要

<rbac-object>

この rbac ポリシーが影響を及ぼすオブジェクト(名前または ID)

表54.209 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--type <type>

rbac ポリシーが影響を及ぼすオブジェクトの種別(「security_group」、「qos_policy」または「network」)

--action <action>

rbac ポリシーの動作("access_as_external" または "access_as_shared")

--target-project <target-project>

rbac ポリシーを適用するプロジェクト(名前または ID)

--target-all-projects

すべてのプロジェクトの rbac ポリシーの作成を許可します。

--target-project-domain <target-project-domain>

ターゲットプロジェクトが属するドメイン(名前または id)プロジェクト名の競合が発生した場合に、使用できます。

--project <project>

所有者プロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表54.210 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.211 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.212 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.213 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.54. network rbac delete

ネットワーク RBAC ポリシーを削除します。

使用方法

openstack network rbac delete [-h] <rbac-policy> [<rbac-policy> ...]

表54.214 位置引数

概要

<rbac-policy>

削除する RBAC ポリシー(id のみ)

表54.215 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.55. network rbac list

ネットワーク RBAC ポリシーを一覧表示します。

使用方法

openstack network rbac list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN] [--type <type>]
                                   [--action <action>] [--long]

表54.216 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--type <type>

指定されたオブジェクト種別("security_group"、"qos_policy"、または "network")に従って、ネットワーク rbac ポリシーを一覧表示します。

--action <action>

指定されたアクション("access_as_external" または "access_as_shared")に従って、ネットワーク rbac ポリシーを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

表54.217 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.218 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.219 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.220 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.56. network rbac set

ネットワーク RBAC ポリシー属性を設定します。

使用方法

openstack network rbac set [-h] [--target-project <target-project>]
                                  [--target-project-domain <target-project-domain>]
                                  <rbac-policy>

表54.221 位置引数

概要

<rbac-policy>

変更する RBAC ポリシー(id のみ)

表54.222 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--target-project <target-project>

rbac ポリシーを適用するプロジェクト(名前または ID)

--target-project-domain <target-project-domain>

ターゲットプロジェクトが属するドメイン(名前または id)プロジェクト名の競合が発生した場合に、使用できます。

54.57. network rbac show

ネットワーク RBAC ポリシーの詳細を表示します。

使用方法

openstack network rbac show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <rbac-policy>

表54.223 位置引数

概要

<rbac-policy>

RBAC ポリシー(id のみ)

表54.224 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.225 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.226 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.227 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.228 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.58. network segment create

新規ネットワークセグメントを作成します。

使用方法

openstack network segment create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--description <description>]
                                        [--physical-network <physical-network>]
                                        [--segment <segment>] --network
                                        <network> --network-type
                                        <network-type>
                                        <name>

表54.229 位置引数

概要

<name>

新しいネットワークセグメント名

表54.230 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ネットワークセグメントの説明

--physical-network <physical-network>

このネットワークセグメントの物理ネットワーク名

--segment <segment>

このネットワークセグメントのセグメント識別子。ネットワーク種別、vlan ネットワーク種別の VLAN ID、ならびにgeneve、gre、および vxlan ネットワーク種別のトンネル IDに基づきます。

--network <network>

このネットワークセグメントが属するネットワーク(名前または id)

--network-type <network-type>

このネットワークセグメントのネットワーク種別(flat、geneve、gre、local、vlan、または vxlan)

表54.231 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.232 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.233 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.234 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.59. network segment delete

ネットワークセグメントを削除します。

使用方法

openstack network segment delete [-h]
                                        <network-segment>
                                        [<network-segment> ...]

表54.235 位置引数

概要

<network-segment>

削除するネットワークセグメント(名前または ID)

表54.236 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.60. network segment list

ネットワークセグメントの一覧を表示します。

使用方法

openstack network segment list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN] [--long]
                                      [--network <network>]

表54.237 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--network <network>

このネットワークに属するネットワークセグメントを一覧表示します(名前または ID)。

表54.238 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.239 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.240 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.241 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.61. network segment range create

新規ネットワークセグメントの範囲を作成します。

使用方法

openstack network segment range create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--private | --shared]
                                              [--project <project>]
                                              [--project-domain <project-domain>]
                                              --network-type <network-type>
                                              [--physical-network <physical-network-name>]
                                              --minimum
                                              <minimum-segmentation-id>
                                              --maximum
                                              <maximum-segmentation-id>
                                              <name>

表54.242 位置引数

概要

<name>

新規ネットワークセグメント範囲の名前

表54.243 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--private

ネットワークセグメント範囲は特定のプロジェクトに割り当てられます。

--shared

ネットワークセグメント範囲は他のプロジェクトと共有されます。

--project <project>

ネットワークセグメント範囲の所有者(名前または ID)。セグメント範囲が共有される場合は任意です。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--network-type <network-type>

このネットワークセグメント範囲のネットワーク種別(geneve、gre、vlan、または vxlan)

--physical-network <physical-network-name>

このネットワークセグメント範囲の物理ネットワーク名

--minimum <minimum-segmentation-id>

このネットワークセグメント範囲の最小セグメント識別子。ネットワーク種別、vlan ネットワーク種別の VLAN ID、ならびにgeneve、gre、および vxlan ネットワーク種別のトンネル IDに基づきます。

--maximum <maximum-segmentation-id>

このネットワークセグメント範囲の最大セグメント識別子。ネットワーク種別、vlan ネットワーク種別の VLAN ID、ならびにgeneve、gre、および vxlan ネットワーク種別のトンネル IDに基づきます。

表54.244 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.245 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.246 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.247 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.62. network segment range delete

ネットワークセグメント範囲を削除します。

使用方法

openstack network segment range delete [-h]
                                              <network-segment-range>
                                              [<network-segment-range> ...]

表54.248 位置引数

概要

<network-segment-range>

削除するネットワークセグメント範囲(名前または ID)

表54.249 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.63. network segment range list

ネットワークセグメント範囲を一覧表示します。

使用方法

openstack network segment range list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]
                                            [--long] [--used | --unused]
                                            [--available | --unavailable]

表54.250 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--used

使用中のセグメントを持つネットワークセグメント範囲を一覧表示します。

--unused

セグメントが使用されていないネットワークセグメント範囲を一覧表示します。

--available

利用可能なセグメントがあるネットワークセグメント範囲を一覧表示します。

--unavailable

利用可能なセグメントがないネットワークセグメント範囲を一覧表示します。

表54.251 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.252 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.253 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.254 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.64. network segment range set

ネットワークセグメント範囲の属性を設定します。

使用方法

openstack network segment range set [-h] [--name <name>]
                                           [--minimum <minimum-segmentation-id>]
                                           [--maximum <maximum-segmentation-id>]
                                           <network-segment-range>

表54.255 位置引数

概要

<network-segment-range>

変更するネットワークセグメント範囲(名前または ID)

表54.256 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ネットワークセグメント名を設定します。

--minimum <minimum-segmentation-id>

ネットワークセグメント範囲の最小セグメント識別子を設定します。

--maximum <maximum-segmentation-id>

ネットワークセグメント範囲の最大セグメント識別子を設定します。

54.65. network segment range show

ネットワークセグメント範囲の詳細を表示します。

使用方法

openstack network segment range show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <network-segment-range>

表54.257 位置引数

概要

<network-segment-range>

表示するネットワークセグメント範囲(名前または ID)

表54.258 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.259 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.260 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.261 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.262 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.66. network segment set

ネットワークセグメントの属性を設定します。

使用方法

openstack network segment set [-h] [--description <description>]
                                     [--name <name>]
                                     <network-segment>

表54.263 位置引数

概要

<network-segment>

変更するネットワークセグメント(名前または ID)

表54.264 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ネットワークセグメントの説明を設定します。

--name <name>

ネットワークセグメント名を設定します。

54.67. network segment show

ネットワークセグメントの詳細を表示します。

使用方法

openstack network segment show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <network-segment>

表54.265 位置引数

概要

<network-segment>

表示するネットワークセグメント(名前または ID)

表54.266 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.267 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.268 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.269 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.270 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.68. network service provider list

サービスプロバイダーを一覧表示します。

使用方法

openstack network service provider list [-h]
                                               [-f {csv,json,table,value,yaml}]
                                               [-c COLUMN]
                                               [--quote {all,minimal,none,nonnumeric}]
                                               [--noindent]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--sort-column SORT_COLUMN]

表54.271 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.272 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.273 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.274 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.275 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.69. network set

ネットワークの属性を設定します。

使用方法

openstack network set [-h] [--name <name>] [--enable | --disable]
                             [--share | --no-share]
                             [--description <description] [--mtu <mtu]
                             [--enable-port-security | --disable-port-security]
                             [--external | --internal]
                             [--default | --no-default]
                             [--qos-policy <qos-policy> | --no-qos-policy]
                             [--tag <tag>] [--no-tag]
                             [--provider-network-type <provider-network-type>]
                             [--provider-physical-network <provider-physical-network>]
                             [--provider-segment <provider-segment>]
                             [--dns-domain <dns-domain>]
                             <network>

表54.276 位置引数

概要

<network>

変更するネットワーク(名前または ID)

表54.277 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ネットワーク名を設定します。

--enable

ネットワークを有効有効にします。

--disable

ネットワークを無効にします。

--share

プロジェクト間でネットワークを共有します。

--no-share

プロジェクト間でネットワークを共有しません。

--description <description

ネットワークの説明を設定します。

--mtu <mtu

ネットワークのmtuを設定します。

--enable-port-security

このネットワークで作成されたポートで、デフォルトでポートセキュリティーを有効にします。

--disable-port-security

このネットワークで作成されたポートで、デフォルトでポートセキュリティーを無効にします。

--external

このネットワークを外部ネットワークとして設定します(external-net 拡張機能が必要)

--internal

このネットワークを内部ネットワークとして設定します。

--default

ネットワークをデフォルトの外部ネットワークとして設定します。

--no-default

ネットワークをデフォルトの外部ネットワークとして使用しません。

--qos-policy <qos-policy>

このネットワークにアタッチする QoS ポリシー(名前または ID)

--no-qos-policy

このネットワークに割り当てられた qos ポリシーを削除します。

--tag <tag>

ネットワークに追加するタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

ネットワークに関連付けられたタグを消去します。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。

--provider-network-type <provider-network-type>

仮想ネットワークが実装される物理メカニズム。例:flat、geneve、gre、local、vlan、vxlan

--provider-physical-network <provider-physical-network>

仮想ネットワークが実装される物理ネットワークの名前

--provider-segment <provider-segment>

vlan ネットワークの VLAN id、または GENEVE/GRE/VXLAN ネットワークのトンネル ID

--dns-domain <dns-domain>

このネットワークに dns ドメインを設定します(dns 統合拡張が必要です)。

54.70. network show

ネットワーク情報を表示します。

使用方法

openstack network show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <network>

表54.278 位置引数

概要

<network>

表示するネットワーク(名前または ID)

表54.279 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.280 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.281 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.282 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.283 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.71. network subport list

特定のネットワークトランクのすべてのサブポートを一覧表示します。

使用方法

openstack network subport list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN] --trunk
                                      <trunk>

表54.284 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--trunk <trunk>

このトランクに属するサブポートを一覧表示します(名前または id)。

表54.285 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.286 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.287 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.288 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.72. network trunk create

特定プロジェクトのネットワークトランクを作成します。

使用方法

openstack network trunk create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--description <description>]
                                      --parent-port <parent-port>
                                      [--subport <port=,segmentation-type=,segmentation-id=>]
                                      [--enable | --disable]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      <name>

表54.289 位置引数

概要

<name>

作成するトランクの名前

表54.290 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

トランクの説明

--parent-port <parent-port>

このトランクに属する親ポート(名前または ID)

--subport <port=,segmentation-type=,segmentation-id⇒

追加するサブポート。サブポートの形式は port=<name or ID>,segmentation-type=,segmentation-ID= で、(--subport) オプションは繰り返し使用できます。

--enable

トランクを有効にします(デフォルト)。

--disable

トランクを無効にします。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表54.291 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.292 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.293 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.294 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.73. network trunk delete

特定のネットワークトランクを削除します。

使用方法

openstack network trunk delete [-h] <trunk> [<trunk> ...]

表54.295 位置引数

概要

<trunk>

削除するトランク(名前または ID)

表54.296 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

54.74. network trunk list

すべてのネットワークトランクを一覧表示します。

使用方法

openstack network trunk list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN] [--long]

表54.297 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

表54.298 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表54.299 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表54.300 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.301 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.75. network trunk set

ネットワークトランクの属性を設定します。

使用方法

openstack network trunk set [-h] [--name <name>]
                                   [--description <description>]
                                   [--subport <port=,segmentation-type=,segmentation-id=>]
                                   [--enable | --disable]
                                   <trunk>

表54.302 位置引数

概要

<trunk>

変更するトランク(名前または ID)

表54.303 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

トランク名を設定します。

--description <description>

トランクの説明

--subport <port=,segmentation-type=,segmentation-id⇒

追加するサブポート。サブポートの形式は port=<name or ID>,segmentation-type=,segmentation-ID= で、(--subport) オプションは繰り返し使用できます。

--enable

トランクを有効にします。

--disable

トランクを無効にします。

54.76. network trunk show

特定のネットワークトランクに関する情報を表示します。

使用方法

openstack network trunk show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <trunk>

表54.304 位置引数

概要

<trunk>

表示するトランク(名前または ID)

表54.305 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表54.306 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表54.307 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表54.308 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表54.309 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

54.77. network trunk unset

特定のネットワークトランクからサブポートの設定を解除します。

使用方法

openstack network trunk unset [-h] --subport <subport> <trunk>

表54.310 位置引数

概要

<trunk>

このトランクからサブポートの設定を解除します(名前または id)。

表54.311 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--subport <subport>

削除するサブポート(ポートの名前または ID)。(--subport) はオプションは繰り返し使用できます。

54.78. network unset

ネットワーク属性の設定を解除します。

使用方法

openstack network unset [-h] [--tag <tag> | --all-tag] <network>

表54.312 位置引数

概要

<network>

変更するネットワーク(名前または ID)

表54.313 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--tag <tag>

ネットワークから削除するタグ(複数のタグを削除する場合はオプションを繰り返し使用します)

--all-tag

ネットワークに関連付けられたすべてのタグを消去します。

第55章 object

本章では、object コマンドに含まれるコマンドについて説明します。

55.1. object create

オブジェクトをコンテナーにアップロードします。

使用方法

openstack object create [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN] [--name <name>]
                               <container> <filename> [<filename> ...]

表55.1 位置引数

概要

<container>

新規オブジェクトのコンテナー

<filename>

アップロードするローカルファイル名

表55.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ファイルをアップロードして名前を変更します。単一オブジェクトのアップロード時にのみ使用できます。

表55.3 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表55.4 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表55.5 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表55.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

55.2. object delete

コンテナーからオブジェクトを削除します。

使用方法

openstack object delete [-h] <container> <object> [<object> ...]

表55.7 位置引数

概要

<container>

<container> からオブジェクトを削除します。

<object>

削除するオブジェクト

表55.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

55.3. object list

オブジェクトを一覧表示します。

使用方法

openstack object list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--prefix <prefix>]
                             [--delimiter <delimiter>] [--marker <marker>]
                             [--end-marker <end-marker>]
                             [--limit <num-objects>] [--long] [--all]
                             <container>

表55.9 位置引数

概要

<container>

一覧表示するコンテナー

表55.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--prefix <prefix>

<prefix> を使用して一覧をフィルターします。

--delimiter <delimiter>

<delimiter> でアイテムをロールアップします。

--marker <marker>

ページングのアンカー

--end-marker <end-marker>

ページングの終了アンカー

--limit <num-objects>

返されるオブジェクト数を制限します。

--long

出力の追加フィールドを一覧表示します。

--all

コンテナーのすべてのオブジェクトを一覧表示します(デフォルトは 10000)。

表55.11 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表55.12 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表55.13 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表55.14 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

55.4. object save

ローカルにオブジェクトを保存します。

使用方法

openstack object save [-h] [--file <filename>] <container> <object>

表55.15 位置引数

概要

<container>

<container> から <object> をダウンロードします。

<object>

保存するオブジェクト

表55.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--file <filename>

保存先ファイル名(デフォルトはオブジェクト名)。ファイル名に-を使用すると、ファイルを標準出力に出力します。

55.5. object set

オブジェクトの属性を設定します。

使用方法

openstack object set [-h] --property <key=value> <container> <object>

表55.17 位置引数

概要

<container>

<container> からの <object> を変更します。

<object>

変更するオブジェクト

表55.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key=value>

このオブジェクトに属性を設定します(複数の属性を設定する場合はオプションを繰り返し使用します)。

55.6. object show

オブジェクトの詳細を表示します。

使用方法

openstack object show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <container> <object>

表55.19 位置引数

概要

<container>

<container> からの <object> を表示します。

<object>

表示するオブジェクト

表55.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表55.21 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表55.22 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表55.23 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表55.24 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

55.7. object store account set

アカウントの属性を設定します。

使用方法

openstack object store account set [-h] --property <key=value>

表55.25 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key=value>

このアカウントに属性を設定します(複数の属性を設定する場合はオプションを繰り返し使用します)。

55.8. object store account show

アカウントの詳細を表示します。

使用方法

openstack object store account show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]

表55.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表55.27 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表55.28 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表55.29 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表55.30 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

55.9. object store account unset

アカウント属性の設定を解除します。

使用方法

openstack object store account unset [-h] --property <key>

表55.31 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key>

アカウントから削除する属性(複数の属性を削除する場合はオプションを繰り返し使用します)

55.10. object unset

オブジェクト属性の設定を解除します。

使用方法

openstack object unset [-h] --property <key> <container> <object>

表55.32 位置引数

概要

<container>

<container> からの <object> を変更します。

<object>

変更するオブジェクト

表55.33 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key>

オブジェクトから削除する属性(複数の属性を削除する場合はオプションを繰り返し使用します)

第56章 orchestration

本章では、orchestration コマンドに含まれるコマンドについて説明します。

56.1. orchestration build info

ビルド情報を取得します。

使用方法

openstack orchestration build info [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]

表56.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表56.2 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表56.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表56.4 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表56.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

56.2. orchestration resource type list

リソース種別を一覧表示します。

使用方法

openstack orchestration resource type list [-h]
                                                  [-f {csv,json,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--quote {all,minimal,none,nonnumeric}]
                                                  [--noindent]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--sort-column SORT_COLUMN]
                                                  [--filter <key=value>]
                                                  [--long]

表56.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--filter <key=value>

返されたリソース種別に適用するフィルターパラメーターこれは複数回指定できます。name、version、または support_status のいずれかになります。

--long

対応する説明と共にリソース種別を表示します。

表56.7 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表56.8 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表56.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表56.10 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

56.3. orchestration resource type show

リソース種別の詳細を表示し、オプションとしてテンプレートを生成します。

使用方法

openstack orchestration resource type show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--template-type <template-type>]
                                                  [--long]
                                                  <resource-type>

表56.11 位置引数

概要

<resource-type>

詳細を表示するリソース種別

表56.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--template-type <template-type>

オプションとして生成するテンプレートの種別(hot または cfn)

--long

対応する説明と共にリソース種別を表示します。

表56.13 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表56.14 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表56.15 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表56.16 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

56.4. orchestration service list

Heat エンジンを一覧表示します。

使用方法

openstack orchestration service list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]

表56.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表56.18 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表56.19 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表56.20 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表56.21 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

56.5. orchestration template function list

利用可能な関数を一覧表示します。

使用方法

openstack orchestration template function list [-h]
                                                      [-f {csv,json,table,value,yaml}]
                                                      [-c COLUMN]
                                                      [--quote {all,minimal,none,nonnumeric}]
                                                      [--noindent]
                                                      [--max-width <integer>]
                                                      [--fit-width]
                                                      [--print-empty]
                                                      [--sort-column SORT_COLUMN]
                                                      [--with_conditions]
                                                      <template-version>

表56.22 位置引数

概要

<template-version>

関数を取得するテンプレートのバージョン

表56.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--with_conditions

テンプレートの条件関数を表示します。

表56.24 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表56.25 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表56.26 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表56.27 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

56.6. orchestration template validate

テンプレートを検証します。

使用方法

openstack orchestration template validate [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [-e <environment>]
                                                 [--show-nested]
                                                 [--parameter <key=value>]
                                                 [--ignore-errors <error1,error2,...>]
                                                 -t <template>

表56.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-e <environment>, --environment <environment>

環境へのパス。複数回指定できます。

--show-nested

ネストされたテンプレートからのパラメーターも解決します。

--parameter <key=value>

スタックの作成に使用するパラメーター値。これは複数回指定できます。

--ignore-errors <error1,error2,…​>

無視する heat エラーの一覧

-t <template>, --template <template>

テンプレートへのパス

表56.29 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表56.30 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表56.31 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表56.32 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

56.7. orchestration template version list

利用可能なテンプレートバージョンを一覧表示します。

使用方法

openstack orchestration template version list [-h]
                                                     [-f {csv,json,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--quote {all,minimal,none,nonnumeric}]
                                                     [--noindent]
                                                     [--max-width <integer>]
                                                     [--fit-width]
                                                     [--print-empty]
                                                     [--sort-column SORT_COLUMN]

表56.33 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表56.34 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表56.35 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表56.36 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表56.37 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第57章 overcloud

本章では、overcloud コマンドに含まれるコマンドについて説明します。

57.1. overcloud admin authorize

Mistral で必要な ssh キーをデプロイします。

使用方法

openstack overcloud admin authorize [-h] [--stack STACK]
                                           [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                           [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                           [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                           [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT]
                                           [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]

表57.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--stack STACK

Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME)

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。未定義の場合、キーは自動検出されます。

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

オーバークラウドノードへの ssh アクセスに使用するネットワーク名。

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

ssh enable プロセスが完了するまでのタイムアウト。

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

ssh ポートがアクティブになるまで待機するタイムアウト。

57.2. overcloud cell export

別のセルのインポートとして使用するセル情報をエクスポートします。

使用方法

openstack overcloud cell export [-h]
                                       [--control-plane-stack <control plane stack>]
                                       [--cell-stack <cell stack>]
                                       [--output-file <output file>]
                                       [--force-overwrite]
                                       <cell name>

表57.2 位置引数

概要

<cell name>

追加のセルに使用するスタックの名前。

表57.3 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--control-plane-stack <control plane stack>

情報のエクスポート元となる環境のメイン heat スタックの名前 (デフォルト=Env: OVERCLOUD_STACK_NAME)

--cell-stack <cell stack>, -e <cell stack>

情報をエクスポートするコントローラーセル heat スタックの名前。コントロールプレーンスタック → セルコントローラースタック → 複数コンピュートスタックの場合に使用されます。

--output-file <output file>, -o <output file>

セルデータのエクスポートの出力ファイルの名前。デフォルトは "<name>.yaml" です。

--force-overwrite, -f

出力ファイルが存在する場合は上書きします。

57.3. overcloud config download

オーバークラウドの設定をダウンロードします。

使用方法

openstack overcloud config download [-h] [--name NAME]
                                           [--config-dir CONFIG_DIR]
                                           [--config-type CONFIG_TYPE]
                                           [--no-preserve-config]

表57.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

プランの名前(オブジェクトストレージコンテナー、ワークフロー環境、およびオーケストレーションスタック名に使用されます)。

--config-dir CONFIG_DIR

設定ファイルがプッシュされるディレクトリー

--config-type CONFIG_TYPE

デプロイメントから抽出されるオブジェクト設定の種別。デフォルトはすべてのキーです。

--no-preserve-config

これが指定されている場合は、--config- ディレクトリーがすでに存在する場合は、削除してから再作成されます。デフォルトでは、既存のディレクトリーの場所を使用し、ファイルを上書きします。--config-dir のファイルは、スタックからではなく、デフォルトでは保持されます。

57.4. overcloud container image build

kolla-build を使用してオーバークラウドのコンテナーイメージをビルドします。

使用方法

openstack overcloud container image build [-h]
                                                 [--config-file <yaml config file>]
                                                 --kolla-config-file <config
                                                 file> [--list-images]
                                                 [--list-dependencies]
                                                 [--exclude <container-name>]
                                                 [--use-buildah]
                                                 [--work-dir <container builds directory>]

表57.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--config-file <yaml config file>

ビルドするイメージを指定する yaml 設定ファイル。複数回指定できます。順序は保持され、後のファイルは以前のファイルにある一部のオプションを上書きします。他のオプションは追加されます。指定しない場合、コンテナーのデフォルトセットがビルドされます。

--kolla-config-file <config file>

使用する kolla 設定ファイルへのパス。複数の設定ファイルを指定できますが、後のファイルの値が優先されます。デフォルトでは、tripleo kolla 設定ファイル /usr/share/tripleo-common/container- images/tripleo_kolla_config_overrides.conf が追加されます。

--list-images

ビルドするのではなくビルドされるイメージを表示します。

--list-dependencies

イメージをビルドするのではなく、イメージビルドの依存関係を表示します。

--exclude <container-name>

ビルドをスキップするコンテナーの一覧に対して一致するコンテナーの名前。複数回指定できます。

--use-buildah

docker の代わりに buildah を使用して、Kolla でイメージをビルドします。

--work-dir <container builds directory>

TripleO コンテナービルドディレクトリー。各イメージおよびその依存関係の設定およびログを保存します。

57.5. overcloud container image prepare

イメージ、タグ、およびレジストリーを定義するファイルを生成します。

使用方法

openstack overcloud container image prepare [-h]
                                                   [--template-file <yaml template file>]
                                                   [--push-destination <location>]
                                                   [--tag <tag>]
                                                   [--tag-from-label <image label>]
                                                   [--namespace <namespace>]
                                                   [--prefix <prefix>]
                                                   [--suffix <suffix>]
                                                   [--set <variable=value>]
                                                   [--exclude <regex>]
                                                   [--include <regex>]
                                                   [--output-images-file <file path>]
                                                   [--environment-file <file path>]
                                                   [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                                   [--output-env-file <file path>]
                                                   [--roles-file ROLES_FILE]
                                                   [--modify-role MODIFY_ROLE]
                                                   [--modify-vars MODIFY_VARS]

表57.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--template-file <yaml template file>

イメージ設定ファイルがビルドされる yaml テンプレートファイル。デフォルト: /usr/share/tripleo-common/container- images/overcloud_containers.yaml.j2

--push-destination <location>

イメージのプッシュ先となるイメージレジストリーの場所。指定した場合、push_destination がすべてのイメージエントリーごとに設定されます。

--tag <tag>

デフォルトのタグの置換を上書きします。--tag-from-label が指定されている場合には、このタグを使用して検出を開始します。デフォルト: 16.0

--tag-from-label <image label>

指定されたラベルの値を使用してタグを検出します。ラベルは、テンプレート形式で組み合わせることができます(例:{version}-{release})。

--namespace <namespace>

デフォルトの名前空間の置換を上書きします。デフォルト:registry.redhat.io/rhosp-rhel8

--prefix <prefix>

デフォルトの名前プレフィックスの置換を上書きします。デフォルト:openstack-

--suffix <suffix>

デフォルトの名前接尾辞の置換を上書きします。デフォルト:

--set <variable=value>

「--suffix」などの専用の引数がない場合でも、テンプレートに変数の値を設定します。

--exclude <regex>

結果のイメージ名のエントリーに対して照合して最終的な出力から除外するパターン。複数回指定できます。

--include <regex>

結果のイメージ名のエントリーに対して照合して最終的な出力に含めるパターン。複数回指定できます。--include と一致するエントリーがない場合には実行されます。--include を使用する場合には、--exclude を無視します。

--output-images-file <file path>

stdout に加えて、結果のイメージエントリーを書き込むファイル。既存のファイルは上書きされます。

--environment-file <file path>, -e <file path>

コンテナー化されるサービスを指定する環境ファイル。エントリーは、コンテナー化されるサービスで使用されるイメージのみを含むようにフィルターされます。(複数回指定することが可能です。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

update コマンドに自動的に追加される環境ファイルディレクトリー。エントリーは、コンテナー化されるサービスで使用されるイメージのみを含むようにフィルターされます。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--output-env-file <file path>

すべてのイメージパラメーターを指定する heat 環境ファイルを書き込むファイル。既存のファイルは上書きされます。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。デプロイメントに使用する t-h-t templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは templates ディレクトリーへの相対パスを指定できます。

--modify-role MODIFY_ROLE

すべてのイメージアップロードのプルおよびプッシュ間で実行する Ansible ロールの名前。

--modify-vars MODIFY_VARS

--modify-role ロールの呼び出し時に使用する変数を含む Ansible 変数ファイル。

57.6. overcloud container image tag discover

イメージのバージョンタグを検出します。

使用方法

openstack overcloud container image tag discover [-h] --image
                                                        <container image>
                                                        [--tag-from-label <image label>]

表57.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--image <container image>

タグを検出するイメージの完全修飾名(レジストリーおよび安定したタグを含む)。

--tag-from-label <image label>

指定されたラベルの値を使用してタグを検出します。ラベルは、テンプレート形式で組み合わせることができます(例:{version}-{release})。

57.7. overcloud container image upload

オーバークラウドのコンテナーイメージをレジストリーにプッシュします。

使用方法

openstack overcloud container image upload [-h] --config-file <yaml
                                                  config file>
                                                  [--cleanup <full, partial, none>]

表57.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--config-file <yaml config file>

イメージビルドを指定する yaml 設定ファイル。複数回指定できます。順序は保持され、後のファイルは以前のファイルにある一部のオプションを上書きします。他のオプションは追加されます。

--cleanup <full, partial, none>

アップロード後に残されたローカルイメージの動作をクリーンアップします。デフォルトの full は、すべてのローカルイメージの削除を試行します。partial は、このホストでのデプロイメントに必要なイメージを残します。noneは、クリーンアップを実行しません。

57.8. overcloud credentials

overcloudrc ファイルを作成します。

使用方法

openstack overcloud credentials [-h] [--directory [DIRECTORY]] plan

表57.9 位置引数

概要

plan

rc ファイルを作成するプランの名前。

表57.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--directory [DIRECTORY]

rc ファイルを作成するディレクトリー。デフォルトは現在のディレクトリーです。

57.9. overcloud delete

オーバークラウドスタックおよびプランを削除します。

使用方法

openstack overcloud delete [-h] [-y] [stack]

表57.11 位置引数

Summary

stack

削除する heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME)

表57.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-y, --yes

yes/noプロンプトを省略します(yesと仮定)。

57.10. overcloud deploy

オーバークラウドをデプロイします。

使用方法

openstack overcloud deploy [--templates [TEMPLATES]] [--stack STACK]
                                  [--timeout <TIMEOUT>]
                                  [--control-scale CONTROL_SCALE]
                                  [--compute-scale COMPUTE_SCALE]
                                  [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                  [--block-storage-scale BLOCK_STORAGE_SCALE]
                                  [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                  [--control-flavor CONTROL_FLAVOR]
                                  [--compute-flavor COMPUTE_FLAVOR]
                                  [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                  [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                  [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                  [--libvirt-type {kvm,qemu}]
                                  [--ntp-server NTP_SERVER]
                                  [--no-proxy NO_PROXY]
                                  [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                  [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                  [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                  [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT]
                                  [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]
                                  [--environment-file <HEAT ENVIRONMENT FILE>]
                                  [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                  [--roles-file ROLES_FILE]
                                  [--networks-file NETWORKS_FILE]
                                  [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                  [--no-cleanup] [--update-plan-only]
                                  [--validation-errors-nonfatal]
                                  [--validation-warnings-fatal]
                                  [--disable-validations]
                                  [--inflight-validations] [--dry-run]
                                  [--run-validations] [--skip-postconfig]
                                  [--force-postconfig]
                                  [--skip-deploy-identifier]
                                  [--answers-file ANSWERS_FILE]
                                  [--disable-password-generation]
                                  [--deployed-server] [--config-download]
                                  [--no-config-download]
                                  [--config-download-only]
                                  [--output-dir OUTPUT_DIR]
                                  [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                  [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                  [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                  [-b <baremetal_deployment.yaml>]

表57.13 その他の引数 (オプション):

概要

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--stack STACK

作成または更新するスタック名

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--control-scale CONTROL_SCALE

新しいコントロールノード数(非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。このオプションは「U」リリースで削除されます)。

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数(非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。このオプションは「U」リリースで削除されます)。

--ceph-storage-scale CEPH_STORAGE_SCALE

新しいcephストレージノード数(非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--block-storage-scale BLOCK_STORAGE_SCALE

新しいcinderストレージノード数(非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--swift-storage-scale SWIFT_STORAGE_SCALE

新しいswiftストレージノード数(非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用するNovaフレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。このオプションは「U」リリースで削除されます)。

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用するNovaフレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。このオプションは「U」リリースで削除されます)。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。未定義の場合、キーは自動検出されます。

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

オーバークラウドノードへの ssh アクセスに使用するネットワーク名。

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

ssh enable プロセスが完了するまでのタイムアウト。

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

ssh ポートがアクティブになるまで待機するタイムアウト。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは --templates に対する相対パスを指定できます。

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記:今後のリリースでは、別のコマンドに移行します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

--disable-validations

非推奨。デプロイメント前の検証を完全に無効にします。これらの検証は、組み込まれたデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。これらの検証は、tripleo-validations の外部検証により実行されるようになりました。

--inflight-validations

デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。

--dry-run

検証のみを実行しますが、変更は適用されません。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--disable-password-generation

パスワードの生成を無効にします。

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、およびimageサービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--config-download

config-downloadメカニズムを使用してデプロイメントを実行します。これは現在のデフォルトであり、この CLI のオプションは今後廃止される可能性があります。

--no-config-download, --stack-only

config-download ワークフローを無効にして、スタックと関連する OpenStack リソースのみを作成します。ソフトウェア設定は適用されません。

--config-download-only

スタックの作成/更新を無効にして、ソフトウェア設定を適用する config-download ワークフローのみを実行します。

--output-dir OUTPUT_DIR

config-downloadを使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値(/var/lib/mistral/<execution id>)が使用されます。

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Ansible 設定ファイルへのパス。ファイルの設定は、デフォルトで config-download が使用する設定を上書きします。

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

config-download のステップに使用するタイムアウト (分単位)。設定しなければ、スタック操作後の --timeout パラメーターの残り時間にかかわらず、デフォルトがその時間に設定されます。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

デプロイメントアクションに使用する Python インタープリターへのパス。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

ベアメタルデプロイメントを記述する設定ファイル

57.11. overcloud execute

サーバー上で Heat ソフトウェア設定を実行します。

使用方法

openstack overcloud execute [-h] [-s SERVER_NAME] [-g GROUP] file_in

表57.14 位置引数

概要

file_in

None

表57.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-s SERVER_NAME, --server_name SERVER_NAME

照合する nova server_name またはパーシャル名。

-g GROUP、--group GROUP

Heat ソフトウェア設定 "グループ" 種別。デフォルトは「script」です。

57.12. overcloud export

別のスタックのインポートとして使用するスタック情報をエクスポートします。

使用方法

openstack overcloud export [-h] [--stack <stack>]
                                  [--output-file <output file>]
                                  [--force-overwrite]
                                  [--config-download-dir CONFIG_DOWNLOAD_DIR]
                                  [--no-password-excludes]

表57.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--stack <stack>

情報のエクスポート元となる環境のメイン heat スタックの名前 (デフォルト=Env: OVERCLOUD_STACK_NAME)

--output-file <output file>, -o <output file>

スタックデータのエクスポートの出力ファイルの名前。デフォルトは "<name>.yaml" です。

--force-overwrite, -f

出力ファイルが存在する場合は上書きします。

--config-download-dir CONFIG_DOWNLOAD_DIR

config-download エクスポートデータを検索するディレクトリー。デフォルトは /var/lib/mistral/<stack> です。

--no-password-excludes

パスワードのエクスポートから特定のパスワードを除外しません。デフォルトはFalseで、特に必要のない一部のパスワードは除外されます。

57.13. overcloud external-update run

外部のマイナーアップデート Ansible Playbook を実行します。この Playbook は、アンダークラウドからタスクを実行する、外部のマイナーアップデート Ansible Playbook を実行します。overcloud update prepare コマンドの完了後に、アップデート Playbook が利用可能になります。

使用方法

openstack overcloud external-update run [-h]
                                               [--static-inventory STATIC_INVENTORY]
                                               [--ssh-user SSH_USER]
                                               [--tags TAGS]
                                               [--skip-tags SKIP_TAGS]
                                               [--stack STACK] [-e EXTRA_VARS]
                                               [--no-workflow]

表57.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--static-inventory STATIC_INVENTORY

使用する既存の Ansible インベントリーへのパス。指定されていない場合は、~/tripleo-ansible- inventory.yaml に生成されます。

--ssh-user SSH_USER

非推奨:tripleo-admin のみを ssh ユーザーとして使用する必要があります。

--tags TAGS

ansible-playbook に --tags として渡すタグまたはタグのコンマ区切りリストを指定する文字列。

--skip-tags SKIP_TAGS

ansible-playbook に --skip-tags として渡すタグまたはタグのコンマ区切りリストを指定する文字列。

--stack STACK

Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME)

-e EXTRA_VARS, --extra-vars EXTRA_VARS

追加の変数を key=value または yaml/json として設定します。

--no-workflow

TripleO mistral ワークフローを介して Ansible を実行するのではなく、システムコマンド経由で ansible-playbook を直接実行します。

57.14. overcloud external-upgrade run

外部のメジャーアップグレード Ansible Playbook を実行します。この Playbook は、アンダークラウドからタスクを実行する、外部のメジャーアップグレード Ansible Playbook を実行します。overcloud upgrade prepare コマンドの完了後に、アップグレード Playbook が利用可能になります。

使用方法

openstack overcloud external-upgrade run [-h]
                                                [--static-inventory STATIC_INVENTORY]
                                                [--ssh-user SSH_USER]
                                                [--tags TAGS]
                                                [--skip-tags SKIP_TAGS]
                                                [--stack STACK]
                                                [-e EXTRA_VARS]
                                                [--no-workflow]

表57.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--static-inventory STATIC_INVENTORY

使用する既存の Ansible インベントリーへのパス。指定されていない場合は、~/tripleo-ansible- inventory.yaml に生成されます。

--ssh-user SSH_USER

非推奨:tripleo-admin のみを ssh ユーザーとして使用する必要があります。

--tags TAGS

ansible-playbook に --tags として渡すタグまたはタグのコンマ区切りリストを指定する文字列。

--skip-tags SKIP_TAGS

ansible-playbook に --skip-tags として渡すタグまたはタグのコンマ区切りリストを指定する文字列。

--stack STACK

Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME)

-e EXTRA_VARS, --extra-vars EXTRA_VARS

追加の変数を key=value または yaml/json として設定します。

--no-workflow

TripleO mistral ワークフローを介して Ansible を実行するのではなく、システムコマンド経由で ansible-playbook を直接実行します。

57.15. overcloud failures

デプロイメントの失敗を取得します。

使用方法

openstack overcloud failures [-h] [--plan PLAN]

表57.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--plan PLAN、--stack PLAN

スタック/プラン の名前(デフォルト:overcloud)

57.16. overcloud ffwd-upgrade converge

オーバークラウドノードの Fast Forward Upgrade を収束します。これは、Fast Forward Upgrade を完了するための最後のステップです。主なタスクは、プランおよびスタックを更新して、将来のスタック更新のブロックを解除します。ffwd アップグレードワークフローでは、OS::TripleO リソースおよび OS::Heat リソース向けに config-download Software/Structured Deployment を設定し、使用しました。これにより、それらの設定をデフォルト値に戻します。

使用方法

openstack overcloud ffwd-upgrade converge [--templates [TEMPLATES]]
                                                 [--stack STACK]
                                                 [--timeout <TIMEOUT>]
                                                 [--control-scale CONTROL_SCALE]
                                                 [--compute-scale COMPUTE_SCALE]
                                                 [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                                 [--block-storage-scale BLOCK_STORAGE_SCALE]
                                                 [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                                 [--control-flavor CONTROL_FLAVOR]
                                                 [--compute-flavor COMPUTE_FLAVOR]
                                                 [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                                 [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                                 [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                                 [--libvirt-type {kvm,qemu}]
                                                 [--ntp-server NTP_SERVER]
                                                 [--no-proxy NO_PROXY]
                                                 [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                                 [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                                 [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                                 [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT]
                                                 [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]
                                                 [--environment-file <HEAT ENVIRONMENT FILE>]
                                                 [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                                 [--roles-file ROLES_FILE]
                                                 [--networks-file NETWORKS_FILE]
                                                 [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                                 [--no-cleanup]
                                                 [--update-plan-only]
                                                 [--validation-errors-nonfatal]
                                                 [--validation-warnings-fatal]
                                                 [--disable-validations]
                                                 [--inflight-validations]
                                                 [--dry-run]
                                                 [--run-validations]
                                                 [--skip-postconfig]
                                                 [--force-postconfig]
                                                 [--skip-deploy-identifier]
                                                 [--answers-file ANSWERS_FILE]
                                                 [--disable-password-generation]
                                                 [--deployed-server]
                                                 [--config-download]
                                                 [--no-config-download]
                                                 [--config-download-only]
                                                 [--output-dir OUTPUT_DIR]
                                                 [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                                 [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                                 [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                                 [-b <baremetal_deployment.yaml>]
                                                 [--yes]

表57.20 その他の引数 (オプション):

概要

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--stack STACK

作成または更新するスタック名

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--control-scale CONTROL_SCALE

新しいコントロールノード数(非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。このオプションは「U」リリースで削除されます)。

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数(非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。このオプションは「U」リリースで削除されます)。

--ceph-storage-scale CEPH_STORAGE_SCALE

新しいcephストレージノード数(非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--block-storage-scale BLOCK_STORAGE_SCALE

新しいcinderストレージノード数(非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--swift-storage-scale SWIFT_STORAGE_SCALE

新しいswiftストレージノード数(非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用するNovaフレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。このオプションは「U」リリースで削除されます)。

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用するNovaフレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。このオプションは「U」リリースで削除されます)。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。未定義の場合、キーは自動検出されます。

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

オーバークラウドノードへの ssh アクセスに使用するネットワーク名。

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

ssh enable プロセスが完了するまでのタイムアウト。

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

ssh ポートがアクティブになるまで待機するタイムアウト。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは --templates に対する相対パスを指定できます。

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記:今後のリリースでは、別のコマンドに移行します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

--disable-validations

非推奨。デプロイメント前の検証を完全に無効にします。これらの検証は、組み込まれたデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。これらの検証は、tripleo-validations の外部検証により実行されるようになりました。

--inflight-validations

デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。

--dry-run

検証のみを実行しますが、変更は適用されません。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--disable-password-generation

パスワードの生成を無効にします。

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、およびimageサービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--config-download

config-downloadメカニズムを使用してデプロイメントを実行します。これは現在のデフォルトであり、この CLI のオプションは今後廃止される可能性があります。

--no-config-download, --stack-only

config-download ワークフローを無効にして、スタックと関連する OpenStack リソースのみを作成します。ソフトウェア設定は適用されません。

--config-download-only

スタックの作成/更新を無効にして、ソフトウェア設定を適用する config-download ワークフローのみを実行します。

--output-dir OUTPUT_DIR

config-downloadを使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値(/var/lib/mistral/<execution id>)が使用されます。

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Ansible 設定ファイルへのパス。ファイルの設定は、デフォルトで config-download が使用する設定を上書きします。

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

config-download のステップに使用するタイムアウト (分単位)。設定しなければ、スタック操作後の --timeout パラメーターの残り時間にかかわらず、デフォルトがその時間に設定されます。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

デプロイメントアクションに使用する Python インタープリターへのパス。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

ベアメタルデプロイメントを記述する設定ファイル

--yes

--yes を使用して、ffwd-upgrade 操作の前に必要な確認を省略します。注意して使用してください。

57.17. overcloud ffwd-upgrade prepare

オーバークラウドノードの heat スタックの更新を実行して、heat stack の出力を更新します。heat スタックの出力は、後で Ansible Playbook を生成するために使用しているものです。これにより、ffwd アップグレードワークフローが提供されます。これは、オーバークラウドの Fast Forward Upgrade の最初のステップとして使用されます。

使用方法

openstack overcloud ffwd-upgrade prepare [--templates [TEMPLATES]]
                                                [--stack STACK]
                                                [--timeout <TIMEOUT>]
                                                [--control-scale CONTROL_SCALE]
                                                [--compute-scale COMPUTE_SCALE]
                                                [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                                [--block-storage-scale BLOCK_STORAGE_SCALE]
                                                [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                                [--control-flavor CONTROL_FLAVOR]
                                                [--compute-flavor COMPUTE_FLAVOR]
                                                [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                                [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                                [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                                [--libvirt-type {kvm,qemu}]
                                                [--ntp-server NTP_SERVER]
                                                [--no-proxy NO_PROXY]
                                                [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                                [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                                [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                                [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT]
                                                [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]
                                                [--environment-file <HEAT ENVIRONMENT FILE>]
                                                [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                                [--roles-file ROLES_FILE]
                                                [--networks-file NETWORKS_FILE]
                                                [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                                [--no-cleanup]
                                                [--update-plan-only]
                                                [--validation-errors-nonfatal]
                                                [--validation-warnings-fatal]
                                                [--disable-validations]
                                                [--inflight-validations]
                                                [--dry-run]
                                                [--run-validations]
                                                [--skip-postconfig]
                                                [--force-postconfig]
                                                [--skip-deploy-identifier]
                                                [--answers-file ANSWERS_FILE]
                                                [--disable-password-generation]
                                                [--deployed-server]
                                                [--config-download]
                                                [--no-config-download]
                                                [--config-download-only]
                                                [--output-dir OUTPUT_DIR]
                                                [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                                [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                                [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                                [-b <baremetal_deployment.yaml>]
                                                [--yes]

表57.21 その他の引数 (オプション):

概要

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--stack STACK

作成または更新するスタック名

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--control-scale CONTROL_SCALE

新しいコントロールノード数(非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。このオプションは「U」リリースで削除されます)。

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数(非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。このオプションは「U」リリースで削除されます)。

--ceph-storage-scale CEPH_STORAGE_SCALE

新しいcephストレージノード数(非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--block-storage-scale BLOCK_STORAGE_SCALE

新しいcinderストレージノード数(非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--swift-storage-scale SWIFT_STORAGE_SCALE

新しいswiftストレージノード数(非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用するNovaフレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。このオプションは「U」リリースで削除されます)。

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用するNovaフレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。このオプションは「U」リリースで削除されます)。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。未定義の場合、キーは自動検出されます。

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

オーバークラウドノードへの ssh アクセスに使用するネットワーク名。

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

ssh enable プロセスが完了するまでのタイムアウト。

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

ssh ポートがアクティブになるまで待機するタイムアウト。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは --templates に対する相対パスを指定できます。

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記:今後のリリースでは、別のコマンドに移行します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

--disable-validations

非推奨。デプロイメント前の検証を完全に無効にします。これらの検証は、組み込まれたデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。これらの検証は、tripleo-validations の外部検証により実行されるようになりました。

--inflight-validations

デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。

--dry-run

検証のみを実行しますが、変更は適用されません。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--disable-password-generation

パスワードの生成を無効にします。

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、およびimageサービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--config-download

config-downloadメカニズムを使用してデプロイメントを実行します。これは現在のデフォルトであり、この CLI のオプションは今後廃止される可能性があります。

--no-config-download, --stack-only

config-download ワークフローを無効にして、スタックと関連する OpenStack リソースのみを作成します。ソフトウェア設定は適用されません。

--config-download-only

スタックの作成/更新を無効にして、ソフトウェア設定を適用する config-download ワークフローのみを実行します。

--output-dir OUTPUT_DIR

config-downloadを使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値(/var/lib/mistral/<execution id>)が使用されます。

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Ansible 設定ファイルへのパス。ファイルの設定は、デフォルトで config-download が使用する設定を上書きします。

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

config-download のステップに使用するタイムアウト (分単位)。設定しなければ、スタック操作後の --timeout パラメーターの残り時間にかかわらず、デフォルトがその時間に設定されます。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

デプロイメントアクションに使用する Python インタープリターへのパス。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

ベアメタルデプロイメントを記述する設定ファイル

--yes

--yes を使用して、ffwd-upgrade 操作の前に必要な確認を省略します。注意して使用してください。

57.18. overcloud ffwd-upgrade run

オーバークラウドノードで Fast Forward Upgrade Ansible Playbook を実行します。これにより、fast_forward_upgrade_playbook.yaml Ansible Playbook が実行されます。この Playbook は、ffwd-upgrade prepare コマンドの実行時に生成されました。「ffwd- upgrade run」の実行は、ffwd upgrade ワークフローの 2 番目のステップです。

使用方法

openstack overcloud ffwd-upgrade run [-h] [--yes]
                                            [--static-inventory STATIC_INVENTORY]
                                            [--ssh-user SSH_USER]
                                            [--stack STACK] [--no-workflow]

表57.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--yes

--yes を使用して、ffwd-upgrade 操作の前に必要な確認を省略します。注意して使用してください。

--static-inventory STATIC_INVENTORY

使用する既存の Ansible インベントリーへのパス。指定されていない場合は、~/tripleo-ansible- inventory.yaml に生成されます。

--ssh-user SSH_USER

非推奨:tripleo-admin のみを ssh ユーザーとして使用する必要があります。

--stack STACK

Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME)

--no-workflow

TripleO mistral ワークフローを介して Ansible を実行するのではなく、システムコマンド経由で ansible-playbook を直接実行します。

57.19. overcloud generate fencing

フェンシングパラメーターを生成します。

使用方法

openstack overcloud generate fencing [-h] [-a FENCE_ACTION]
                                            [--delay DELAY] [--ipmi-lanplus]
                                            [--ipmi-no-lanplus]
                                            [--ipmi-cipher IPMI_CIPHER]
                                            [--ipmi-level IPMI_LEVEL]
                                            [--output OUTPUT]
                                            instackenv

表57.23 位置引数

概要

instackenv

None

表57.24 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-a FENCE_ACTION、--action FENCE_ACTION

非推奨:このオプションは無視されます。

--delay DELAY

フェンシングが開始するまで遅延の秒数を待機します。

--ipmi-lanplus

非推奨:これがデフォルトです。

--ipmi-no-lanplus

lanplus を使用しません。デフォルトは false です。

--ipmi-cipher IPMI_CIPHER

使用する暗号スイート(ipmitool -c パラメーターと同じ)。

--ipmi-level IPMI_LEVEL

ipmi デバイスの権限レベル。有効なレベル: callback、user、operator、administrator

--output OUTPUT

ファイルにパラメーターを書き込みます。

57.20. overcloud image build

オーバークラウドのイメージをビルドします。

使用方法

openstack overcloud image build [-h] [--config-file <yaml config file>]
                                       [--image-name <image name>] [--no-skip]
                                       [--output-directory OUTPUT_DIRECTORY]

表57.25 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--config-file <yaml config file>

イメージビルドを指定する yaml 設定ファイル。複数回指定できます。順序は保持され、後のファイルは以前のファイルにある一部のオプションを上書きします。他のオプションは追加されます。

--image-name <image name>

ビルドするイメージの名前。複数回指定できます。指定されていない場合は、指定の YAML ファイルのすべてのイメージがビルドされます。

--no-skip

キャッシュされたイメージが存在する場合はビルドを省略します。

--output-directory OUTPUT_DIRECTORY

イメージのアウトプットディレクトリー。デフォルトは $TRIPLEO_ROOTで、未設定の場合は現在のディレクトリーです。

57.21. overcloud image upload

オーバークラウドデプロイメント用に、既存のイメージファイルを利用できるようにします。

使用方法

openstack overcloud image upload [-h] [--image-path IMAGE_PATH]
                                        [--os-image-name OS_IMAGE_NAME]
                                        [--ironic-python-agent-name IPA_NAME]
                                        [--http-boot HTTP_BOOT]
                                        [--update-existing] [--whole-disk]
                                        [--architecture ARCHITECTURE]
                                        [--platform PLATFORM]
                                        [--image-type {os,ironic-python-agent}]
                                        [--progress] [--local]
                                        [--local-path LOCAL_PATH]

表57.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--image-path IMAGE_PATH

イメージファイルが含まれるディレクトリーへのパス

--os-image-name OS_IMAGE_NAME

Openstack ディスクイメージのファイル名

--ironic-python-agent-name IPA_NAME

Openstack ironic-python-agent (agent)イメージのファイル名

--http-boot HTTP_BOOT

ironic-python-agent イメージのルートディレクトリー。複数のアーキテクチャー/プラットフォームのイメージをアップロードしている場合は、アーキテクチャー/プラットフォームごとに異なるディレクトリーが作成されるように、この引数を変更します。

--update-existing

イメージがすでに存在する場合は更新します。

--whole-disk

これを設定すると、アップロードされる overcloud-full イメージが完全なディスクのイメージとみなされます。

--architecture ARCHITECTURE

これらのイメージのアーキテクチャー種別。x86_64i386、および ppc64le は共通オプションです。このオプションは、instackenv.json の少なくとも 1 つの arch 値と一致している必要があります。

--platform PLATFORM

これらのイメージのプラットフォーム種別。platform はアーキテクチャーのサブカテゴリーです。たとえば、x86_64 の汎用イメージがありますが、SNB (SandyBridge)に固有のイメージを提供することができます。

--image-type {os,ironic-python-agent}

指定した場合には、アップロードするイメージ種別を制限できます(オーバークラウドイメージ用のosまたは ironic-python-agentの場合は ironic-python- agent)。

--progress

ファイルのアップロードアクション用に進捗バーを表示します。

--local

イメージサービスのエンドポイントがある場合でも、ローカルにファイルをコピーします。

--local-path LOCAL_PATH

イメージのエンドポイントがない場合、または --local が指定されている場合、イメージファイルのコピー先のルートディレクトリー

57.22. overcloud netenv validate

ネットワークの環境ファイルを検証します。

使用方法

openstack overcloud netenv validate [-h] [-f NETENV]

表57.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-f NETENV、--file NETENV

ネットワーク環境ファイルへのパス

57.23. overcloud node bios configure

指定のノードに BIOS 設定を適用します。

使用方法

openstack overcloud node bios configure [-h] [--all-manageable]
                                               [--configuration <configuration>]
                                               [<node_uuid> [<node_uuid> ...]]

表57.28 位置引数

概要

<node_uuid>

bios を設定するノードのベアメタルノードの uuid

表57.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-manageable

現在 manageable の状態にあるすべてのノードに bios を設定します。

--configuration <configuration>

BIOS 設定(yaml/json 文字列またはファイル名)

57.24. overcloud node bios reset

BIOS 設定を出荷時のデフォルトにリセットします。

使用方法

openstack overcloud node bios reset [-h] [--all-manageable]
                                           [<node_uuid> [<node_uuid> ...]]

表57.30 位置引数

概要

<node_uuid>

bios をリセットするノードのベアメタルノードの uuid

表57.31 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-manageable

現在 manageable の状態にあるすべてのノードの BIOS をリセットします。

57.25. overcloud node clean

クリーニングを使用してノードを実行します。

使用方法

openstack overcloud node clean [-h] [--all-manageable] [--provide]
                                      [<node_uuid> [<node_uuid> ...]]

表57.32 位置引数

概要

<node_uuid>

クリーニングするノードのベアメタルノード uuid

表57.33 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-manageable

現在 manageable の状態にあるノードを消去します。

--provide

ノードのクリーニング後に指定(利用可能に)します。

57.26. overcloud node configure

ノードのブートオプションを設定します。

使用方法

openstack overcloud node configure [-h] [--all-manageable]
                                          [--deploy-kernel DEPLOY_KERNEL]
                                          [--deploy-ramdisk DEPLOY_RAMDISK]
                                          [--instance-boot-option {local,netboot}]
                                          [--root-device ROOT_DEVICE]
                                          [--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE]
                                          [--overwrite-root-device-hints]
                                          [<node_uuid> [<node_uuid> ...]]

表57.34 位置引数

概要

<node_uuid>

設定するノードのベアメタルノード uuid

表57.35 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-manageable

現在 manageable の状態にあるノードを設定します。

--deploy-kernel DEPLOY_KERNEL

デプロイカーネルのあるイメージ。

--deploy-ramdisk DEPLOY_RAMDISK

デプロイ ramdisk のあるイメージ

--instance-boot-option {local,netboot}

インスタンスをローカルのハードドライブ(local)またはネットワーク(netboot)から起動するかどうかを設定します。

--root-device ROOT_DEVICE

ノードのルートデバイスを定義します。選択元となるデバイス名の一覧(/dev を省く)、または 2 つのストラテジー(最大または最小)のいずれかを選択できます。機能するには、イントロスペクション後にこのコマンドを実行する必要があります。

--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE

検出されるルートデバイスの最小サイズ(gib 単位)。--root-device と併用します。

--overwrite-root-device-hints

--root-device が使用されたときに既存のルートデバイスヒントを上書きするかどうか。

57.27. overcloud node delete

オーバークラウドノードを削除します。

使用方法

openstack overcloud node delete [-h] [-b <BAREMETAL DEPLOYMENT FILE>]
                                       [--stack STACK]
                                       [--templates [TEMPLATES]]
                                       [-e <HEAT ENVIRONMENT FILE>]
                                       [--timeout <TIMEOUT>] [-y]
                                       [<node> [<node> ...]]

表57.36 位置引数

概要

<node>

削除するノード ID(そうでなけれは、--baremetal-deployment ファイルで指定)

表57.37 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-b <BAREMETAL DEPLOYMENT FILE>, --baremetal-deployment <BAREMETAL DEPLOYMENT FILE>

ベアメタルデプロイメントを記述する設定ファイル

--stack STACK

スケーリングする heat スタックの名前または ID(デフォルト=env: OVERCLOUD_STACK_NAME)

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。この引数は非推奨です。このコマンドはデプロイメントプランを活用しています。プランは、このコマンドを実行する前に更新する必要があります。それ以外の場合は、この引数は警告なしで無視されます。

-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。) この引数は非推奨です。このコマンドはデプロイメントプランを活用しています。プランは、このコマンドを実行する前に更新する必要があります。それ以外の場合は、この引数は警告なしで無視されます。

--timeout <TIMEOUT>

ノードが削除されるまで待機するタイムアウト(分単位)。keystone セッション時間により、タイムアウトに 4 時間の上限がある点に注意してください。

-y、--yes

yes/noプロンプトを省略します(yesと仮定)。

57.28. overcloud node discover

BMC をポーリングしてオーバークラウドノードを検出します。

使用方法

openstack overcloud node discover [-h] (--ip <ips> | --range <range>)
                                         --credentials <key:value>
                                         [--port <ports>] [--introspect]
                                         [--run-validations] [--provide]
                                         [--no-deploy-image]
                                         [--instance-boot-option {local,netboot}]
                                         [--concurrency CONCURRENCY]

表57.38 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--ip <ips>

プローブする IP アドレス

--range <range>

プローブまでの IP 範囲

--credentials <key:value>

使用できる認証情報のキー/値のペア

--port <ports>

プローブする BMC ポート

--introspect

インポートしたノードをイントロスペクションします。

--run-validations

デプロイメント前の検証を実行します。これらの外部検証は TripleO Validations プロジェクトからのものです。

--provide

ノードを指定(利用可能に)します。

--no-deploy-image

デプロイカーネルおよび ramdisk の設定を省略します。

--instance-boot-option {local,netboot}

インスタンスをローカルのハードドライブ(local)またはネットワーク(netboot)から起動するかどうかを設定します。

--concurrency CONCURRENCY

一度にイントロスペクションするノードの最大数。

57.29. overcloud node import

JSON、YAML または CSV ファイルからベアメタルノードをインポートします。ノードのステータスはデフォルトで manageable に設定されます。

使用方法

openstack overcloud node import [-h] [--introspect] [--run-validations]
                                       [--validate-only] [--provide]
                                       [--no-deploy-image]
                                       [--instance-boot-option {local,netboot}]
                                       [--http-boot HTTP_BOOT]
                                       [--concurrency CONCURRENCY]
                                       env_file

表57.39 位置引数

概要

env_file

None

表57.40 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--introspect

インポートしたノードをイントロスペクションします。

--run-validations

デプロイメント前の検証を実行します。これらの外部検証は TripleO Validations プロジェクトからのものです。

--validate-only

env_file を検証し、実際にノードをインポートせずに終了します。

--provide

ノードを指定(利用可能に)します。

--no-deploy-image

デプロイカーネルおよび ramdisk の設定を省略します。

--instance-boot-option {local,netboot}

インスタンスをローカルのハードドライブ(local)またはネットワーク(netboot)から起動するかどうかを設定します。

--http-boot HTTP_BOOT

ironic-python-agent イメージのルートディレクトリー

--concurrency CONCURRENCY

一度にイントロスペクションするノードの最大数。

57.30. overcloud node introspect

manageable の状態にある、指定のノードまたはすべてのノードをイントロスペクションします。

使用方法

openstack overcloud node introspect [-h] [--all-manageable] [--provide]
                                           [--run-validations]
                                           [--concurrency CONCURRENCY]
                                           [<node_uuid> [<node_uuid> ...]]

表57.41 位置引数

概要

<node_uuid>

イントロスペクションするノードのベアメタルノード uuid

表57.42 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-manageable

現在 manageable の状態にある全ノードをイントロスペクションします。

--provide

ノードのイントロスペクション後に指定(利用可能に)します。

--run-validations

デプロイメント前の検証を実行します。これらの外部検証は TripleO Validations プロジェクトからのものです。

--concurrency CONCURRENCY

一度にイントロスペクションするノードの最大数。

57.31. overcloud node provide

UUID または現在の manageable の状態をもとに、ノードを利用可能とマークします。

使用方法

openstack overcloud node provide [-h] [--all-manageable]
                                        [<node_uuid> [<node_uuid> ...]]

表57.43 位置引数

概要

<node_uuid>

指定するノードのベアメタルノード uuid

表57.44 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-manageable

現在 manageable の状態にあるノードをすべて提供します。

57.32. overcloud node provision

Ironic を使用して新規ノードをプロビジョニングします。

使用方法

openstack overcloud node provision [-h] [-o OUTPUT] [--stack STACK]
                                          [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                          [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                          [--concurrency CONCURRENCY]
                                          [--timeout TIMEOUT]
                                          <baremetal_deployment.yaml>

表57.45 位置引数

概要

<baremetal_deployment.yaml>

ベアメタルデプロイメントを記述する設定ファイル

表57.46 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-o OUTPUT、--output OUTPUT

出力環境ファイルへのパス

--stack STACK

Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME)

--overcloud-ssh-user OVERCLOUD_SSH_USER

新たにデプロイされたノードに ssh アクセスするためのユーザー

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスのキーパス。未定義の場合、キーが自動検出されます。

--concurrency CONCURRENCY

一度にプロビジョニングするノード数(デフォルトは20)

--timeout TIMEOUT

ノードのプロビジョニングが完了するまで待機する秒数 (デフォルト=3600)

57.33. overcloud node unprovision

Ironic を使用したノードのプロビジョニングを解除します。

使用方法

openstack overcloud node unprovision [-h] [--stack STACK] [--all] [-y]
                                            <baremetal_deployment.yaml>

表57.47 位置引数

概要

<baremetal_deployment.yaml>

ベアメタルデプロイメントを記述する設定ファイル

表57.48 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--stack STACK

Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME)

--all

デプロイメント内のすべてのインスタンスのプロビジョニングを解除します。

-y、--yes

yes/noプロンプトを省略します(yesと仮定)。

57.34. overcloud parameters set

プランのパラメーターを設定します。

使用方法

openstack overcloud parameters set [-h] name file_in

表57.49 位置引数

概要

name

プランの名前(swiftコンテナー、Mistral環境、およびHeatスタック名に使用されます)。

file_in

None

表57.50 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.35. overcloud plan create

デプロイメントプランを作成します。

使用方法

openstack overcloud plan create [-h] [--templates TEMPLATES]
                                       [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                       [--disable-password-generation]
                                       [--source-url SOURCE_URL]
                                       name

表57.51 位置引数

概要

name

プランの名前(オブジェクトストレージコンテナー、ワークフロー環境、およびオーケストレーションスタック名に使用されます)。

表57.52 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--templates TEMPLATES

デプロイする Heat テンプレートが格納されているディレクトリー。このオプションまたは --source_url を指定しないと、アンダークラウドにパッケージ化されたテンプレートが使用されます。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--disable-password-generation

パスワードの生成を無効にします。

--source-url SOURCE_URL

デプロイする Heat テンプレートが格納されているgitリポジトリーのurl。このオプションまたは --templates を指定しないと、アンダークラウドにパッケージ化されたテンプレートが使用されます。

57.36. overcloud plan delete

オーバークラウドデプロイメントプランを削除します。同じ名前のスタックが存在する場合には、プランは削除されません。

使用方法

openstack overcloud plan delete [-h] <name> [<name> ...]

表57.53 位置引数

概要

<name>

削除するプランの名前

表57.54 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

57.37. overcloud plan deploy

デプロイメントプランをデプロイします。

使用方法

openstack overcloud plan deploy [-h] [--timeout <TIMEOUT>]
                                       [--run-validations]
                                       name

表57.55 位置引数

概要

name

デプロイするプランの名前。

表57.56 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--run-validations

デプロイメント前の検証を実行します。これらの外部検証は TripleO Validations プロジェクトからのものです。

57.38. overcloud plan export

デプロイメントプランをエクスポートします。

使用方法

openstack overcloud plan export [-h] [--output-file <output file>]
                                       [--force-overwrite]
                                       <name>

表57.57 位置引数

概要

<name>

エクスポートするプランの名前。

表57.58 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--output-file <output file>, -o <output file>

エクスポート用の出力ファイルの名前。デフォルトは "<name>.tar.gz" です。

--force-overwrite, -f

出力ファイルが存在する場合は上書きします。

57.39. overcloud plan list

オーバークラウドデプロイメントプランを一覧表示します。

使用方法

openstack overcloud plan list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]

表57.59 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表57.60 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表57.61 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表57.62 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.63 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

57.40. overcloud profiles list

オーバークラウドノードのプロファイルを一覧表示します。

使用方法

openstack overcloud profiles list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN] [--all]
                                         [--control-scale CONTROL_SCALE]
                                         [--compute-scale COMPUTE_SCALE]
                                         [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                         [--block-storage-scale BLOCK_STORAGE_SCALE]
                                         [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                         [--control-flavor CONTROL_FLAVOR]
                                         [--compute-flavor COMPUTE_FLAVOR]
                                         [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                         [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                         [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]

表57.64 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all

nova で利用できないノードであっても、すべてのノードを一覧表示します。

--control-scale CONTROL_SCALE

新しいコントロールノード数。

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数。

--ceph-storage-scale CEPH_STORAGE_SCALE

新しいceph ストレージノード数。

--block-storage-scale BLOCK_STORAGE_SCALE

新しいcinder ストレージノード数。

--swift-storage-scale SWIFT_STORAGE_SCALE

新しいswift ストレージノード数。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用する nova フレーバー。

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用する nova フレーバー。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー

表57.65 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表57.66 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表57.67 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.68 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

57.41. overcloud profiles match

ノード上のプロファイルを割り当ておよび検証します。

使用方法

openstack overcloud profiles match [-h] [--dry-run]
                                          [--control-scale CONTROL_SCALE]
                                          [--compute-scale COMPUTE_SCALE]
                                          [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                          [--block-storage-scale BLOCK_STORAGE_SCALE]
                                          [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                          [--control-flavor CONTROL_FLAVOR]
                                          [--compute-flavor COMPUTE_FLAVOR]
                                          [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                          [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                          [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]

表57.69 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--dry-run

検証のみを実行しますが、変更は適用されません。

--control-scale CONTROL_SCALE

新しいコントロールノード数。

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数。

--ceph-storage-scale CEPH_STORAGE_SCALE

新しいceph ストレージノード数。

--block-storage-scale BLOCK_STORAGE_SCALE

新しいcinder ストレージノード数。

--swift-storage-scale SWIFT_STORAGE_SCALE

新しいswift ストレージノード数。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用する nova フレーバー。

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用する nova フレーバー。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー

57.42. overcloud raid create

指定のノードに RAID を作成します。

使用方法

openstack overcloud raid create [-h] --node NODE configuration

表57.70 位置引数

概要

configuration

RAID 設定(yaml/json 文字列またはファイル名)

表57.71 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--node NODE

RAID を作成するノード(状態が manageable でなければなりません)。複数回指定できます。

57.43. overcloud role list

利用可能なロールを一覧表示します(非推奨)。代わりに「openstack overcloud roles list」を使用してください。

使用方法

openstack overcloud role list [-h] [--roles-path <roles directory>]

表57.72 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--roles-path <roles directory>

ロールの yaml ファイルが含されるファイルシステムパス。デフォルトでは /usr/share/openstack-tripleo-heat- templates/roles です。

57.44. overcloud role show

指定のロールに関する情報を表示します(非推奨)。代わりに「openstack overcloud roles show」を使用してください。

使用方法

openstack overcloud role show [-h] [--roles-path <roles directory>]
                                     <role>

表57.73 位置引数

概要

<role>

詳細情報を表示するロール。

表57.74 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--roles-path <roles directory>

ロールの yaml ファイルが含されるファイルシステムパス。デフォルトでは /usr/share/openstack-tripleo-heat- templates/roles です。

57.45. overcloud roles generate

roles_data.yaml ファイルを生成します。

使用方法

openstack overcloud roles generate [-h]
                                          [--roles-path <roles directory>]
                                          [-o <output file>] [--skip-validate]
                                          <role> [<role> ...]

表57.75 位置引数

概要

<role>

デプロイメントの roles_data.yaml ファイルを生成するために使用するロールの一覧。注記:ロールに「primary」および「controller」タグがない場合は、順序が重要になります。ロールがタグ付けされない場合、最初に一覧表示されるロールはプライマリーロールとみなされます。これは通常、Controller ロールです。

表57.76 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--roles-path <roles directory>

ロールの yaml ファイルが含されるファイルシステムパス。デフォルトでは /usr/share/openstack-tripleo-heat- templates/roles です。

-o <output file>, --output-file <output file>

roles_data.yaml など、すべての出力をキャプチャーするためのファイル。

--skip-validate

roles_data.yaml を生成する際に、ロールのメタデータ種別の検証をスキップします。

57.46. overcloud roles list

指定のプランの現在および利用可能なロールを一覧表示します。

使用方法

openstack overcloud roles list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--name NAME] [--detail] [--current]

表57.77 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

プランの名前(オブジェクトストレージコンテナー、ワークフロー環境、およびオーケストレーションスタック名に使用されます)。

--detail

各ロールの詳細を含めます。

--current

プランで現在有効なロールの情報のみを表示します。

表57.78 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表57.79 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表57.80 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.81 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

57.47. overcloud roles show

プランを指定して、特定のロールの詳細を表示します。

使用方法

openstack overcloud roles show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--name NAME]
                                      <role>

表57.82 位置引数

概要

<role>

検索するロール名

表57.83 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

プランの名前(オブジェクトストレージコンテナー、ワークフロー環境、およびオーケストレーションスタック名に使用されます)。

表57.84 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表57.85 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表57.86 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表57.87 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

57.48. overcloud status

デプロイメントのステータスを取得します。

使用方法

openstack overcloud status [-h] [--plan PLAN]

表57.88 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--plan PLAN、--stack PLAN

スタック/プラン の名前(デフォルト:overcloud)

57.49. overcloud support report collect

選択したサーバーで sosreport を実行します。

使用方法

openstack overcloud support report collect [-h] [-c CONTAINER]
                                                  [-o DESTINATION]
                                                  [--skip-container-delete]
                                                  [-t TIMEOUT]
                                                  [-n CONCURRENCY]
                                                  [--collect-only | --download-only]
                                                  server_name

表57.89 位置引数

概要

server_name

照合する nova server_name またはパーシャル名。たとえば、「controller」は環境のすべてのコントローラーと一致します。

表57.90 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-c CONTAINER, --container CONTAINER

ログを保存する swift コンテナー

-o DESTINATION, --output DESTINATION

レポートの出力ディレクトリー

--skip-container-delete

ファイルがダウンロードされた後にコンテナーを削除しません。--collect-only または --download- onlyが指定されている場合は無視されます。

-t TIMEOUT, --timeout TIMEOUT

ログの収集およびコンテナーの削除ワークフローが完了するまでの最大待機時間。

-n CONCURRENCY、--concurrency CONCURRENCY

実行する並列ログコレクションおよびオブジェクトの削除タスクの数。

--collect-only

ログのダウンロードをスキップし、ログの収集およびコンテナーへの配置だけを実施します。

--download-only

生成をスキップし、指定されたコンテナーからのダウンロードだけを実施します。

57.50. overcloud update converge

オーバークラウドノードで更新を収束します。これによりプランおよびスタックが復元され、通常のデプロイメントワークフローに戻されます。

使用方法

openstack overcloud update converge [--templates [TEMPLATES]]
                                           [--stack STACK]
                                           [--timeout <TIMEOUT>]
                                           [--control-scale CONTROL_SCALE]
                                           [--compute-scale COMPUTE_SCALE]
                                           [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                           [--block-storage-scale BLOCK_STORAGE_SCALE]
                                           [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                           [--control-flavor CONTROL_FLAVOR]
                                           [--compute-flavor COMPUTE_FLAVOR]
                                           [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                           [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                           [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                           [--libvirt-type {kvm,qemu}]
                                           [--ntp-server NTP_SERVER]
                                           [--no-proxy NO_PROXY]
                                           [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                           [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                           [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                           [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT]
                                           [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]
                                           [--environment-file <HEAT ENVIRONMENT FILE>]
                                           [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                           [--roles-file ROLES_FILE]
                                           [--networks-file NETWORKS_FILE]
                                           [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                           [--no-cleanup] [--update-plan-only]
                                           [--validation-errors-nonfatal]
                                           [--validation-warnings-fatal]
                                           [--disable-validations]
                                           [--inflight-validations]
                                           [--dry-run] [--run-validations]
                                           [--skip-postconfig]
                                           [--force-postconfig]
                                           [--skip-deploy-identifier]
                                           [--answers-file ANSWERS_FILE]
                                           [--disable-password-generation]
                                           [--deployed-server]
                                           [--config-download]
                                           [--no-config-download]
                                           [--config-download-only]
                                           [--output-dir OUTPUT_DIR]
                                           [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                           [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                           [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                           [-b <baremetal_deployment.yaml>]

表57.91 その他の引数 (オプション):

概要

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--stack STACK

作成または更新するスタック名

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--control-scale CONTROL_SCALE

新しいコントロールノード数(非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。このオプションは「U」リリースで削除されます)。

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数(非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。このオプションは「U」リリースで削除されます)。

--ceph-storage-scale CEPH_STORAGE_SCALE

新しいcephストレージノード数(非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--block-storage-scale BLOCK_STORAGE_SCALE

新しいcinderストレージノード数(非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--swift-storage-scale SWIFT_STORAGE_SCALE

新しいswiftストレージノード数(非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用するNovaフレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。このオプションは「U」リリースで削除されます)。

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用するNovaフレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。このオプションは「U」リリースで削除されます)。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。未定義の場合、キーは自動検出されます。

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

オーバークラウドノードへの ssh アクセスに使用するネットワーク名。

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

ssh enable プロセスが完了するまでのタイムアウト。

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

ssh ポートがアクティブになるまで待機するタイムアウト。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは --templates に対する相対パスを指定できます。

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記:今後のリリースでは、別のコマンドに移行します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

--disable-validations

非推奨。デプロイメント前の検証を完全に無効にします。これらの検証は、組み込まれたデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。これらの検証は、tripleo-validations の外部検証により実行されるようになりました。

--inflight-validations

デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。

--dry-run

検証のみを実行しますが、変更は適用されません。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--disable-password-generation

パスワードの生成を無効にします。

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、およびimageサービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--config-download

config-downloadメカニズムを使用してデプロイメントを実行します。これは現在のデフォルトであり、この CLI のオプションは今後廃止される可能性があります。

--no-config-download, --stack-only

config-download ワークフローを無効にして、スタックと関連する OpenStack リソースのみを作成します。ソフトウェア設定は適用されません。

--config-download-only

スタックの作成/更新を無効にして、ソフトウェア設定を適用する config-download ワークフローのみを実行します。

--output-dir OUTPUT_DIR

config-downloadを使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値(/var/lib/mistral/<execution id>)が使用されます。

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Ansible 設定ファイルへのパス。ファイルの設定は、デフォルトで config-download が使用する設定を上書きします。

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

config-download のステップに使用するタイムアウト (分単位)。設定しなければ、スタック操作後の --timeout パラメーターの残り時間にかかわらず、デフォルトがその時間に設定されます。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

デプロイメントアクションに使用する Python インタープリターへのパス。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

ベアメタルデプロイメントを記述する設定ファイル

57.51. overcloud update prepare

オーバークラウドノードの heat スタックの更新を実行して、heat stack の出力を更新します。heat スタックの出力は、後でマイナーアップデートのワークフローを提供する Ansible Playbook を生成するのに使用されます。これは、オーバークラウドのマイナーアップデートの最初のステップとして使用されます。

使用方法

openstack overcloud update prepare [--templates [TEMPLATES]]
                                          [--stack STACK]
                                          [--timeout <TIMEOUT>]
                                          [--control-scale CONTROL_SCALE]
                                          [--compute-scale COMPUTE_SCALE]
                                          [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                          [--block-storage-scale BLOCK_STORAGE_SCALE]
                                          [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                          [--control-flavor CONTROL_FLAVOR]
                                          [--compute-flavor COMPUTE_FLAVOR]
                                          [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                          [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                          [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                          [--libvirt-type {kvm,qemu}]
                                          [--ntp-server NTP_SERVER]
                                          [--no-proxy NO_PROXY]
                                          [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                          [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                          [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                          [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT]
                                          [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]
                                          [--environment-file <HEAT ENVIRONMENT FILE>]
                                          [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                          [--roles-file ROLES_FILE]
                                          [--networks-file NETWORKS_FILE]
                                          [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                          [--no-cleanup] [--update-plan-only]
                                          [--validation-errors-nonfatal]
                                          [--validation-warnings-fatal]
                                          [--disable-validations]
                                          [--inflight-validations] [--dry-run]
                                          [--run-validations]
                                          [--skip-postconfig]
                                          [--force-postconfig]
                                          [--skip-deploy-identifier]
                                          [--answers-file ANSWERS_FILE]
                                          [--disable-password-generation]
                                          [--deployed-server]
                                          [--config-download]
                                          [--no-config-download]
                                          [--config-download-only]
                                          [--output-dir OUTPUT_DIR]
                                          [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                          [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                          [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                          [-b <baremetal_deployment.yaml>]

表57.92 その他の引数 (オプション):

概要

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--stack STACK

作成または更新するスタック名

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--control-scale CONTROL_SCALE

新しいコントロールノード数(非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。このオプションは「U」リリースで削除されます)。

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数(非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。このオプションは「U」リリースで削除されます)。

--ceph-storage-scale CEPH_STORAGE_SCALE

新しいcephストレージノード数(非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--block-storage-scale BLOCK_STORAGE_SCALE

新しいcinderストレージノード数(非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--swift-storage-scale SWIFT_STORAGE_SCALE

新しいswiftストレージノード数(非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用するNovaフレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。このオプションは「U」リリースで削除されます)。

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用するNovaフレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。このオプションは「U」リリースで削除されます)。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。未定義の場合、キーは自動検出されます。

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

オーバークラウドノードへの ssh アクセスに使用するネットワーク名。

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

ssh enable プロセスが完了するまでのタイムアウト。

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

ssh ポートがアクティブになるまで待機するタイムアウト。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは --templates に対する相対パスを指定できます。

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記:今後のリリースでは、別のコマンドに移行します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

--disable-validations

非推奨。デプロイメント前の検証を完全に無効にします。これらの検証は、組み込まれたデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。これらの検証は、tripleo-validations の外部検証により実行されるようになりました。

--inflight-validations

デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。

--dry-run

検証のみを実行しますが、変更は適用されません。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--disable-password-generation

パスワードの生成を無効にします。

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、およびimageサービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--config-download

config-downloadメカニズムを使用してデプロイメントを実行します。これは現在のデフォルトであり、この CLI のオプションは今後廃止される可能性があります。

--no-config-download, --stack-only

config-download ワークフローを無効にして、スタックと関連する OpenStack リソースのみを作成します。ソフトウェア設定は適用されません。

--config-download-only

スタックの作成/更新を無効にして、ソフトウェア設定を適用する config-download ワークフローのみを実行します。

--output-dir OUTPUT_DIR

config-downloadを使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値(/var/lib/mistral/<execution id>)が使用されます。

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Ansible 設定ファイルへのパス。ファイルの設定は、デフォルトで config-download が使用する設定を上書きします。

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

config-download のステップに使用するタイムアウト (分単位)。設定しなければ、スタック操作後の --timeout パラメーターの残り時間にかかわらず、デフォルトがその時間に設定されます。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

デプロイメントアクションに使用する Python インタープリターへのパス。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

ベアメタルデプロイメントを記述する設定ファイル

57.52. overcloud update run

オーバークラウドノードでマイナーアップデート Ansible Playbook を実行します。

使用方法

openstack overcloud update run [-h] --limit LIMIT [--playbook PLAYBOOK]
                                      [--ssh-user SSH_USER]
                                      [--static-inventory STATIC_INVENTORY]
                                      [--stack STACK] [--no-workflow]

表57.93 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit LIMIT

このアップグレード実行呼び出しで、単一ノード、またはカンマ区切りのノードの一覧を特定する文字列。例: --limit "compute-0, compute-1, compute-5"

--playbook PLAYBOOK

マイナーアップデートに使用する Ansible Playbook。デフォルトは特殊な値 all で、すべての更新 Playbook が実行されます。これは、update_steps_playbook.yaml、次にdeploy_steps_playbook.yaml です。手動で実行したい場合は、このコマンドの連続した呼び出しで、これを各 Playbook に設定します。注記:すべてのサービスが更新され、ターゲットバージョンの設定で実行されるように、これらの Playbook の両方を必ず実行してください。

--ssh-user SSH_USER

非推奨:tripleo-admin のみを ssh ユーザーとして使用する必要があります。

--static-inventory STATIC_INVENTORY

使用する既存の Ansible インベントリーへのパス。指定されていない場合は、~/tripleo-ansible- inventory.yaml に生成されます。

--stack STACK

Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME)

--no-workflow

TripleO mistral ワークフローを介して Ansible を実行するのではなく、システムコマンド経由で ansible-playbook を直接実行します。

57.53. overcloud upgrade converge

メジャーアップグレードの収束:保存したプランの Heat リソースをリセットします。これは、オーバークラウドのメジャーアップグレードを完了するための最後のステップです。主なタスクは、プランおよびスタックを更新して、将来のスタック更新のブロックを解除します。メジャーアップグレードのワークフローでは、一部のスタック Heat リソースに特定の値を設定しています。これにより、それらの設定をデフォルト値に戻します。

使用方法

openstack overcloud upgrade converge [--templates [TEMPLATES]]
                                            [--stack STACK]
                                            [--timeout <TIMEOUT>]
                                            [--control-scale CONTROL_SCALE]
                                            [--compute-scale COMPUTE_SCALE]
                                            [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                            [--block-storage-scale BLOCK_STORAGE_SCALE]
                                            [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                            [--control-flavor CONTROL_FLAVOR]
                                            [--compute-flavor COMPUTE_FLAVOR]
                                            [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                            [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                            [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                            [--libvirt-type {kvm,qemu}]
                                            [--ntp-server NTP_SERVER]
                                            [--no-proxy NO_PROXY]
                                            [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                            [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                            [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                            [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT]
                                            [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]
                                            [--environment-file <HEAT ENVIRONMENT FILE>]
                                            [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                            [--roles-file ROLES_FILE]
                                            [--networks-file NETWORKS_FILE]
                                            [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                            [--no-cleanup]
                                            [--update-plan-only]
                                            [--validation-errors-nonfatal]
                                            [--validation-warnings-fatal]
                                            [--disable-validations]
                                            [--inflight-validations]
                                            [--dry-run] [--run-validations]
                                            [--skip-postconfig]
                                            [--force-postconfig]
                                            [--skip-deploy-identifier]
                                            [--answers-file ANSWERS_FILE]
                                            [--disable-password-generation]
                                            [--deployed-server]
                                            [--config-download]
                                            [--no-config-download]
                                            [--config-download-only]
                                            [--output-dir OUTPUT_DIR]
                                            [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                            [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                            [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                            [-b <baremetal_deployment.yaml>]

表57.94 その他の引数 (オプション):

概要

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--stack STACK

作成または更新するスタック名

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--control-scale CONTROL_SCALE

新しいコントロールノード数(非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。このオプションは「U」リリースで削除されます)。

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数(非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。このオプションは「U」リリースで削除されます)。

--ceph-storage-scale CEPH_STORAGE_SCALE

新しいcephストレージノード数(非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--block-storage-scale BLOCK_STORAGE_SCALE

新しいcinderストレージノード数(非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--swift-storage-scale SWIFT_STORAGE_SCALE

新しいswiftストレージノード数(非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用するNovaフレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。このオプションは「U」リリースで削除されます)。

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用するNovaフレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。このオプションは「U」リリースで削除されます)。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。未定義の場合、キーは自動検出されます。

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

オーバークラウドノードへの ssh アクセスに使用するネットワーク名。

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

ssh enable プロセスが完了するまでのタイムアウト。

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

ssh ポートがアクティブになるまで待機するタイムアウト。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは --templates に対する相対パスを指定できます。

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記:今後のリリースでは、別のコマンドに移行します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

--disable-validations

非推奨。デプロイメント前の検証を完全に無効にします。これらの検証は、組み込まれたデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。これらの検証は、tripleo-validations の外部検証により実行されるようになりました。

--inflight-validations

デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。

--dry-run

検証のみを実行しますが、変更は適用されません。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--disable-password-generation

パスワードの生成を無効にします。

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、およびimageサービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--config-download

config-downloadメカニズムを使用してデプロイメントを実行します。これは現在のデフォルトであり、この CLI のオプションは今後廃止される可能性があります。

--no-config-download, --stack-only

config-download ワークフローを無効にして、スタックと関連する OpenStack リソースのみを作成します。ソフトウェア設定は適用されません。

--config-download-only

スタックの作成/更新を無効にして、ソフトウェア設定を適用する config-download ワークフローのみを実行します。

--output-dir OUTPUT_DIR

config-downloadを使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値(/var/lib/mistral/<execution id>)が使用されます。

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Ansible 設定ファイルへのパス。ファイルの設定は、デフォルトで config-download が使用する設定を上書きします。

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

config-download のステップに使用するタイムアウト (分単位)。設定しなければ、スタック操作後の --timeout パラメーターの残り時間にかかわらず、デフォルトがその時間に設定されます。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

デプロイメントアクションに使用する Python インタープリターへのパス。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

ベアメタルデプロイメントを記述する設定ファイル

57.54. overcloud upgrade prepare

オーバークラウドノードの heat スタックの更新を実行して、heat stack の出力を更新します。heat スタックの出力は、後でメジャーアップグレードのワークフローを提供する Ansible Playbook を生成するのに使用されます。これは、オーバークラウドのメジャーアップグレードの最初のステップとして使用されます。

使用方法

openstack overcloud upgrade prepare [--templates [TEMPLATES]]
                                           [--stack STACK]
                                           [--timeout <TIMEOUT>]
                                           [--control-scale CONTROL_SCALE]
                                           [--compute-scale COMPUTE_SCALE]
                                           [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                           [--block-storage-scale BLOCK_STORAGE_SCALE]
                                           [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                           [--control-flavor CONTROL_FLAVOR]
                                           [--compute-flavor COMPUTE_FLAVOR]
                                           [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                           [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                           [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                           [--libvirt-type {kvm,qemu}]
                                           [--ntp-server NTP_SERVER]
                                           [--no-proxy NO_PROXY]
                                           [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                           [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                           [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                           [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT]
                                           [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]
                                           [--environment-file <HEAT ENVIRONMENT FILE>]
                                           [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                           [--roles-file ROLES_FILE]
                                           [--networks-file NETWORKS_FILE]
                                           [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                           [--no-cleanup] [--update-plan-only]
                                           [--validation-errors-nonfatal]
                                           [--validation-warnings-fatal]
                                           [--disable-validations]
                                           [--inflight-validations]
                                           [--dry-run] [--run-validations]
                                           [--skip-postconfig]
                                           [--force-postconfig]
                                           [--skip-deploy-identifier]
                                           [--answers-file ANSWERS_FILE]
                                           [--disable-password-generation]
                                           [--deployed-server]
                                           [--config-download]
                                           [--no-config-download]
                                           [--config-download-only]
                                           [--output-dir OUTPUT_DIR]
                                           [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                           [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                           [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                           [-b <baremetal_deployment.yaml>]

表57.95 その他の引数 (オプション):

概要

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--stack STACK

作成または更新するスタック名

--timeout <TIMEOUT>, -t <TIMEOUT>

デプロイメントのタイムアウト (分単位)

--control-scale CONTROL_SCALE

新しいコントロールノード数(非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。このオプションは「U」リリースで削除されます)。

--compute-scale COMPUTE_SCALE

新しいコンピュートノード数(非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。このオプションは「U」リリースで削除されます)。

--ceph-storage-scale CEPH_STORAGE_SCALE

新しいcephストレージノード数(非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--block-storage-scale BLOCK_STORAGE_SCALE

新しいcinderストレージノード数(非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--swift-storage-scale SWIFT_STORAGE_SCALE

新しいswiftストレージノード数(非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。このオプションは「U」リリースで削除されます)。

--control-flavor CONTROL_FLAVOR

コントロールノードに使用するNovaフレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。このオプションは「U」リリースで削除されます)。

--compute-flavor COMPUTE_FLAVOR

コンピュートノードに使用するNovaフレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。このオプションは「U」リリースで削除されます)。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

cinder ストレージノードに使用する Nova フレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

swift ストレージノードに使用する nova フレーバー(非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。このオプションは「U」リリースで削除されます)。

--libvirt-type {kvm,qemu}

Libvirt ドメインの種別。

--ntp-server NTP_SERVER

オーバークラウドノードの ntp。

--no-proxy NO_PROXY

プロキシーされないホストのコンマ区切りリスト。

--overcloud-ssh-user OVERCLOUD_SSH_USER

オーバークラウドノードへの ssh アクセスのためのユーザー

--overcloud-ssh-key OVERCLOUD_SSH_KEY

オーバークラウドノードへの ssh アクセスに使用する鍵のパス。未定義の場合、キーは自動検出されます。

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

オーバークラウドノードへの ssh アクセスに使用するネットワーク名。

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

ssh enable プロセスが完了するまでのタイムアウト。

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

ssh ポートがアクティブになるまで待機するタイムアウト。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは --templates に対する相対パスを指定できます。

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--no-cleanup

一時ファイルをクリーンアップせず、場所をログとして記録します。

--update-plan-only

プランの更新のみを行います。実際のデプロイメントは実行しません。注記:今後のリリースでは、別のコマンドに移行します。

--validation-errors-nonfatal

検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。

--validation-warnings-fatal

設定の事前チェックで警告がある場合は終了します。

--disable-validations

非推奨。デプロイメント前の検証を完全に無効にします。これらの検証は、組み込まれたデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。これらの検証は、tripleo-validations の外部検証により実行されるようになりました。

--inflight-validations

デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。

--dry-run

検証のみを実行しますが、変更は適用されません。

--run-validations

tripleo-validations プロジェクトからの外部検証を実行します。

--skip-postconfig

オーバークラウドのデプロイ後の設定を省略します。

--force-postconfig

オーバークラウドのデプロイ後の設定を強制的に行います。

--skip-deploy-identifier

DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメントステップは、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。

--answers-file ANSWERS_FILE

引数とパラメーターが記載された YAML ファイルへのパス。

--disable-password-generation

パスワードの生成を無効にします。

--deployed-server

事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、およびimageサービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。

--config-download

config-downloadメカニズムを使用してデプロイメントを実行します。これは現在のデフォルトであり、この CLI のオプションは今後廃止される可能性があります。

--no-config-download, --stack-only

config-download ワークフローを無効にして、スタックと関連する OpenStack リソースのみを作成します。ソフトウェア設定は適用されません。

--config-download-only

スタックの作成/更新を無効にして、ソフトウェア設定を適用する config-download ワークフローのみを実行します。

--output-dir OUTPUT_DIR

config-downloadを使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値(/var/lib/mistral/<execution id>)が使用されます。

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Ansible 設定ファイルへのパス。ファイルの設定は、デフォルトで config-download が使用する設定を上書きします。

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

config-download のステップに使用するタイムアウト (分単位)。設定しなければ、スタック操作後の --timeout パラメーターの残り時間にかかわらず、デフォルトがその時間に設定されます。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

デプロイメントアクションに使用する Python インタープリターへのパス。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

ベアメタルデプロイメントを記述する設定ファイル

57.55. overcloud upgrade run

オーバークラウドノードでメジャーアップグレード Ansible Playbook を実行します。この Playbook は、オーバークラウドでメジャーアップグレード Ansible Playbook を実行します。デフォルトでは、すべての Playbook が実行されます。つまり、upgrade_steps_playbook.yaml、続いて deploy_steps_playbook.yaml、続いて post_upgrade_steps_playbook.yamlが実行されます。overcloud upgrade prepare コマンドの完了後に、アップグレード Playbook が利用可能になります。この overcloud upgrade run コマンドは、メジャーアップグレードのワークフローの 2 番目のステップです。

使用方法

openstack overcloud upgrade run [-h] --limit LIMIT
                                       [--playbook PLAYBOOK]
                                       [--static-inventory STATIC_INVENTORY]
                                       [--ssh-user SSH_USER] [--tags TAGS]
                                       [--skip-tags SKIP_TAGS] [--stack STACK]
                                       [--no-workflow]

表57.96 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit LIMIT

このアップグレード実行の呼び出しで並行してアップグレードされる単一ノードまたはコンマ区切りのノードリストを特定する文字列。例: --limit "compute-0, compute-1, compute-5"

--playbook PLAYBOOK

メジャーアップグレードに使用する Ansible Playbook。デフォルトは特殊な値 all で、すべてのアップグレード Playbook が実行されます。つまり、upgrade_steps_playbook.yaml、続いて deploy_steps_playbook.yaml、続いて post_upgrade_steps_playbook.yamlが実行されます。手動で実行したい場合は、このコマンドの連続した呼び出しで、これを各 Playbook に設定します。注記:すべてのサービスがアップグレードされ、ターゲットバージョンの設定で実行されるように、これらの Playbook のすべてを実行しなければならない場合があります。

--static-inventory STATIC_INVENTORY

使用する既存の Ansible インベントリーへのパス。指定されていない場合は、~/tripleo-ansible- inventory.yaml に生成されます。

--ssh-user SSH_USER

非推奨:tripleo-admin のみを ssh ユーザーとして使用する必要があります。

--tags TAGS

ansible-playbook に --tags として渡すタグまたはタグのコンマ区切りリストを指定する文字列。

--skip-tags SKIP_TAGS

ansible-playbook に --skip-tags として渡すタグまたはタグのコンマ区切りリストを指定する文字列。現在サポートされている値は validation および pre-upgrade です。特に、validationは、アップグレードに失敗した後に再実行する必要があり、一部のサービスが起動できない場合に有用です。

--stack STACK

Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME)

--no-workflow

TripleO mistral ワークフローを介して Ansible を実行するのではなく、システムコマンド経由で ansible-playbook を直接実行します。

第58章 policy

本章では、policy コマンドに含まれるコマンドについて説明します。

58.1. policy create

新規ポリシーを作成します。

使用方法

openstack policy create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--type <type>]
                               <filename>

表58.1 位置引数

概要

<filename>

新しいシリアライズされたポリシールールファイル

表58.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--type <type>

ポリシールールファイルの新しい mime タイプ(デフォルトは application/json)

表58.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表58.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表58.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表58.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

58.2. policy delete

ポリシーを削除します。

使用方法

openstack policy delete [-h] <policy> [<policy> ...]

表58.7 位置引数

概要

<policy>

削除するポリシー

表58.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

58.3. policy list

ポリシーの一覧を表示します。

使用方法

openstack policy list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--long]

表58.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

表58.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表58.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表58.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表58.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

58.4. policy set

ポリシーの属性を設定します。

使用方法

openstack policy set [-h] [--type <type>] [--rules <filename>] <policy>

表58.14 位置引数

概要

<policy>

変更するポリシー

表58.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--type <type>

ポリシールールファイルの新しい mime タイプ

--rules <filename>

新しいシリアライズされたポリシールールファイル

58.5. policy show

ポリシーの詳細を表示します。

使用方法

openstack policy show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <policy>

表58.16 位置引数

概要

<policy>

表示するポリシー

表58.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表58.18 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表58.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表58.20 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表58.21 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第59章 port

本章では、port コマンドに含まれるコマンドについて説明します。

59.1. port create

新規ポートの作成

使用方法

openstack port create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] --network <network>
                             [--description <description>]
                             [--device <device-id>]
                             [--mac-address <mac-address>]
                             [--device-owner <device-owner>]
                             [--vnic-type <vnic-type>] [--host <host-id>]
                             [--dns-domain dns-domain] [--dns-name <dns-name>]
                             [--fixed-ip subnet=<subnet>,ip-address=<ip-address> | --no-fixed-ip]
                             [--binding-profile <binding-profile>]
                             [--enable | --disable]
                             [--enable-uplink-status-propagation | --disable-uplink-status-propagation]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--extra-dhcp-option name=<name>[,value=<value>,ip-version={4,6}]]
                             [--security-group <security-group> | --no-security-group]
                             [--qos-policy <qos-policy>]
                             [--enable-port-security | --disable-port-security]
                             [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
                             [--tag <tag> | --no-tag]
                             <name>

表59.1 位置引数

概要

<name>

このポートの名前

表59.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--network <network>

このポートが属するネットワーク(名前または id)

--description <description>

このポートの説明

--device <device-id>

ポートデバイス ID

--mac-address <mac-address>

このポートの MAC アドレス(管理者のみ)

--device-owner <device-owner>

このポートのデバイス所有者。これは、ポートを使用するエンティティーです(例:network:dhcp)。

--vnic-type <vnic-type>

このポートの vNIC 種別(direct)

direct-physical

macvtap

normal

baremetal

virtio-forwarder, default: normal)

--host <host-id>

ホスト <host-id>でポートを割り当てます(id のみ)。

--dns-domain dns-domain

dns ドメインをこのポートに設定します(ポートに dns_domain 拡張が必要)

--dns-name <dns-name>

このポートの dns 名を設定します(dns 統合拡張が必要です)。

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

このポートに必要な ip やサブネット(名前または id): subnet=<subnet>,ip-address=<ip-address>(複数のFixed IP アドレスを設定する場合はオプションを繰り返し使用します)

--no-fixed-ip

このポートには ip または subnet を設定しません。

--binding-profile <binding-profile>

binding:profile として渡されるカスタムデータ。データは <key>=<value> または JSON として渡されることがあります(複数の binding:profile データを設定する場合はオプションを繰り返し使用します)。

--enable

ポートを有効にします(デフォルト)。

--disable

ポートを無効にします。

--enable-uplink-status-propagation

アップリンクステータス伝播を有効にします。

--disable-uplink-status-propagation

アップリンクステータス伝播を無効にします(デフォルト)。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--extra-dhcp-option name=<name>[,value=<value>,ip-version={4,6}]

このポートに割り当てる追加の dhcp オプション:name=<name>[,value=<value>,ip-version={4,6}](複数の追加 DHCP オプションを設定する場合はオプションを繰り返し使用します)

--security-group <security-group>

このポートに関連付けるセキュリティーグループ(名前または ID)(複数のセキュリティーグループを設定する場合はオプションを繰り返し使用します)

--no-security-group

このポートとはどのセキュリティーグループも関連付けません。

--qos-policy <qos-policy>

このポートに qos ポリシーを割り当てます(名前または id)。

--enable-port-security

このポートのポートセキュリティーを有効にします(デフォルト)。

--disable-port-security

このポートのポートセキュリティーを無効にします。

--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]

このポートに関連付けられる許可アドレスペアを追加します:ip-address=<ip-address>[,mac-address=<mac-address>](複数の許可アドレスペアを設定する場合はオプションを繰り返し使用します)

--tag <tag>

ポートに追加されるタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

表59.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表59.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表59.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

59.2. port delete

ポートを削除します。

使用方法

openstack port delete [-h] <port> [<port> ...]

表59.7 位置引数

概要

<port>

削除するポート(名前または ID)

表59.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

59.3. port list

ポートの一覧を表示します。

使用方法

openstack port list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           [--device-owner <device-owner>]
                           [--network <network>]
                           [--router <router> | --server <server> | --device-id <device-id>]
                           [--mac-address <mac-address>] [--long]
                           [--project <project>]
                           [--project-domain <project-domain>]
                           [--fixed-ip subnet=<subnet>,ip-address=<ip-address>,ip-substring=<ip-substring>]
                           [--tags <tag>[,<tag>,...]]
                           [--any-tags <tag>[,<tag>,...]]
                           [--not-tags <tag>[,<tag>,...]]
                           [--not-any-tags <tag>[,<tag>,...]]

表59.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--device-owner <device-owner>

指定したデバイス所有者のポートのみを一覧表示します。これは、ポートを使用するエンティティーです(例:network:dhcp)。

--network <network>

このネットワークに接続されたポートのみを一覧表示します(名前または ID)。

--router <router>

このルーターに割り当てられたポートのみを一覧表示します(名前または ID)。

--server <server>

このサーバーに割り当てられているポートのみを一覧表示します(名前または ID)。

--device-id <device-id>

指定されたデバイス ID を持つポートのみを一覧表示します。

--mac-address <mac-address>

この mac アドレスを持つポートのみを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--project <project>

プロジェクトに従ってポートを一覧表示します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--fixed-ip subnet=<subnet>,ip-address=<ip-address>,ip-substring=<ip-substring>

ポートの絞り込みに必要な ip やサブネット(名前または id): subnet=<subnet>,ip-address=<ip-address>,ip- substring=<ip-substring>(複数のFixed IP アドレスを設定する場合はオプションを繰り返し使用します)

--tags <tag>[,<tag>,…​]

指定したすべてのタグ(タグのコンマ区切りリスト)が設定されたポートを一覧表示します。

--any-tags <tag>[,<tag>,…​]

指定したタグ(タグのコンマ区切りリスト)のいずれかが設定されたポートを一覧表示します。

--not-tags <tag>[,<tag>,…​]

指定したすべてのタグ(タグのコンマ区切りリスト)が設定されたポートを除外します。

--not-any-tags <tag>[,<tag>,…​]

指定したタグ(タグのコンマ区切りリスト)のいずれかが設定されたポートを除外します。

表59.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表59.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表59.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

59.4. port set

ポートの属性を設定します。

使用方法

openstack port set [-h] [--description <description>]
                          [--device <device-id>] [--mac-address <mac-address>]
                          [--device-owner <device-owner>]
                          [--vnic-type <vnic-type>] [--host <host-id>]
                          [--dns-domain dns-domain] [--dns-name <dns-name>]
                          [--enable | --disable] [--name <name>]
                          [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
                          [--no-fixed-ip]
                          [--binding-profile <binding-profile>]
                          [--no-binding-profile] [--qos-policy <qos-policy>]
                          [--security-group <security-group>]
                          [--no-security-group]
                          [--enable-port-security | --disable-port-security]
                          [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
                          [--no-allowed-address]
                          [--data-plane-status <status>] [--tag <tag>]
                          [--no-tag]
                          <port>

表59.14 位置引数

概要

<port>

変更するポート(名前または ID)

表59.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

このポートの説明

--device <device-id>

ポートデバイス ID

--mac-address <mac-address>

このポートの MAC アドレス(管理者のみ)

--device-owner <device-owner>

このポートのデバイス所有者。これは、ポートを使用するエンティティーです(例:network:dhcp)。

--vnic-type <vnic-type>

このポートの vNIC 種別(direct)

direct-physical

macvtap

normal

baremetal

virtio-forwarder, default: normal)

--host <host-id>

ホスト <host-id>でポートを割り当てます(id のみ)。

--dns-domain dns-domain

dns ドメインをこのポートに設定します(ポートに dns_domain 拡張が必要)

--dns-name <dns-name>

このポートの dns 名を設定します(dns 統合拡張が必要です)。

--enable

ポートを有効にします。

--disable

ポートを無効にします。

--name <name>

ポート名を設定します。

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

このポートに必要な ip やサブネット(名前または id): subnet=<subnet>,ip-address=<ip-address>(複数のFixed IP アドレスを設定する場合はオプションを繰り返し使用します)

--no-fixed-ip

Fixed IP アドレスの既存の情報を消去します。現在のFixed IP アドレスを上書きするには、--fixed-ip と --no-fixed-ip の両方を指定します。

--binding-profile <binding-profile>

binding:profile として渡されるカスタムデータ。データは <key>=<value> または JSON として渡されることがあります(複数の binding:profile データを設定する場合はオプションを繰り返し使用します)。

--no-binding-profile

binding:profile の既存情報を消去します。現在の binding:profile 情報を上書きするには、--binding-profile および --no-binding-profile の両方を指定します。

--qos-policy <qos-policy>

このポートに qos ポリシーを割り当てます(名前または id)。

--security-group <security-group>

このポートに関連付けるセキュリティーグループ(名前または ID)(複数のセキュリティーグループを設定する場合はオプションを繰り返し使用します)

--no-security-group

このポートに関連付けられた既存のセキュリティーグループを消去します。

--enable-port-security

このポートのポートセキュリティーを有効にします。

--disable-port-security

このポートのポートセキュリティーを無効にします。

--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]

このポートに関連付けられる許可アドレスペアを追加します:ip-address=<ip-address>[,mac-address=<mac-address>](複数の許可アドレスペアを設定する場合はオプションを繰り返し使用します)

--no-allowed-address

このポートに関連付けられる既存の許可アドレスのペアを消去します。(現在の許可アドレスのペアを上書きするには、--allowed-address と --no- allowed-address の両方を指定します)

--data-plane-status <status>

このポートのデータプレーンステータスの設定(アクティブ)

down.port unset コマンドを使ってこれを None に設定解除します(データプレーンのステータス拡張機能が必要)

--tag <tag>

ポートに追加されるタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

ポートに関連付けられたタグを消去します。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。

59.5. port show

ポートの詳細を表示します。

使用方法

openstack port show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty]
                           <port>

表59.16 位置引数

概要

<port>

表示するポート(名前または ID)

表59.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表59.18 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表59.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表59.20 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表59.21 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

59.6. port unset

ポート属性の設定を解除します。

使用方法

openstack port unset [-h]
                            [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
                            [--binding-profile <binding-profile-key>]
                            [--security-group <security-group>]
                            [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
                            [--qos-policy] [--data-plane-status]
                            [--tag <tag> | --all-tag]
                            <port>

表59.22 位置引数

概要

<port>

変更するポート(名前または ID)

表59.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

このポート(名前または id)から削除する必要のある ip やサブネット: subnet=<subnet>,ip- address=<ip-address>(複数のFixed IP アドレスの設定を解除する場合はオプションを繰り返し使用します)

--binding-profile <binding-profile-key>

binding:profile から削除される必要のあるキー(複数の binding:profile データの設定を解除する場合はオプションを繰り返し使用します)

--security-group <security-group>

このポートから削除する必要のあるセキュリティーグループ(名前または ID)(複数のセキュリティーグループの設定を解除する場合はオプションを繰り返し使用します)

--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]

このポートから削除する必要のある許可アドレスペア:ip-address=<ip-address>[,mac- address=<mac-address>](複数の許可アドレスペアの設定を解除する場合はオプションを繰り返し使用します)

--qos-policy

ポートに割り当てられた qos ポリシーを削除します。

--data-plane-status

データプレーンステータスの既存情報を消去します。

--tag <tag>

ポートから削除するタグ(複数のタグを削除する場合はオプションを繰り返し使用します)

--all-tag

ポートに関連付けられたすべてのタグを消去します。

第60章 project

本章では、project コマンドに含まれるコマンドについて説明します。

60.1. project create

新規プロジェクトを作成します。

使用方法

openstack project create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--domain <domain>]
                                [--parent <project>]
                                [--description <description>]
                                [--enable | --disable]
                                [--property <key=value>] [--or-show]
                                [--tag <tag>]
                                <project-name>

表60.1 位置引数

概要

<project-name>

新規プロジェクト名

表60.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

プロジェクトを所有するドメイン(名前または ID)

--parent <project>

プロジェクトの親(名前または ID)

--description <description>

プロジェクトの説明

--enable

プロジェクトを有効にします。

--disable

プロジェクトを無効にします。

--property <key=value>

<name> に属性を追加します(複数の属性を設定する場合はオプションを繰り返し使用します)

--or-show

既存のプロジェクトを返します。

--tag <tag>

プロジェクトに追加されるタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

表60.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表60.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表60.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表60.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

60.2. project delete

プロジェクトを削除します。

使用方法

openstack project delete [-h] [--domain <domain>]
                                <project> [<project> ...]

表60.7 位置引数

概要

<project>

削除するプロジェクト(名前または ID)

表60.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

<project> を所有するドメイン(名前または ID)

60.3. project list

プロジェクトを一覧表示します。

使用方法

openstack project list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN] [--domain <domain>]
                              [--user <user>] [--my-projects] [--long]
                              [--sort <key>[:<direction>]]
                              [--tags <tag>[,<tag>,...]]
                              [--tags-any <tag>[,<tag>,...]]
                              [--not-tags <tag>[,<tag>,...]]
                              [--not-tags-any <tag>[,<tag>,...]]

表60.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

<domain>でプロジェクトをフィルターします(名前または id)。

--user <user>

<user>でプロジェクトをフィルターします(名前または id)。

--my-projects

認証されたユーザーのプロジェクトを一覧表示します。他のフィルターよりも優先されます。

--long

出力の追加フィールドを一覧表示します。

--sort <key>[:<direction>]

選択した鍵と方向(asc または desc)で出力をソートします(デフォルト:asc)。複数のキーと方向を指定する場合はこのオプションを繰り返し使用します。

--tags <tag>[,<tag>,…​]

指定したすべてのタグ(タグのコンマ区切りリスト)が設定されたプロジェクトを一覧表示します。

--tags-any <tag>[,<tag>,…​]

指定したタグ(タグのコンマ区切りリスト)のいずれかが設定されたプロジェクトを一覧表示します。

--not-tags <tag>[,<tag>,…​]

指定したすべてのタグ(タグのコンマ区切りリスト)が設定されたプロジェクトを除外します。

--not-tags-any <tag>[,<tag>,…​]

指定したタグ(タグのコンマ区切りリスト)のいずれかが設定されたプロジェクトを除外します。

表60.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表60.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表60.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表60.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

60.4. project purge

プロジェクトに関連付けられたリソースをクリーンアップします。

使用方法

openstack project purge [-h] [--dry-run] [--keep-project]
                               (--auth-project | --project <project>)
                               [--project-domain <project-domain>]

表60.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--dry-run

プロジェクトのリソースを一覧表示します。

--keep-project

プロジェクトのリソースをクリーンアップしますが、プロジェクトは削除しません。

--auth-project

認証に使用するプロジェクトのリソースを削除します。

--project <project>

クリーンアップするプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

60.5. project set

プロジェクトの属性を設定します。

使用方法

openstack project set [-h] [--name <name>] [--domain <domain>]
                             [--description <description>]
                             [--enable | --disable] [--property <key=value>]
                             [--tag <tag>] [--clear-tags] [--remove-tag <tag>]
                             <project>

表60.15 位置引数

概要

<project>

変更するプロジェクト(名前または ID)

表60.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

プロジェクト名を設定します。

--domain <domain>

<project> を所有するドメイン(名前または ID)

--description <description>

プロジェクトの説明を設定します。

--enable

プロジェクトを有効にします。

--disable

プロジェクトを無効にします。

--property <key=value>

<project> に属性を設定します(複数の属性を設定する場合はオプションを繰り返し使用します)。

--tag <tag>

プロジェクトに追加されるタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--clear-tags

プロジェクトに関連付けられたタグを消去します。現在のタグを上書きするには、--tag と --clear-tags の両方を指定します。

--remove-tag <tag>

プロジェクトから削除するタグ(複数のタグを削除する場合はオプションを繰り返し使用します)

60.6. project show

プロジェクトの詳細を表示します。

使用方法

openstack project show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--domain <domain>] [--parents]
                              [--children]
                              <project>

表60.17 位置引数

概要

<project>

表示するプロジェクト(名前または ID)

表60.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

<project> を所有するドメイン(名前または ID)

--parents

プロジェクトの親をリストとして表示します。

--children

プロジェクトのサブツリー(子)を一覧として表示します。

表60.19 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表60.20 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表60.21 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表60.22 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第61章 ptr

本章では、ptr コマンドに含まれるコマンドについて説明します。

61.1. ptr record list

floatingip ptr レコードを一覧表示します。

使用方法

openstack ptr record list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN] [--all-projects]
                                 [--edit-managed]
                                 [--sudo-project-id SUDO_PROJECT_ID]

表61.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表61.2 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表61.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表61.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表61.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

61.2. ptr record set

floatingip ptr レコードを設定します。

使用方法

openstack ptr record set [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                [--description DESCRIPTION | --no-description]
                                [--ttl TTL | --no-ttl] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                floatingip_id ptrdname

表61.6 位置引数

概要

floatingip_id

region:floatingip_id 形式のFloating IP id

ptrdname

Ptrd 名

表61.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description DESCRIPTION

説明

--no-description—​ttl TTL

Ttl

--no-ttl—​all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表61.8 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表61.9 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表61.10 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表61.11 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

61.3. ptr record show

floatingip ptr レコードの詳細を表示します。

使用方法

openstack ptr record show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--all-projects]
                                 [--edit-managed]
                                 [--sudo-project-id SUDO_PROJECT_ID]
                                 floatingip_id

表61.12 位置引数

概要

floatingip_id

region:floatingip_id 形式のFloating IP id

表61.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表61.14 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表61.15 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表61.16 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表61.17 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

61.4. ptr record unset

floatingip ptr レコードの設定を解除します。

使用方法

openstack ptr record unset [-h] [--all-projects] [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  floatingip_id

表61.18 位置引数

概要

floatingip_id

region:floatingip_id 形式のFloating IP id

表61.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

第62章 quota

本章では、quota コマンドに含まれるコマンドについて説明します。

62.1. quota list

デフォルト以外のクォータ値を持つすべてのプロジェクトのクォータを一覧表示します。または、要求されるプロジェクトの詳細なクォータ情報を一覧表示します。

使用方法

openstack quota list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--project <project>] [--detail]
                            (--compute | --volume | --network)

表62.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

このプロジェクト <project>のクォータを一覧表示します(名前または id)。

--detail

クォータの使用状況についての詳細を表示します。

--compute

コンピュートクォータを一覧表示します。

--volume

ボリュームクォータを一覧表示します。

--network

ネットワーククォータを一覧表示します。

表62.2 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表62.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表62.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

62.2. quota set

プロジェクトまたはクラスのクォータを設定します。

使用方法

openstack quota set [-h] [--class] [--cores <cores>]
                           [--fixed-ips <fixed-ips>]
                           [--injected-file-size <injected-file-size>]
                           [--injected-path-size <injected-path-size>]
                           [--injected-files <injected-files>]
                           [--instances <instances>] [--key-pairs <key-pairs>]
                           [--properties <properties>] [--ram <ram>]
                           [--server-groups <server-groups>]
                           [--server-group-members <server-group-members>]
                           [--backups <backups>]
                           [--backup-gigabytes <backup-gigabytes>]
                           [--gigabytes <gigabytes>]
                           [--per-volume-gigabytes <per-volume-gigabytes>]
                           [--snapshots <snapshots>] [--volumes <volumes>]
                           [--floating-ips <floating-ips>]
                           [--secgroup-rules <secgroup-rules>]
                           [--secgroups <secgroups>] [--networks <networks>]
                           [--subnets <subnets>] [--ports <ports>]
                           [--routers <routers>]
                           [--rbac-policies <rbac-policies>]
                           [--subnetpools <subnetpools>]
                           [--volume-type <volume-type>]
                           <project/class>

表62.6 位置引数

概要

<project/class>

このプロジェクトまたはクラスのクォータを設定します(名前/id)。

表62.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--class

<class> のクォータを設定します。

--cores <cores>

coresクォータの新しい値

--fixed-ips <fixed-ips>

fixed-ipsクォータの新しい値

--injected-file-size <injected-file-size>

injected-file-sizeクォータの新しい値

--injected-path-size <injected-path-size>

injected-path-sizeクォータの新しい値

--injected-files <injected-files>

injected-filesクォータの新しい値

--instances <instances>

instancesクォータの新しい値

--key-pairs <key-pairs>

key-pairsクォータの新しい値

--properties <properties>

propertiesクォータの新しい値

--ram <ram>

ram クォータの新しい値

--server-groups <server-groups>

server-groupsクォータの新しい値

--server-group-members <server-group-members>

server-group-membersクォータの新しい値

--backups <backups>

backupsクォータの新しい値

--backup-gigabytes <backup-gigabytes>

backup-gigabytesクォータの新しい値

--gigabytes <gigabytes>

gigabytesクォータの新しい値

--per-volume-gigabytes <per-volume-gigabytes>

per-volume-gigabytesクォータの新しい値

--snapshots <snapshots>

snapshotsクォータの新しい値

--volumes <volumes>

volumesクォータの新しい値

--floating-ips <floating-ips>

floating-ipsクォータの新しい値

--secgroup-rules <secgroup-rules>

secgroup-rules クォータの新しい値

--secgroups <secgroups>

secgroups クォータの新しい値

--networks <networks>

networksクォータの新しい値

--subnets <subnets>

subnetsクォータの新しい値

--ports <ports>

portsクォータの新しい値

--routers <routers>

routersクォータの新しい値

--rbac-policies <rbac-policies>

rbac-policies クォータの新しい値

--subnetpools <subnetpools>

subnetpools クォータの新しい値

--volume-type <volume-type>

特定の <volume-type> のクォータを設定します。

62.3. quota show

プロジェクトまたはクラスのクォータを表示します。特定のクォータクラスの ''server-groups'' および ''server-group-members'' の出力を表示するには、''--os-compute-api-version 2.50'' 以上を指定します。

使用方法

openstack quota show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--class | --default]
                            [<project/class>]

表62.8 位置引数

概要

<project/class>

このプロジェクトまたはクラスのクォータを表示します(名前またはid)。

表62.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--class

<class> のクォータを表示します。

--default

<project> のデフォルトクォータを表示します。

表62.10 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表62.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表62.12 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表62.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第63章 recordset

本章では、recordset コマンドに含まれるコマンドについて説明します。

63.1. recordset create

新規レコードセットを作成します

使用方法

openstack recordset create [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] --record RECORD --type TYPE
                                  [--ttl TTL] [--description DESCRIPTION]
                                  [--all-projects] [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_id name

表63.1 位置引数

概要

zone_id

ゾーンの id

name

レコードセット名

表63.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--record RECORD

レコードセットレコード(必要な場合は繰り返します)

--type TYPE

レコードセットの種別

--ttl TTL

存続期間(秒)

--description DESCRIPTION

説明

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表63.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表63.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表63.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表63.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

63.2. recordset delete

レコードセットを削除します。

使用方法

openstack recordset delete [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_id id

表63.7 位置引数

概要

zone_id

ゾーンの id

id

レコードセットの id

表63.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表63.9 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表63.10 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表63.11 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表63.12 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

63.3. recordset list

レコードセットを一覧表示します。

使用方法

openstack recordset list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--noindent] [--max-width <integer>]
                                [--fit-width] [--print-empty]
                                [--sort-column SORT_COLUMN] [--name NAME]
                                [--type TYPE] [--data DATA] [--ttl TTL]
                                [--description DESCRIPTION] [--status STATUS]
                                [--action ACTION] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                zone_id

表63.13 位置引数

概要

zone_id

ゾーンの id。(全レコードセットを一覧表示するには、all を指定します)

表63.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

レコードセット名

--type TYPE

レコードセットの種別

--data DATA

レコードセットレコードデータ

--ttl TTL

存続期間(秒)

--description DESCRIPTION

説明

--status STATUS

レコードセットステータス

--action ACTION

レコードセットアクション

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表63.15 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表63.16 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表63.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表63.18 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

63.4. recordset set

レコードセットの属性を設定します。

使用方法

openstack recordset set [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--record RECORD]
                               [--description DESCRIPTION | --no-description]
                               [--ttl TTL | --no-ttl] [--all-projects]
                               [--edit-managed]
                               [--sudo-project-id SUDO_PROJECT_ID]
                               zone_id id

表63.19 位置引数

概要

zone_id

ゾーンの id

id

レコードセットの id

表63.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--record RECORD

レコードセットレコード(必要な場合は繰り返します)

--description DESCRIPTION

説明

--no-description—​ttl TTL

Ttl

--no-ttl—​all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表63.21 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表63.22 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表63.23 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表63.24 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

63.5. recordset show

レコードセットの詳細を表示します。

使用方法

openstack recordset show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                zone_id id

表63.25 位置引数

概要

zone_id

ゾーンの id

id

レコードセットの id

表63.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表63.27 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表63.28 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表63.29 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表63.30 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第64章 region

本章では、region コマンドに含まれるコマンドについて説明します。

64.1. region create

新規リージョンを作成します。

使用方法

openstack region create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--parent-region <region-id>]
                               [--description <description>]
                               <region-id>

表64.1 位置引数

概要

<region-id>

新規リージョン ID

表64.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--parent-region <region-id>

親リージョン ID

--description <description>

新規リージョンの説明

表64.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表64.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表64.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表64.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

64.2. region delete

リージョンを削除します。

使用方法

openstack region delete [-h] <region-id> [<region-id> ...]

表64.7 位置引数

概要

<region-id>

削除するリージョン ID

表64.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

64.3. region list

リージョンを一覧表示します。

使用方法

openstack region list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN]
                             [--parent-region <region-id>]

表64.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--parent-region <region-id>

親リージョン ID でフィルターします。

表64.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表64.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表64.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表64.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

64.4. region set

リージョンの属性を設定します。

使用方法

openstack region set [-h] [--parent-region <region-id>]
                            [--description <description>]
                            <region-id>

表64.14 位置引数

概要

<region-id>

変更するリージョン

表64.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--parent-region <region-id>

新規親リージョン ID

--description <description>

新規リージョンの説明

64.5. region show

リージョンの詳細を表示します。

使用方法

openstack region show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <region-id>

表64.16 位置引数

概要

<region-id>

表示するリージョン

表64.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表64.18 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表64.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表64.20 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表64.21 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第65章 registered

本章では、registered コマンドに含まれるコマンドについて説明します。

65.1. registered limit create

登録された制限を作成します。

使用方法

openstack registered limit create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         [--description <description>]
                                         [--region <region>] --service
                                         <service> --default-limit
                                         <default-limit>
                                         <resource-name>

表65.1 位置引数

概要

<resource-name>

制限するリソースの名前

表65.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

登録された制限の説明

--region <region>

影響する登録された制限のリージョン

--service <service>

制限するリソースに対応するサービス(必須)

--default-limit <default-limit>

仮定するリソースのデフォルトの制限(必須)

表65.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表65.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表65.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表65.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

65.2. registered limit delete

登録された制限を削除します。

使用方法

openstack registered limit delete [-h]
                                         <registered-limit-id>
                                         [<registered-limit-id> ...]

表65.7 位置引数

概要

<registered-limit-id>

削除する登録された制限(id)

表65.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

65.3. registered limit list

登録された制限を一覧表示します。

使用方法

openstack registered limit list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--service <service>]
                                       [--resource-name <resource-name>]
                                       [--region <region>]

表65.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--service <service>

制限するリソースに関するサービス

--resource-name <resource-name>

制限するリソースの名前

--region <region>

影響する制限のリージョン。

表65.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表65.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表65.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表65.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

65.4. registered limit set

登録された制限に関する情報を更新します。

使用方法

openstack registered limit set [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--service <service>]
                                      [--resource-name <resource-name>]
                                      [--default-limit <default-limit>]
                                      [--description <description>]
                                      [--region <region>]
                                      <registered-limit-id>

表65.14 位置引数

概要

<registered-limit-id>

更新する登録された制限(id)

表65.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--service <service>

制限するリソースに対応する更新するサービス--service、--resource-name、または --region のいずれかは既存の値とは異なる値である必要があります。そうでないと、重複したエントリーになります。

--resource-name <resource-name>

制限するリソースに対応する更新するリソース--service、--resource-name、または --region のいずれかは既存の値とは異なる値である必要があります。そうでないと、重複したエントリーになります。

--default-limit <default-limit>

仮定するリソースのデフォルトの制限

--description <description>

登録された制限に関する更新する説明

--region <region>

影響する登録された制限のリージョン。--service、--resource-name、または --region のいずれかは既存の値とは異なる値である必要があります。そうでないと、重複したエントリーになります。

表65.16 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表65.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表65.18 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表65.19 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

65.5. registered limit show

登録された制限の詳細を表示します。

使用方法

openstack registered limit show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <registered-limit-id>

表65.20 位置引数

概要

<registered-limit-id>

表示する登録された制限(id)

表65.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表65.22 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表65.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表65.24 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表65.25 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第66章 request

本章では、request コマンドに含まれるコマンドについて説明します。

66.1. request token authorize

リクエストトークンを承認します。

使用方法

openstack request token authorize [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty] --request-key
                                         <request-key> --role <role>

表66.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--request-key <request-key>

承認するリクエストトークン(idのみ)(必須)

--role <role>

承認するロール (名前または ID) (複数の値を設定する場合はオプションを繰り返し使用します)(必須)

表66.2 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表66.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表66.4 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表66.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

66.2. request token create

リクエストトークンを作成します。

使用方法

openstack request token create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] --consumer-key
                                      <consumer-key> --consumer-secret
                                      <consumer-secret> --project <project>
                                      [--domain <domain>]

表66.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--consumer-key <consumer-key>

コンシューマーキー (必須)

--consumer-secret <consumer-secret>

コンシューマーシークレット (必須)

--project <project>

コンシューマーがアクセスするプロジェクト(名前または ID)(必須)

--domain <domain>

<project> を所有するドメイン(名前または ID)

表66.7 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表66.8 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表66.9 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表66.10 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第67章 resource

本章では、resource コマンドに含まれるコマンドについて説明します。

67.1. resource member create

リソースを別のプロジェクトと共有します。

使用方法

openstack resource member create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        resource_id resource_type member_id

表67.1 位置引数

概要

resource_id

共有されるリソース ID。

resource_type

リソースタイプ。

member_id

リソースを共有するプロジェクト ID。

表67.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表67.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表67.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表67.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表67.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

67.2. resource member delete

リソース共有の関係を削除します。

使用方法

openstack resource member delete [-h] resource resource_type member_id

表67.7 位置引数

概要

resource

共有されるリソース ID。

resource_type

リソースタイプ。

member_id

リソースを共有するプロジェクト ID。

表67.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

67.3. resource member list

すべてのメンバーを一覧表示します。

使用方法

openstack resource member list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--marker [MARKER]] [--limit [LIMIT]]
                                      [--sort_keys [SORT_KEYS]]
                                      [--sort_dirs [SORT_DIRS]]
                                      [--filter FILTERS]
                                      resource_id resource_type

表67.9 位置引数

概要

resource_id

共有されるリソース ID。

resource_type

リソースタイプ。

表67.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

表67.11 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表67.12 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表67.13 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表67.14 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

67.4. resource member show

特定のメンバーの情報を表示します。

使用方法

openstack resource member show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [-m MEMBER_ID]
                                      resource resource_type

表67.15 位置引数

概要

resource

共有されるリソース ID。

resource_type

リソースタイプ。

表67.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-m MEMBER_ID、--member-id MEMBER_ID

リソースを共有するプロジェクト ID。リソースメンバーの場合には、このパラメーターを指定する必要はありません。

表67.17 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表67.18 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表67.19 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表67.20 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

67.5. resource member update

リソース共有のステータスを更新します。

使用方法

openstack resource member update [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [-m MEMBER_ID]
                                        [-s {pending,accepted,rejected}]
                                        resource_id resource_type

表67.21 位置引数

概要

resource_id

共有されるリソース ID。

resource_type

リソースタイプ。

表67.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-m MEMBER_ID、--member-id MEMBER_ID

リソースを共有するプロジェクト ID。リソースメンバーの場合には、このパラメーターを指定する必要はありません。

-s {pending,accepted,rejected}, --status {pending,accepted,rejected}

共有のステータス。

表67.23 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表67.24 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表67.25 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表67.26 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第68章 role

本章では、role コマンドに含まれるコマンドについて説明します。

68.1. role add

システム、ドメイン、またはプロジェクトのユーザーまたはグループにロール割り当てを追加します。

使用方法

openstack role add [-h]
                          [--system <system> | --domain <domain> | --project <project>]
                          [--user <user> | --group <group>]
                          [--group-domain <group-domain>]
                          [--project-domain <project-domain>]
                          [--user-domain <user-domain>] [--inherited]
                          [--role-domain <role-domain>]
                          <role>

表68.1 位置引数

概要

<role>

<user>に追加するロール(名前または ID)

表68.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--system <system>

<system>(すべて)を含めます。

--domain <domain>

<domain>を含めます(名前または ID)。

--project <project>

<project>を含めます(名前または ID)。

--user <user>

<user>を含めます(名前または ID)。

--group=GROUP

<group>を含めます(名前または ID)。

--group-domain <group-domain>

グループが所属するドメイン(名前または ID)。グループ名の競合が発生した場合に、使用できます。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

--inherited

ロールの付与がサブプロジェクトに継承できるかどうかを指定します。

--role-domain <role-domain>

ロールが属するドメイン(名前または ID)。これは、ドメイン固有のロール名が使用される場合に指定する必要があります。

68.2. role assignment list

ロールの割り当てを一覧表示します。

使用方法

openstack role assignment list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--effective] [--role <role>]
                                      [--role-domain <role-domain>] [--names]
                                      [--user <user>]
                                      [--user-domain <user-domain>]
                                      [--group <group>]
                                      [--group-domain <group-domain>]
                                      [--domain <domain> | --project <project> | --system <system>]
                                      [--project-domain <project-domain>]
                                      [--inherited] [--auth-user]
                                      [--auth-project]

表68.3 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--effective

有効なロール割り当てのみを返します。

--role <role>

フィルターするロール(名前または ID)

--role-domain <role-domain>

ロールが属するドメイン(名前または ID)。これは、ドメイン固有のロール名が使用される場合に指定する必要があります。

--names

id ではなく名前を表示します。

--user <user>

フィルターするユーザー(名前または ID)

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

--group=GROUP

フィルターするグループ(名前または ID)

--group-domain <group-domain>

グループが所属するドメイン(名前または ID)。グループ名の競合が発生した場合に、使用できます。

--domain <domain>

フィルターするドメイン(名前または ID)

--project <project>

フィルターするプロジェクト(名前または ID)

--system <system>

システムロールの割り当てに基づいてフィルターします。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--inherited

ロールの付与がサブプロジェクトに継承できるかどうかを指定します。

--auth-user

認証済みユーザーの割り当てのみを一覧表示します。

--auth-project

認証されたユーザーのトークンがスコープ設定されているプロジェクトの割り当てのみを一覧表示します。

表68.4 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表68.5 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表68.6 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表68.7 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

68.3. role create

新規ロールを作成します。

使用方法

openstack role create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--domain <domain>] [--or-show]
                             <role-name>

表68.8 位置引数

概要

<role-name>

新しいロール名

表68.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

ロールが属するドメイン(名前または id)

--or-show

既存のロールを返します。

表68.10 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表68.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表68.12 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表68.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

68.4. role delete

ロールを削除します。

使用方法

openstack role delete [-h] [--domain <domain>] <role> [<role> ...]

表68.14 位置引数

概要

<role>

削除するロール(名前または ID)

表68.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

ロールが属するドメイン(名前または id)

68.5. role list

ロールを一覧表示します。

使用方法

openstack role list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           [--domain <domain>]

表68.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

<domain>を含めます(名前または ID)。

表68.17 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表68.18 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表68.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表68.20 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

68.6. role remove

システム/ドメイン/プロジェクトからロールの割り当て(ユーザー/グループ)を削除します。

使用方法

openstack role remove [-h]
                             [--system <system> | --domain <domain> | --project <project>]
                             [--user <user> | --group <group>]
                             [--group-domain <group-domain>]
                             [--project-domain <project-domain>]
                             [--user-domain <user-domain>] [--inherited]
                             [--role-domain <role-domain>]
                             <role>

表68.21 位置引数

概要

<role>

削除するロール(名前または ID)

表68.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--system <system>

<system>(すべて)を含めます。

--domain <domain>

<domain>を含めます(名前または ID)。

--project <project>

<project>を含めます(名前または ID)。

--user <user>

<user>を含めます(名前または ID)。

--group=GROUP

<group>を含めます(名前または ID)。

--group-domain <group-domain>

グループが所属するドメイン(名前または ID)。グループ名の競合が発生した場合に、使用できます。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

--inherited

ロールの付与がサブプロジェクトに継承できるかどうかを指定します。

--role-domain <role-domain>

ロールが属するドメイン(名前または ID)。これは、ドメイン固有のロール名が使用される場合に指定する必要があります。

68.7. role set

ロールの属性を設定します。

使用方法

openstack role set [-h] [--domain <domain>] [--name <name>] <role>

表68.23 位置引数

概要

<role>

変更するロール(名前または ID)

表68.24 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

ロールが属するドメイン(名前または id)

--name <name>

ロール名を設定します。

68.8. role show

ロールの詳細を表示します。

使用方法

openstack role show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--domain <domain>]
                           <role>

表68.25 位置引数

概要

<role>

表示するロール(名前または ID)

表68.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

ロールが属するドメイン(名前または id)

表68.27 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表68.28 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表68.29 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表68.30 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第69章 ルーター

本章では、router コマンドに含まれるコマンドについて説明します。

69.1. router add port

ルーターにポートを追加します。

使用方法

openstack router add port [-h] <router> <port>

表69.1 位置引数

概要

<router>

ポートが追加されるルーター(名前または ID)

<port>

追加するポート(名前または ID)

表69.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

69.2. router add subnet

ルーターにサブネットを追加します。

使用方法

openstack router add subnet [-h] <router> <subnet>

表69.3 位置引数

概要

<router>

サブネットを追加するルーター(名前または ID)

<subnet>

追加するサブネット(名前または ID)

表69.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

69.3. router create

新規ルーターを作成します。

使用方法

openstack router create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--enable | --disable]
                               [--distributed | --centralized]
                               [--ha | --no-ha] [--description <description>]
                               [--project <project>]
                               [--project-domain <project-domain>]
                               [--availability-zone-hint <availability-zone>]
                               [--tag <tag> | --no-tag]
                               <name>

表69.5 位置引数

概要

<name>

新しいルーター名

表69.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--enable

ルーターを有効にします(デフォルト)。

--disable

ルーターを無効にします。

--distributed

分散ルーターを作成します。

--centralized

集中ルーターを作成します。

--ha

高可用性ルーターを作成します。

--no-ha

レガシーのルーターを作成します。

--description <description>

ルーターの説明を設定します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--availability-zone-hint <availability-zone>

このルーターを作成するアベイラビリティーゾーン(Router Availability Zone 拡張機能が必要、複数のアベイラビリティーゾーンに設定するにはオプションを繰り返します)

--tag <tag>

ルーターに追加するタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

ルーターにタグを関連付けません。

表69.7 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表69.8 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表69.9 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表69.10 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

69.4. router delete

ルーターを削除します。

使用方法

openstack router delete [-h] <router> [<router> ...]

表69.11 位置引数

概要

<router>

削除するルーター(名前または ID)

表69.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

69.5. router list

ルーターを一覧表示します。

使用方法

openstack router list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--name <name>]
                             [--enable | --disable] [--long]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--agent <agent-id>] [--tags <tag>[,<tag>,...]]
                             [--any-tags <tag>[,<tag>,...]]
                             [--not-tags <tag>[,<tag>,...]]
                             [--not-any-tags <tag>[,<tag>,...]]

表69.13 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

名前に従ってルーターを一覧表示します。

--enable

有効なルーターを一覧表示します。

--disable

無効なルーターを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

--project <project>

プロジェクトに従ってルーターを一覧表示します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--agent <agent-id>

エージェントがホストする ルーターを一覧表示します(ID のみ)

--tags <tag>[,<tag>,…​]

指定したすべてのタグ(タグのコンマ区切りリスト)が設定されたルーターを一覧表示します。

--any-tags <tag>[,<tag>,…​]

指定したタグ(タグのコンマ区切りリスト)のいずれかが設定されたルーターを一覧表示します。

--not-tags <tag>[,<tag>,…​]

指定したすべてのタグ(タグのコンマ区切りリスト)が設定されたルーターを除外します。

--not-any-tags <tag>[,<tag>,…​]

指定したタグ(タグのコンマ区切りリスト)のいずれかが設定されたルーターを除外します。

表69.14 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表69.15 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表69.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表69.17 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

69.6. router remove port

ルーターからポートを削除します。

使用方法

openstack router remove port [-h] <router> <port>

表69.18 位置引数

概要

<router>

ポートを削除するルーター(名前または ID)

<port>

削除および削除されるポート(名前または ID)

表69.19 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

69.7. router remove subnet

ルーターからサブネットを削除します。

使用方法

openstack router remove subnet [-h] <router> <subnet>

表69.20 位置引数

概要

<router>

サブネットが削除されるルーター(名前または ID)

<subnet>

削除するサブネット(名前または ID)

表69.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

69.8. router set

ルーターの属性を設定します。

使用方法

openstack router set [-h] [--name <name>] [--description <description>]
                            [--enable | --disable]
                            [--distributed | --centralized]
                            [--route destination=<subnet>,gateway=<ip-address>]
                            [--no-route] [--ha | --no-ha]
                            [--external-gateway <network>]
                            [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
                            [--enable-snat | --disable-snat]
                            [--qos-policy <qos-policy> | --no-qos-policy]
                            [--tag <tag>] [--no-tag]
                            <router>

表69.22 位置引数

概要

<router>

変更するルーター(名前または ID)

表69.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ルーター名を設定します。

--description <description>

ルーターの説明を設定します。

--enable

ルーターを有効にします。

--disable

ルーターを無効にします。

--distributed

ルーターを分散モードに設定します(無効なルーターのみ)。

--centralized

ルーターを集中モードに設定します(無効なルーターのみ)。

--route destination=<subnet>,gateway=<ip-address>

ルーターの宛先に関連付けられたルート:宛先サブネット(CIDR 表記)ゲートウェイ:nexthop IP アドレス(複数のルートを設定する場合はオプションを繰り返し使用します)

--no-route

ルーターに関連付けられたルートを消去します。ルートの現在の値を上書きするには、--route と --no-route の両方を指定します。

--ha

ルーターを高可用性として設定します(無効なルーターのみ)。

--no-ha

ルーターの高可用性属性を消去します(無効ルーターのみ)。

--external-gateway <network>

ルーターのゲートウェイとして使用する外部ネットワーク(名前または ID)

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

外部ゲートウェイの必要な ip やサブネット(名前または id): subnet=<subnet>,ip-address=<ip-address>(複数のFixed IP アドレスを設定する場合はオプションを繰り返し使用します)

--enable-snat

外部ゲートウェイでソース nat を有効にします。

--disable-snat

外部ゲートウェイでソース nat を無効にします。

--qos-policy <qos-policy>

qos ポリシーをルーターゲートウェイ IP に割り当てます。

--no-qos-policy

ルーターゲートウェイ ip から qos ポリシーを削除します。

--tag <tag>

ルーターに追加するタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

ルーターに関連付けられたタグを消去します。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。

69.9. router show

ルーターの詳細を表示します。

使用方法

openstack router show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <router>

表69.24 位置引数

概要

<router>

表示するルーター(名前または ID)

表69.25 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表69.26 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表69.27 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表69.28 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表69.29 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

69.10. router unset

ルーター属性の設定を解除します。

使用方法

openstack router unset [-h]
                              [--route destination=<subnet>,gateway=<ip-address>]
                              [--external-gateway] [--qos-policy]
                              [--tag <tag> | --all-tag]
                              <router>

表69.30 位置引数

概要

<router>

変更するルーター(名前または ID)

表69.31 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--route destination=<subnet>,gateway=<ip-address>

ルーターの宛先から削除されるルート:宛先サブネット(CIDR 表記)ゲートウェイ:nexthop IP アドレス(複数ルートの設定を解除する場合はオプションを繰り返し使用します)

--external-gateway

ルーターから外部ゲートウェイ情報を削除します。

--qos-policy

ルーターゲートウェイ ip から qos ポリシーを削除します。

--tag <tag>

ルーターから削除するタグ(複数のタグを削除する場合はオプションを繰り返し使用します)

--all-tag

ルーターに関連付けられたすべてのタグを消去します。

第70章 secret

本章では、secret コマンドに含まれるコマンドについて説明します。

70.1. secret container create

Barbican にコンテナーを保存します。

使用方法

openstack secret container create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty] [--name NAME]
                                         [--type TYPE] [--secret SECRET]

表70.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME, -n NAME

人間に分かりやすい名前。

--type TYPE

作成するコンテナーの種別(デフォルト:generic)。

--secret SECRET, -s SECRET

コンテナーに保存する 1 つのシークレット(複数回設定できます)。例:--secret "private_key=https://url.test/v1/secrets/1-2-3-4"

表70.2 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表70.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表70.4 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表70.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

70.2. secret container delete

href を指定してコンテナーを削除します。

使用方法

openstack secret container delete [-h] URI

表70.6 位置引数

概要

URI

コンテナーの uri 参照

表70.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

70.3. secret container get

URI を指定してコンテナーを取得します。

使用方法

openstack secret container get [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      URI

表70.8 位置引数

概要

URI

コンテナーの uri 参照。

表70.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表70.10 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表70.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表70.12 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表70.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

70.4. secret container list

コンテナーを一覧表示します。

使用方法

openstack secret container list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--limit LIMIT] [--offset OFFSET]
                                       [--name NAME] [--type TYPE]

表70.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit LIMIT, -l LIMIT

ページごとに表示する項目数に制限を指定します(デフォルト:10、最大: 100)。

--offset OFFSET, -o OFFSET

ページのオフセットを指定します(デフォルト:0)。

--name NAME, -n NAME

コンテナー名を指定します(デフォルト:none)。

--type TYPE、-t TYPE

リストのタイプフィルターを指定します(デフォルト:none)。

表70.15 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表70.16 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表70.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表70.18 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

70.5. secret delete

URI を指定してシークレットを削除します。

使用方法

openstack secret delete [-h] URI

表70.19 位置引数

概要

URI

シークレットの uri 参照

表70.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

70.6. secret get

URI を指定してシークレットを取得します。

使用方法

openstack secret get [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty]
                            [--decrypt | --payload | --file <filename>]
                            [--payload_content_type PAYLOAD_CONTENT_TYPE]
                            URI

表70.21 位置引数

概要

URI

シークレットの uri 参照。

表70.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--decrypt, -d

指定されている場合、暗号化されていないシークレットデータを取得します。

--payload, -p

指定されている場合、暗号化されていないシークレットデータを取得します。

--file <filename>、-F <filename>

指定した場合は、指定したファイル名で新しいファイルにペイロードを保存します。

--payload_content_type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

復号化されたシークレットのコンテンツ種別(デフォルト:text/plain)。

表70.23 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表70.24 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表70.25 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表70.26 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

70.7. secret list

シークレットを一覧表示します。

使用方法

openstack secret list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--limit LIMIT]
                             [--offset OFFSET] [--name NAME]
                             [--algorithm ALGORITHM] [--bit-length BIT_LENGTH]
                             [--mode MODE] [--secret-type SECRET_TYPE]

表70.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit LIMIT, -l LIMIT

ページごとに表示する項目数に制限を指定します(デフォルト:10、最大: 100)。

--offset OFFSET, -o OFFSET

ページのオフセットを指定します(デフォルト:0)。

--name NAME, -n NAME

シークレット名を指定します (デフォルト: none)

--algorithm ALGORITHM、-a ALGORITHM

リストのアルゴリズムフィルター (デフォルト: none)

--bit-length BIT_LENGTH, -b BIT_LENGTH

リストのビット長フィルター(デフォルト:0)。

--mode MODE、-m MODE

リストのアルゴリズムモードフィルター(デフォルト:None)。

--secret-type SECRET_TYPE, -s SECRET_TYPE

シークレットの種別を指定します(デフォルト: none)。

表70.28 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表70.29 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表70.30 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表70.31 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

70.8. secret order create

新しい順序を作成します。

使用方法

openstack secret order create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--name NAME] [--algorithm ALGORITHM]
                                     [--bit-length BIT_LENGTH] [--mode MODE]
                                     [--payload-content-type PAYLOAD_CONTENT_TYPE]
                                     [--expiration EXPIRATION]
                                     [--request-type REQUEST_TYPE]
                                     [--subject-dn SUBJECT_DN]
                                     [--source-container-ref SOURCE_CONTAINER_REF]
                                     [--ca-id CA_ID] [--profile PROFILE]
                                     [--request-file REQUEST_FILE]
                                     type

表70.32 位置引数

概要

type

作成する順序の種別(鍵、非対称、証明書)。

表70.33 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME, -n NAME

人間に分かりやすい名前。

--algorithm ALGORITHM、-a ALGORITHM

要求されたキーで使用されるアルゴリズム(デフォルト:aes)

--bit-length BIT_LENGTH, -b BIT_LENGTH

要求されるシークレットキーのビット長(デフォルト:256)。

--mode MODE、-m MODE

要求されたキーで使用されるアルゴリズムモード(デフォルト:cbc)

--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

生成されるシークレットの種別/形式(デフォルト:application/octet-stream)。

--expiration EXPIRATION、-x EXPIRATION

iso 8601 形式のシークレットの有効期限

--request-type REQUEST_TYPE

証明書要求の種別。

--subject-dn SUBJECT_DN

証明書のサブジェクト。

--source-container-ref SOURCE_CONTAINER_REF

stored-key 要求を使用する際の証明書のソース。

--ca-id CA_ID

証明書要求に使用する ca の識別子。

--profile PROFILE

使用する証明書のプロファイル。

--request-file REQUEST_FILE

csr が含まれるファイル。

表70.34 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表70.35 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表70.36 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表70.37 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

70.9. secret order delete

href を指定して順序を削除します。

使用方法

openstack secret order delete [-h] URI

表70.38 位置引数

概要

URI

順序の URI 参照

表70.39 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

70.10. secret order get

URI を指定して順序を取得します。

使用方法

openstack secret order get [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  URI

表70.40 位置引数

概要

URI

uri 参照の順序。

表70.41 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表70.42 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表70.43 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表70.44 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表70.45 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

70.11. secret order list

順序を一覧表示します。

使用方法

openstack secret order list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN] [--limit LIMIT]
                                   [--offset OFFSET]

表70.46 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit LIMIT, -l LIMIT

ページごとに表示する項目数に制限を指定します(デフォルト:10、最大: 100)。

--offset OFFSET, -o OFFSET

ページのオフセットを指定します(デフォルト:0)。

表70.47 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表70.48 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表70.49 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表70.50 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

70.12. secret store

Barbican にシークレットを保存します。

使用方法

openstack secret store [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--name NAME]
                              [--secret-type SECRET_TYPE]
                              [--payload-content-type PAYLOAD_CONTENT_TYPE]
                              [--payload-content-encoding PAYLOAD_CONTENT_ENCODING]
                              [--algorithm ALGORITHM]
                              [--bit-length BIT_LENGTH] [--mode MODE]
                              [--expiration EXPIRATION]
                              [--payload PAYLOAD | --file <filename>]

表70.51 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME, -n NAME

人間に分かりやすい名前。

--secret-type SECRET_TYPE, -s SECRET_TYPE

シークレットの種別。symmetric、public、private、certificate、passphrase、opaque (デフォルト)のいずれかでなければなりません。

--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

提供されたシークレットデータの種別/フォーマット。"text/plain" は UTF-8 であると想定されます。--payload が指定されている場合は必須です。

--payload-content-encoding PAYLOAD_CONTENT_ENCODING, -e PAYLOAD_CONTENT_ENCODING

--payload-content-type が "application/octet-stream" の場合は必須です。

--algorithm ALGORITHM、-a ALGORITHM

アルゴリズム(デフォルト:aes)

--bit-length BIT_LENGTH, -b BIT_LENGTH

ビットの長さ(デフォルト:256)。

--mode MODE、-m MODE

アルゴリズムモード。参照用にのみ使用されます(デフォルト:cbc)

--expiration EXPIRATION、-x EXPIRATION

iso 8601 形式のシークレットの有効期限

--payload PAYLOAD、-p PAYLOAD

暗号化されていないシークレットデータ。

--file <filename>、-F <filename>

シークレットペイロードが含まれるファイル

表70.52 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表70.53 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表70.54 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表70.55 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

70.13. secret update

Barbican のペイロードなしでシークレットを更新します。

使用方法

openstack secret update [-h] URI payload

表70.56 位置引数

概要

URI

シークレットの uri 参照。

payload

暗号化されていないシークレット

表70.57 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

第71章 security

本章では、security コマンドに含まれるコマンドについて説明します。

71.1. security group create

新しいセキュリティーグループを作成します。

使用方法

openstack security group create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--description <description>]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       [--tag <tag> | --no-tag]
                                       <name>

表71.1 位置引数

概要

<name>

新しいセキュリティーグループ名

表71.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

セキュリティーグループの説明

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--tag <tag>

セキュリティーグループに追加するタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

セキュリティーグループにタグを関連付けません。

表71.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表71.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

71.2. security group delete

セキュリティーグループを削除します。

使用方法

openstack security group delete [-h] <group> [<group> ...]

表71.7 位置引数

概要

<group>

削除するセキュリティーグループ(名前または ID)

表71.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

71.3. security group list

セキュリティーグループを一覧表示します。

使用方法

openstack security group list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--project <project>]
                                     [--project-domain <project-domain>]
                                     [--tags <tag>[,<tag>,...]]
                                     [--any-tags <tag>[,<tag>,...]]
                                     [--not-tags <tag>[,<tag>,...]]
                                     [--not-any-tags <tag>[,<tag>,...]]

表71.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

プロジェクトに従ってセキュリティーグループを一覧表示します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--tags <tag>[,<tag>,…​]

指定されたタグ(タグのコンマ区切りリスト)がすべて割り当てられたセキュリティーグループを一覧表示します。

--any-tags <tag>[,<tag>,…​]

指定されたタグ(タグのコンマ区切りリスト)のいずれかが割り当てられたセキュリティーグループを一覧表示します。

--not-tags <tag>[,<tag>,…​]

指定されたタグ(タグのコンマ区切りリスト)がすべて割り当てられたセキュリティーグループを除外します。

--not-any-tags <tag>[,<tag>,…​]

指定されたタグ(タグのコンマ区切りリスト)のいずれかが割り当てられたセキュリティーグループを除外します。

表71.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表71.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表71.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

71.4. security group rule create

新しいセキュリティーグループルールを作成します。

使用方法

openstack security group rule create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--remote-ip <ip-address> | --remote-group <group>]
                                            [--description <description>]
                                            [--dst-port <port-range>]
                                            [--icmp-type <icmp-type>]
                                            [--icmp-code <icmp-code>]
                                            [--protocol <protocol>]
                                            [--ingress | --egress]
                                            [--ethertype <ethertype>]
                                            [--project <project>]
                                            [--project-domain <project-domain>]
                                            <group>

表71.14 位置引数

概要

<group>

このセキュリティーグループにルールを作成します(名前または ID)。

表71.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--remote-ip <ip-address>

リモート IP アドレスブロック(cidr 表記を使用することができます。IPv4 ルールのデフォルト:0.0.0.0/0、IPv6 ルールのデフォルト:::/0)

--remote-group <group>

リモートセキュリティーグループ(名前または ID)

--description <description>

セキュリティーグループルールの説明を設定します。

--dst-port <port-range>

宛先ポート。単一ポートまたはポート範囲の始点および終点を指定できます: 137:139IP プロトコル TCP および UDP に必須です。ICMP IP プロトコルでは無視されます。

--icmp-type <icmp-type>

icmp ip プロトコルの ICMP 種別

--icmp-code <icmp-code>

icmp ip プロトコルの ICMP コード

--protocol <protocol>

IP プロトコル (ah、dccp、egp、esp、gre、icmp、igmp、ipv6-encap、ipv6-frag、ipv6-icmp、ipv6-nonxt、ipv6-opts、ipv6-route、ospf、pgm、rsvp、sctp、tcp、udp、udplite、vrrp、および integer 表現 [0-255] または any。デフォルト: any (すべてのプロトコル))

--ingress

受信ネットワークトラフィックに適用されるルール(デフォルト)

--egress

送信ネットワークトラフィックに適用されるルール

--ethertype <ethertype>

ネットワークトラフィックの ethertype(ipv4、ipv6。デフォルト: IP プロトコルに基づく)

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表71.16 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.18 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表71.19 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

71.5. security group rule delete

セキュリティーグループルールを削除します。

使用方法

openstack security group rule delete [-h] <rule> [<rule> ...]

表71.20 位置引数

概要

<rule>

削除するセキュリティーグループルール(id のみ)

表71.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

71.6. security group rule list

セキュリティーグループルールを一覧表示します。

使用方法

openstack security group rule list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          [--protocol <protocol>]
                                          [--ethertype <ethertype>]
                                          [--ingress | --egress] [--long]
                                          [<group>]

表71.22 位置引数

概要

<group>

このセキュリティーグループのすべてのルールを一覧表示します(名前または ID)。

表71.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--protocol <protocol>

IP プロトコル (ah、dccp、egp、esp、gre、icmp、igmp、ipv6-encap、ipv6-frag、ipv6-icmp、ipv6-nonxt、ipv6-opts、ipv6-route、ospf、pgm、rsvp、sctp、tcp、udp、udplite、vrrp、および integer 表現 [0-255] または any。デフォルト: any (すべてのプロトコル)) でルールを一覧表示します。

--ethertype <ethertype>

ethertype(ipv4 または ipv6)でルールを一覧表示します。

--ingress

受信ネットワークトラフィックに適用されるルールを一覧表示します。

--egress

発信ネットワークトラフィックに適用されるルールを一覧表示します。

--long

出力の追加フィールドを一覧表示します。

表71.24 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表71.25 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表71.26 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.27 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

71.7. security group rule show

セキュリティーグループルールの詳細を表示します。

使用方法

openstack security group rule show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <rule>

表71.28 位置引数

概要

<rule>

表示するセキュリティーグループルール(id のみ)

表71.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表71.30 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.31 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.32 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表71.33 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

71.8. security group set

セキュリティーグループの属性を設定します。

使用方法

openstack security group set [-h] [--name <new-name>]
                                    [--description <description>]
                                    [--tag <tag>] [--no-tag]
                                    <group>

表71.34 位置引数

概要

<group>

変更するセキュリティーグループ(名前または ID)

表71.35 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <new-name>

新しいセキュリティーグループ名

--description <description>

新しいセキュリティーグループの説明

--tag <tag>

セキュリティーグループに追加するタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

セキュリティーグループに関連付けられたタグを消去します。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。

71.9. security group show

セキュリティーグループの詳細を表示します。

使用方法

openstack security group show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <group>

表71.36 位置引数

概要

<group>

表示するセキュリティーグループ(名前または ID)

表71.37 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表71.38 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表71.39 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表71.40 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表71.41 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

71.10. security group unset

セキュリティーグループ属性の設定を解除します。

使用方法

openstack security group unset [-h] [--tag <tag> | --all-tag] <group>

表71.42 位置引数

概要

<group>

変更するセキュリティーグループ(名前または ID)

表71.43 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--tag <tag>

セキュリティーグループから削除するタグ(複数のタグを削除する場合はオプションを繰り返し使用します)

--all-tag

セキュリティーグループに関連付けられたすべてのタグを消去します。

第72章 server

本章では、server コマンドに含まれるコマンドについて説明します。

72.1. server add fixed ip

Fixed IP アドレスをサーバーに追加します。

使用方法

openstack server add fixed ip [-h] [--fixed-ip-address <ip-address>]
                                     <server> <network>

表72.1 位置引数

概要

<server>

Fixed IP アドレスを受信するサーバー(名前または ID)

<network>

Fixed IP アドレスの割り当て元となるネットワーク(名前または ID)

表72.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fixed-ip-address <ip-address>

要求された Fixed IP アドレス

72.2. server add floating ip

サーバーに Floating IP アドレスを追加します。

使用方法

openstack server add floating ip [-h] [--fixed-ip-address <ip-address>]
                                        <server> <ip-address>

表72.3 位置引数

概要

<server>

Floating IP アドレスを受信するサーバー(名前または ID)

<ip-address>

最初に利用可能なサーバーポートに割り当てるFloating IP アドレス(IP のみ)

表72.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--fixed-ip-address <ip-address>

この Floating IP アドレスに関連付ける Fixed IP アドレスFixed IP アドレスが含まれる最初のサーバーポートが使用されます。

72.3. server add network

サーバーにネットワークを追加します。

使用方法

openstack server add network [-h] <server> <network>

表72.5 位置引数

概要

<server>

ネットワークを追加するサーバー(名前または ID)

<network>

サーバーに追加するネットワーク(名前または ID)

表72.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.4. server add port

サーバーにポートを追加します。

使用方法

openstack server add port [-h] <server> <port>

表72.7 位置引数

概要

<server>

ポートを追加するサーバー(名前または ID)

<port>

サーバーに追加するポート(名前または ID)

表72.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.5. server add security group

セキュリティーグループをサーバーに追加します。

使用方法

openstack server add security group [-h] <server> <group>

表72.9 位置引数

概要

<server>

サーバー(名前または ID)

<group>

追加するセキュリティーグループ(名前または ID)

表72.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.6. server add volume

サーバーにボリュームを追加します。ステータスが``SHELVED`` または ``SHELVED_OFFLOADED``のサーバーにボリュームを追加するには、``--os-compute-api-version 2.20``以上を指定します。

使用方法

openstack server add volume [-h] [--device <device>] <server> <volume>

表72.11 位置引数

概要

<server>

サーバー(名前または ID)

<volume>

追加するボリューム(名前または ID)

表72.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--device <device>

ボリュームのサーバーの内部デバイス名

72.7. server backup create

サーバーのバックアップイメージを作成します。

使用方法

openstack server backup create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--name <image-name>]
                                      [--type <backup-type>]
                                      [--rotate <count>] [--wait]
                                      <server>

表72.13 位置引数

概要

<server>

バックアップを作成するサーバー(名前または ID)

表72.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <image-name>

バックアップイメージの名前(デフォルト:サーバー名)

--type <backup-type>

バックアップイメージの backup_type 属性の設定に使用(デフォルト:空欄)

--rotate <count>

保持するバックアップ数(デフォルト:1)

--wait

バックアップイメージの作成が完了するのを待ちます。

表72.15 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表72.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.17 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表72.18 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

72.8. server create

新しいサーバーを作成します。

使用方法

openstack server create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               (--image <image> | --image-property <key=value> | --volume <volume>)
                               --flavor <flavor>
                               [--security-group <security-group>]
                               [--key-name <key-name>]
                               [--property <key=value>]
                               [--file <dest-filename=source-filename>]
                               [--user-data <user-data>]
                               [--description <description>]
                               [--availability-zone <zone-name>]
                               [--host <host>]
                               [--hypervisor-hostname <hypervisor-hostname>]
                               [--boot-from-volume <volume-size>]
                               [--block-device-mapping <dev-name=mapping>]
                               [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none>]
                               [--network <network>] [--port <port>]
                               [--hint <key=value>]
                               [--config-drive <config-drive-volume>|True]
                               [--min <count>] [--max <count>] [--wait]
                               <server-name>

表72.19 位置引数

概要

<server-name>

新しいサーバー名

表72.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--image <image>

このイメージからサーバーのブートディスクを作成します(名前または ID)。

--image-property <key=value>

照合されるイメージ属性

--volume <volume>

このボリュームをブートディスクとして使用してサーバーを作成します(名前または ID)。このオプションは、ブートインデックス 0 でブロックデバイスマッピングを自動的に作成します。多くのハイパーバイザー(libvirt/kvm など)で、これはデバイス vda になります。--block-device- mappingを使用して、このデバイスに重複したマッピングを作成しないでください。

--flavor <flavor>

このフレーバーを使用してサーバーを作成します(名前または ID)。

--security-group <security-group>

このサーバーに割り当てるセキュリティーグループ(名前または ID)(複数のグループを設定する場合はオプションを繰り返し使用します)

--key-name <key-name>

このサーバーに挿入するキーペア(任意の拡張)

--property <key=value>

このサーバーに属性を設定します(複数の値を設定する場合はオプションを繰り返し使用します)。

--file <dest-filename=source-filename>

ブート前にイメージに挿入するファイル(複数のファイルを設定する場合はオプションを繰り返し使用します)

--user-data <user-data>

メタデータサーバーから提供されるユーザーデータファイル

--description <description>

サーバーの説明を設定します(--os- compute-api-version 2.19 以上でサポートされます)

--availability-zone <zone-name>

サーバーのアベイラビリティーゾーンを選択します。

--host <host>

サーバーを作成するために要求されたホスト。デフォルトでは管理者のみが対象です(--os-compute-api-version 2.74 以上でサポートされます)。

--hypervisor-hostname <hypervisor-hostname>

サーバーを作成するために要求されたハイパーバイザーホスト名。デフォルトでは管理者のみが対象です(--os-compute-api- version 2.74 以上でサポートされます)。

--boot-from-volume <volume-size>

''--image'' または ''--image-property'' オプションと併用すると、このオプションは、ブートインデックスが 0 のブロックデバイスマッピングを自動的に作成し、指定されたイメージから指定のサイズ(GB)のボリュームを作成し、サーバーのルートディスクとして使用するよう Compute サービスに指示します。ルートボリュームは、サーバーの削除時に削除されません。このオプションは ``--volume`` オプションと相互に排他的です。

--block-device-mapping <dev-name=mapping>

サーバーにブロックデバイスを作成します。<dev-name>=<id>:<type>:<size(GB)>:<delete-on- terminate>の形式のブロックデバイスマッピング。<dev-name>: vdb、xvdc等のブロックデバイス名 (必須)、<id>: ボリューム、ボリュームスナップショット、またはイメージの名前または ID (必須)、<type>: volume、snapshot、または image (デフォルト: volume) (オプション)、<size(GB)>: イメージまたはスナップショットから作成する場合はボリュームサイズ (オプション)、<delete-on-terminate>: true または false (デフォルト: false) (オプション) (オプションの機能拡張)

--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none>

サーバーに nic を作成します。複数の NIC を作成するには、オプションを複数回指定します。net-id または port- id のどちらかを指定する必要がありますが、両方を指定することはできません。net-id: NIC をこの UUID が割り当てられたネットワークにアタッチします。port-id: NIC をこの UUID が割り当てられたポートにアタッチします。v4-fixed-ip: NIC用IPv4 固定アドレス(オプション)。v6-fixed-ip: NIC用IPv6 固定アドレス(オプション)。none: (v2.37以上)ネットワークをアタッチしません。auto: (v2.37以上) Compute サービスがネットワークを自動的に割り当てます。--nic にauto または none を指定すると、他の --nic の値とは併用できません。

--network <network>

サーバーに nic を作成し、ネットワークに接続します。複数の NIC を作成するには、オプションを複数回指定します。これは、新しいサーバーを特定のネットワークに接続する標準ユースケースの簡単な構文を提供する--nic net-id=<network> パラメーターのラッパーです。高度なユースケースは、-- nic パラメーターを参照してください。

--port <port>

サーバーに nic を作成し、ポートに接続します。複数の NIC を作成するには、オプションを複数回指定します。これは、新しいサーバーを特定のポートに接続する標準ユースケースの簡単な構文を提供する--nic port-id=<port> パラメーターのラッパーです。高度なユースケースは、--nic パラメーターを参照してください。

--hint <key=value>

スケジューラーのヒント(オプションの機能拡張)

--config-drive <config-drive-volume>

True

指定されたボリュームをコンフィグドライブとして使用するか、true で一時ドライブを使用します。

--min <count>

起動するサーバーの最小数(デフォルトは1)

--max <count>

起動するサーバーの最大数(デフォルトは 1)

--wait

表72.21 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表72.22 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.23 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表72.24 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

72.9. server delete

サーバーを削除します。

使用方法

openstack server delete [-h] [--wait] <server> [<server> ...]

表72.25 位置引数

概要

<server>

削除するサーバー(名前または ID)

表72.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait

削除が完了するのを待ちます。

72.10. server dump create

ダンプファイルをサーバー内に作成します。Linux の kdump などの機能を使用して、サーバーでクラッシュダンプをトリガーします。サーバーのメモリーをダンプするサーバーにダンプファイルを作成し、さらにサーバーをクラッシュします。OSC は、リソースの1つとしてダンプファイル(サーバーダンプ)を確認します。このコマンドには ''--os-compute-api- version'' 2.17 以降が必要です。

使用方法

openstack server dump create [-h] <server> [<server> ...]

表72.27 位置引数

概要

<server>

ダンプファイルを作成するサーバー(名前または ID)

表72.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.11. server event list

サーバーの最近のイベントを一覧表示します。削除されたサーバーのイベントを表示するには、''--os-compute-api-version 2.21'' 以上を指定します。

使用方法

openstack server event list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN] [--long]
                                   <server>

表72.29 位置引数

概要

<server>

イベントを一覧表示するサーバー(名前または ID)

表72.30 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

表72.31 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表72.32 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表72.33 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.34 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

72.12. server event show

サーバーイベントの詳細を表示します。削除されたサーバーのイベント詳細を表示するには、''--os-compute-api-version 2.21'' 以上を指定します。管理者以外のユーザーのイベントの詳細を表示するには、''--os-compute-api-version 2.51'' 以上を指定します。

使用方法

openstack server event show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <server> <request-id>

表72.35 位置引数

概要

<server>

イベントの詳細を表示するサーバー(名前または ID)

<request-id>

表示するイベントの要求 ID(id のみ)

表72.36 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表72.37 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表72.38 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.39 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表72.40 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

72.13. server group create

新しいサーバーグループを作成します。

使用方法

openstack server group create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--policy <policy>]
                                     <name>

表72.41 位置引数

概要

<name>

新しいサーバーグループ名

表72.42 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--policy <policy>

<name> にポリシーを追加します(affinity または anti-affinity、デフォルトは affinity)。soft-affinity または soft-anti-affinity ポリシーの場合、--os-compute-api- version 2.15 以降を指定します。

表72.43 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表72.44 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.45 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表72.46 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

72.14. server group delete

既存のサーバーグループを削除します。

使用方法

openstack server group delete [-h] <server-group> [<server-group> ...]

表72.47 位置引数

概要

<server-group>

削除するサーバーグループ(名前または ID)

表72.48 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.15. server group list

すべてのサーバーグループを一覧表示します。

使用方法

openstack server group list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--all-projects] [--long]

表72.49 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの情報を表示します(管理者のみ)。

--long

出力の追加フィールドを一覧表示します。

表72.50 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表72.51 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表72.52 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.53 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

72.16. server group show

サーバーグループの詳細を表示します。

使用方法

openstack server group show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <server-group>

表72.54 位置引数

概要

<server-group>

表示するサーバーグループ(名前または ID)

表72.55 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表72.56 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表72.57 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.58 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表72.59 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

72.17. server image create

既存のサーバーから新規サーバーディスクイメージを作成します。

使用方法

openstack server image create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--name <image-name>] [--wait]
                                     <server>

表72.60 位置引数

概要

<server>

イメージを作成するサーバー(名前または ID)

表72.61 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <image-name>

新しいディスクイメージの名前(デフォルト:サーバー名)

--wait

動作が完了するまで待ちます。

表72.62 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表72.63 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.64 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表72.65 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

72.18. server list

サーバーを一覧表示します。

使用方法

openstack server list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN]
                             [--reservation-id <reservation-id>]
                             [--ip <ip-address-regex>]
                             [--ip6 <ip-address-regex>] [--name <name-regex>]
                             [--instance-name <server-name>]
                             [--status <status>] [--flavor <flavor>]
                             [--image <image>] [--host <hostname>]
                             [--all-projects] [--project <project>]
                             [--project-domain <project-domain>]
                             [--user <user>] [--user-domain <user-domain>]
                             [--long] [-n | --name-lookup-one-by-one]
                             [--marker <server>] [--limit <num-servers>]
                             [--deleted] [--changes-before <changes-before>]
                             [--changes-since <changes-since>]
                             [--locked | --unlocked]

表72.66 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--reservation-id <reservation-id>

予約に一致するインスタンスのみを返します。

--ip <ip-address-regex>

IP アドレスに一致する正規表現

--ip6 <ip-address-regex>

ipv6 アドレスに一致する正規表現。このオプションは、''-os-compute-api-version'' 2.5 以上を使用する場合に、管理者以外のユーザーにのみ適用されることに注意してください。

--name <name-regex>

名前に一致する正規表現

--instance-name <server-name>

インスタンス名に一致する正規表現(管理者のみ)

--status <status>

サーバーステータスで検索します。

--flavor <flavor>

フレーバーで検索します(名前または ID)。

--image <image>

イメージで検索します(名前または ID)。

--host <hostname>

ホスト名で検索します。

--all-projects

すべてのプロジェクトを含めます(管理者のみ)。

--project <project>

プロジェクトで検索します(管理者のみ)(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--user <user>

ユーザーで検索します(管理者のみ)(名前または ID)

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

--long

出力の追加フィールドを一覧表示します。

-n, --no-name-lookup

フレーバーとイメージ名による検索を省略します。"--name-lookup-one-by-one" オプションと相互に排他的です。

--name-lookup-one-by-one

フレーバーおよびイメージ名を検索する場合には、すべてまとめて(デフォルト)ではなく、必要に応じて1つずつ検索します。"--no-name- lookup

-n" オプションと相互に排他的です。

--marker <server>

前のページにある最後のサーバー。マーカーの後にサーバーの一覧を表示します。指定がない場合は、すべてのサーバーを表示します(名前または ID)。

--limit <num-servers>

表示するサーバーの最大数。制限が -1 の場合、すべてのサーバーが表示されます。上限が Nova API の osapi_max_limit オプションよりも大きい場合には、代わりに osapi_max_limit が使用されます。

--deleted

削除されたサーバーのみを表示します(管理者のみ)。

--changes-before <changes-before>

特定の時点より前に変更されたサーバーのみを一覧表示します。指定する時間は ISO 8061 形式の時刻(例:2016-03-05T06:27:59Z)である必要があります。(API バージョン 2.66 - 2.latestでサポートされます)

--changes-since <changes-since>

特定の時点より後に変更されたサーバーのみを一覧表示します。指定する時間は ISO 8061 形式の時刻(例:2016-03-04T06:27:59Z)である必要があります。

--locked

ロックされたサーバーのみを表示します。これには ''--os-compute- api-version'' 2.73 以上が必要です。

--unlocked

表72.67 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表72.68 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表72.69 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.70 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

72.19. server lock

サーバーをロックします。管理者以外のユーザーはアクションを実行できなくなります。

使用方法

openstack server lock [-h] [--reason <reason>] <server> [<server> ...]

表72.71 位置引数

概要

<server>

ロックするサーバー(名前または ID)

表72.72 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--reason <reason>

サーバーをロックする理由。これには ''--os- compute-api-version'' 2.73 以上が必要です。

72.20. server migrate

サーバーを異なるホストに移行します。

使用方法

openstack server migrate [-h] [--live-migration]
                                [--live <hostname> | --host <hostname>]
                                [--shared-migration | --block-migration]
                                [--disk-overcommit | --no-disk-overcommit]
                                [--wait]
                                <server>

表72.73 位置引数

概要

<server>

サーバー(名前または ID)

表72.74 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--live-migration

サーバーのライブマイグレーションを行います。移行のターゲットホストを指定するには、''--host'' オプションを使用します。これは、スケジューラーによって検証されます。

--live <hostname>

非推奨。このオプションは、ホストが必要で、compute API バージョン 2.30 より前でライブマイグレーション中のホストを指定すると、スケジューラーによる検証がバイパスされます。これにより、サーバーを指定されたホストに実際に移行できないか、ホストのオーバーサブスクライブが発生する可能性があります。代わりに ''-live-migration'' オプションを使用してください。このオプションと ''-live-migration'' の両方が使用された場合は、''--live-migration'' が優先されます。

--host <hostname>

指定したホストにサーバーを移行します。''--live-migration'' オプションと併用する場合は ''--os-compute-api-version'' 2.30 以上が必要です。それ以外の場合は、''--os-compute-api-version'' 2.56 以上が必要になります。

--shared-migration

共有ライブマイグレーションを実行します(デフォルト)。

--block-migration

ブロックライブマイグレーションを実行します。

--disk-overcommit

移行先ホストでディスクのオーバーコミットを許可します。

--no-disk-overcommit

移行先ホストでディスクのオーバーコミットを行いません(デフォルト)。

--wait

移行が完了するまで待ちます。

72.21. server pause

サーバーを一時停止します。

使用方法

openstack server pause [-h] <server> [<server> ...]

表72.75 位置引数

概要

<server>

一時停止するサーバー(名前または ID)

表72.76 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.22. server reboot

サーバーのハードまたはソフトリブートを実行します。

使用方法

openstack server reboot [-h] [--hard | --soft] [--wait] <server>

表72.77 位置引数

概要

<server>

サーバー(名前または ID)

表72.78 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--hard

ハードリブートを実行します。

--soft

ソフトリブートを実行します。

--wait

リブートが完了するまで待ちます。

72.23. server rebuild

サーバーを再ビルドします。

使用方法

openstack server rebuild [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--image <image>]
                                [--password <password>]
                                [--property <key=value>]
                                [--description <description>] [--wait]
                                [--key-name <key-name> | --key-unset]
                                <server>

表72.79 位置引数

概要

<server>

サーバー(名前または ID)

表72.80 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--image <image>

指定されたイメージからサーバーを再作成します(名前または ID)。デフォルトは現在使用中のイメージです。

--password <password>

再ビルドしたインスタンスのパスワードを設定します。

--property <key=value>

再ビルドしたインスタンスで属性を設定します(複数の値を設定する場合はオプションを繰り返し使用します)。

--description <description>

サーバーの新しい説明(--os- compute-api-version 2.19 以上でサポートされます)

--wait

再ビルドが完了するまで待ちます。

--key-name <key-name>

再ビルドしたインスタンスで、キーペアのキー名を設定します。--key-unset オプションと共に指定することはできません。(API バージョン 2.54 - 2.latestでサポートされます)

--key-unset

再ビルドしたインスタンスで、キーペアのキー名を設定しません。--key-name オプションと共に指定することはできません。(API バージョン 2.54 - 2.latestでサポートされます)

表72.81 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表72.82 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.83 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表72.84 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

72.24. server remove fixed ip

サーバーからFixed IP アドレスを削除します。

使用方法

openstack server remove fixed ip [-h] <server> <ip-address>

表72.85 位置引数

概要

<server>

Fixed IP アドレスを削除するサーバー(名前または ID)

<ip-address>

サーバーから削除する Fixed IP アドレス(ip のみ)

表72.86 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.25. server remove floating ip

サーバーから Floating IP アドレスを削除します。

使用方法

openstack server remove floating ip [-h] <server> <ip-address>

表72.87 位置引数

概要

<server>

Floating IP アドレスを削除するサーバー(名前または ID)

<ip-address>

サーバーから削除するFloating IP アドレス(ip のみ)

表72.88 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.26. server remove network

サーバーからネットワークのポートをすべて削除します。

使用方法

openstack server remove network [-h] <server> <network>

表72.89 位置引数

概要

<server>

ポートを削除するサーバー(名前または ID)

<network>

サーバーから削除するネットワーク(名前または ID)

表72.90 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.27. server remove port

サーバーからポートを削除します。

使用方法

openstack server remove port [-h] <server> <port>

表72.91 位置引数

概要

<server>

ポートを削除するサーバー(名前または ID)

<port>

サーバーから削除するポート(名前または ID)

表72.92 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.28. server remove security group

サーバーからセキュリティーグループを削除します。

使用方法

openstack server remove security group [-h] <server> <group>

表72.93 位置引数

概要

<server>

使用するサーバーの名前または ID

<group>

サーバーから削除するセキュリティーグループの名前または ID

表72.94 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.29. server remove volume

サーバーからボリュームを削除します。ステータスが``SHELVED`` または ``SHELVED_OFFLOADED``のサーバーからボリュームを削除するには、``--os-compute-api-version 2.20``以上を指定します。

使用方法

openstack server remove volume [-h] <server> <volume>

表72.95 位置引数

概要

<server>

サーバー(名前または ID)

<volume>

削除するボリューム(名前または ID)

表72.96 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.30. server rescue

サーバーをレスキューモードに切り替えます。

使用方法

openstack server rescue [-h] [--image <image>] [--password <password>]
                               <server>

表72.97 位置引数

概要

<server>

サーバー(名前または ID)

表72.98 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--image <image>

レスキューモードに使用するイメージ(名前または ID)。デフォルトは現在使用中のイメージです。

--password <password>

レスキューインスタンスのパスワードを設定します。

72.31. server resize confirm

サーバーのサイズ変更を確認します。サイズ変更操作の成功を確認(検証)し、古いサーバーを解放します。

使用方法

openstack server resize confirm [-h] <server>

表72.99 位置引数

概要

<server>

サーバー(名前または ID)

表72.100 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.32. server resize revert

サーバーのサイズ変更を元に戻します。サイズ変更操作を元に戻します。新しいサーバーを解放し、古いサーバーを再起動します。

使用方法

openstack server resize revert [-h] <server>

表72.101 位置引数

概要

<server>

サーバー(名前または ID)

表72.102 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.33. server resize

サーバーを新規フレーバーにスケーリングします。サイズ変更操作は、新しいサーバーを作成して、元のディスクの内容を新しいディスクにコピーして実行されます。また、ユーザーにとっても 2 つのステップのプロセスです。1 つ目はサイズ変更の実行で、2 つ目は、成功を確認(検証)して古いサーバーを解放するか、やり直しを宣言して新しいサーバーを解放して古いサーバーを再起動するかのどちらかです。

使用方法

openstack server resize [-h] [--flavor <flavor> | --confirm | --revert]
                               [--wait]
                               <server>

表72.103 位置引数

概要

<server>

サーバー(名前または ID)

表72.104 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--flavor <flavor>

サーバーを指定したフレーバーにサイズ変更します。

--confirm

サーバーのサイズ変更が完了したことを確認します。

--revert

サーバーの状態をサイズ変更前に復元します。

--wait

サイズ変更が完了するまで待ちます。

72.34. server restore

サーバーを復元します。

使用方法

openstack server restore [-h] <server> [<server> ...]

表72.105 位置引数

概要

<server>

復元するサーバー(名前または ID)

表72.106 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.35. server resume

サーバーを再開します。

使用方法

openstack server resume [-h] <server> [<server> ...]

表72.107 位置引数

概要

<server>

再開するサーバー(名前または ID)

表72.108 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.36. server set

サーバー属性を設定します。

使用方法

openstack server set [-h] [--name <new-name>] [--root-password]
                            [--property <key=value>] [--state <state>]
                            [--description <description>]
                            <server>

表72.109 位置引数

概要

<server>

サーバー(名前または ID)

表72.110 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <new-name>

新しいサーバー名

--root-password

新しい root パスワードを設定します(対話式のみ)。

--property <key=value>

このサーバーに追加/変更する属性(複数の属性を設定する場合はオプションを繰り返し使用します)

--state <state>

新しいサーバーの状態(有効な値:active、error)

--description <description>

新規サーバーの説明(--os-compute-api- version 2.19 以降でサポートされます)

72.37. server shelve

サーバーを退避します。

使用方法

openstack server shelve [-h] <server> [<server> ...]

表72.111 位置引数

概要

<server>

退避するサーバー(名前または ID)

表72.112 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.38. server show

サーバーの詳細を表示します。サーバーの埋め込みフレーバー情報を表示するには、``--os-compute-api-version 2.47`` 以上を指定します。

使用方法

openstack server show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--diagnostics]
                             <server>

表72.113 位置引数

概要

<server>

サーバー(名前または ID)

表72.114 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--diagnostics

サーバーの診断情報を表示します。

表72.115 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表72.116 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表72.117 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表72.118 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

72.39. server ssh

サーバーにSSH接続を行います。

使用方法

openstack server ssh [-h] [--login <login-name>] [--port <port>]
                            [--identity <keyfile>] [--option <config-options>]
                            [-4 | -6]
                            [--public | --private | --address-type <address-type>]
                            <server>

表72.119 位置引数

概要

<server>

サーバー(名前または ID)

表72.120 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--login <login-name>

ログイン名(ssh -l オプション)

--port <port>

宛先ポート(ssh -p オプション)

--identity <keyfile>

秘密鍵ファイル(ssh -i オプション)

--option <config-options>

ssh_config(5)形式のオプション(ssh -o オプション)

-4

ipv4 アドレスのみを使用します。

-6

ipv6 アドレスのみを使用します。

--public

パブリック IP アドレスを使用します。

--private

プライベート IP アドレスを使用します。

--address-type <address-type>

他の IP アドレス(パブリック、プライベートなど)を使用します。

72.40. server start

サーバーを起動します。

使用方法

openstack server start [-h] <server> [<server> ...]

表72.121 位置引数

概要

<server>

起動するサーバー(名前または ID)

表72.122 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.41. server stop

サーバーを停止します。

使用方法

openstack server stop [-h] <server> [<server> ...]

表72.123 位置引数

概要

<server>

停止するサーバー(名前または ID)

表72.124 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.42. server suspend

サーバーを一時停止します。

使用方法

openstack server suspend [-h] <server> [<server> ...]

表72.125 位置引数

概要

<server>

一時停止するサーバー(名前または ID)

表72.126 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.43. server unlock

サーバーのロックを解除します。

使用方法

openstack server unlock [-h] <server> [<server> ...]

表72.127 位置引数

概要

<server>

ロックを解除するサーバー(名前または ID)

表72.128 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.44. server unpause

サーバーの一時停止を解除します。

使用方法

openstack server unpause [-h] <server> [<server> ...]

表72.129 位置引数

概要

<server>

一時停止を解除するサーバー(名前または ID)

表72.130 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.45. server unrescue

レスキューモードからサーバーを復元します。

使用方法

openstack server unrescue [-h] <server>

表72.131 位置引数

概要

<server>

サーバー(名前または ID)

表72.132 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

72.46. server unset

サーバー属性の設定を解除します。

使用方法

openstack server unset [-h] [--property <key>] [--description] <server>

表72.133 位置引数

概要

<server>

サーバー(名前または ID)

表72.134 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key>

サーバーから削除する属性キー(複数の値を削除する場合はオプションを繰り返し使用します)

--description

サーバーの説明の設定を解除します(--os-compute-api- version 2.19 以上でサポートされます)

72.47. server unshelve

サーバーの退避を解除します

使用方法

openstack server unshelve [-h] [--availability-zone AVAILABILITY_ZONE]
                                 <server> [<server> ...]

表72.135 位置引数

概要

<server>

退避を解除するサーバー(名前または ID)

表72.136 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--availability-zone AVAILABILITY_ZONE

SHELVED_OFFLOADED サーバーの退避を解除するアベイラビリティーゾーンの名前(--os-compute- api-version 2.77 以上でサポートされます)

第73章 サービス

本章では、service コマンドに含まれるコマンドについて説明します。

73.1. service create

新規サービスを作成します。

使用方法

openstack service create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--name <name>]
                                [--description <description>]
                                [--enable | --disable]
                                <type>

表73.1 位置引数

概要

<type>

新しいサービスの種別(compute、image、identity、volumeなど)

表73.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新しいサービス名

--description <description>

新しいサービスの説明

--enable

サービスを有効にします(デフォルト)。

--disable

サービスを無効化します。

表73.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表73.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表73.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

73.2. service delete

サービスを削除します。

使用方法

openstack service delete [-h] <service> [<service> ...]

表73.7 位置引数

概要

<service>

削除するサービス(タイプ、名前、または ID)

表73.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

73.3. service list

サービスを一覧表示します。

使用方法

openstack service list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN] [--long]

表73.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

表73.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表73.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表73.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

73.4. service provider create

新規サービスプロバイダーを作成します。

使用方法

openstack service provider create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty] --auth-url <auth-url>
                                         [--description <description>]
                                         --service-provider-url <sp-url>
                                         [--enable | --disable]
                                         <name>

表73.14 位置引数

概要

<name>

新しいサービスプロバイダー名(一意である必要があります)

表73.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--auth-url <auth-url>

リモートフェデレーションサービスプロバイダーの認証 URL(必須)

--description <description>

新規サービスプロバイダーの説明

--service-provider-url <sp-url>

saml アサーションが送信されるサービス URL(必須)

--enable

サービスプロバイダーを有効にします(デフォルト)。

--disable

サービスプロバイダーを無効にします。

表73.16 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表73.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.18 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表73.19 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

73.5. service provider delete

サービスプロバイダーを削除します。

使用方法

openstack service provider delete [-h]
                                         <service-provider>
                                         [<service-provider> ...]

表73.20 位置引数

概要

<service-provider>

削除するサービスプロバイダー

表73.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

73.6. service provider list

サービスプロバイダーを一覧表示します。

使用方法

openstack service provider list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]

表73.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表73.23 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表73.24 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表73.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.26 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

73.7. service provider set

サービスプロバイダーの属性を設定します。

使用方法

openstack service provider set [-h] [--auth-url <auth-url>]
                                      [--description <description>]
                                      [--service-provider-url <sp-url>]
                                      [--enable | --disable]
                                      <service-provider>

表73.27 位置引数

概要

<service-provider>

変更するサービスプロバイダー

表73.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--auth-url <auth-url>

リモートフェデレーションサービスプロバイダーの新たな認証 URL

--description <description>

新規サービスプロバイダーの説明

--service-provider-url <sp-url>

saml アサーションが送信される新しいサービスプロバイダー URL

--enable

サービスプロバイダーを有効にします。

--disable

サービスプロバイダーを無効にします。

73.8. service provider show

サービスプロバイダーの詳細を表示します。

使用方法

openstack service provider show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <service-provider>

表73.29 位置引数

概要

<service-provider>

表示するサービスプロバイダー

表73.30 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表73.31 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表73.32 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.33 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表73.34 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

73.9. service set

サービスの属性を設定します。

使用方法

openstack service set [-h] [--type <type>] [--name <service-name>]
                             [--description <description>]
                             [--enable | --disable]
                             <service>

表73.35 位置引数

概要

<service>

変更するサービス(タイプ、名前、または ID)

表73.36 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--type <type>

新しいサービスの種別(compute、image、identity、volumeなど)

--name <service-name>

新しいサービス名

--description <description>

新しいサービスの説明

--enable

サービスを有効化します。

--disable

サービスを無効化します。

73.10. service show

サービスの詳細を表示します。

使用方法

openstack service show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <service>

表73.37 位置引数

概要

<service>

表示するサービス(タイプ、名前、または ID)

表73.38 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表73.39 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表73.40 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表73.41 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表73.42 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第74章 sfc

本章では、sfc コマンドに含まれるコマンドについて説明します。

74.1. sfc flow classifier create

フロー分類子を作成します。

使用方法

openstack sfc flow classifier create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--description <description>]
                                            [--protocol <protocol>]
                                            [--ethertype {IPv4,IPv6}]
                                            [--source-port <min-port>:<max-port>]
                                            [--destination-port <min-port>:<max-port>]
                                            [--source-ip-prefix <source-ip-prefix>]
                                            [--destination-ip-prefix <destination-ip-prefix>]
                                            [--logical-source-port <logical-source-port>]
                                            [--logical-destination-port <logical-destination-port>]
                                            [--l7-parameters L7_PARAMETERS]
                                            <name>

表74.1 位置引数

概要

<name>

フロー分類子の名前

表74.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

フロー分類の説明

--protocol <protocol>

IP プロトコル名。プロトコル名は、iana標準に従って指定する必要があります。

--ethertype {IPv4,IPv6}

L2 ethertype。デフォルトは ipv4 です。

--source-port <min-port>:<max-port>

許容範囲でのソースプロトコルポート(指定できる範囲 [1,65535]。a:b の形で指定する必要があります。ここで、aは最小ポート、bは最大ポートです)

--destination-port <min-port>:<max-port>

宛先プロトコルポート(指定できる範囲 [1,65535])。a:b の形で指定する必要があります。ここで、aは最小ポート、bは最大ポートです。

--source-ip-prefix <source-ip-prefix>

cidr 表記のソース IP アドレス

--destination-ip-prefix <destination-ip-prefix>

cidr 表記の宛先 IP アドレス

--logical-source-port <logical-source-port>

neutron ソースポート(名前または ID)

--logical-destination-port <logical-destination-port>

Neutron の宛先ポート(名前または ID)

--l7-parameters L7_PARAMETERS

l7 パラメーターのディクショナリー。現在、このオプションではいずれの値もサポートされません。

表74.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表74.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

74.2. sfc flow classifier delete

指定のフロー分類子を削除します。

使用方法

openstack sfc flow classifier delete [-h] <flow-classifier>

表74.7 位置引数

概要

<flow-classifier>

削除するフロー分類子(名前または ID)

表74.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

74.3. sfc flow classifier list

フロー分類子を一覧表示します。

使用方法

openstack sfc flow classifier list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN] [--long]

表74.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

表74.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表74.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表74.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

74.4. sfc flow classifier set

フロー分類子の属性を設定します。

使用方法

openstack sfc flow classifier set [-h] [--name <name>]
                                         [--description <description>]
                                         <flow-classifier>

表74.14 位置引数

概要

<flow-classifier>

変更するフロー分類子(名前または ID)

表74.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

フロー分類子の名前

--description <description>

フロー分類の説明

74.5. sfc flow classifier show

フロー分類子の詳細を表示します。

使用方法

openstack sfc flow classifier show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <flow-classifier>

表74.16 位置引数

概要

<flow-classifier>

表示するフロー分類子(名前または ID)

表74.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表74.18 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.20 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表74.21 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

74.6. sfc port chain create

ポートチェーンを作成します。

使用方法

openstack sfc port chain create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--description <description>]
                                       [--flow-classifier <flow-classifier>]
                                       [--chain-parameters correlation=<correlation-type>,symmetric=<boolean>]
                                       --port-pair-group <port-pair-group>
                                       <name>

表74.22 位置引数

概要

<name>

ポートチェーンの名前

表74.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ポートチェーンの説明

--flow-classifier <flow-classifier>

フロー分類子を追加します(名前または id)。このオプションを繰り返すことができます。

--chain-parameters correlation=<correlation-type>,symmetric=<boolean>

チェーンパラメーターのディクショナリー。correlation=(mpls)をサポートします。

nsh)(デフォルトは mpls)および symmetric=(true)

false)。

--port-pair-group <port-pair-group>

ポートペアのグループを追加します(名前または ID)。このオプションを繰り返すことができます。

表74.24 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.26 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表74.27 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

74.7. sfc port chain delete

特定のポートチェーンを削除します。

使用方法

openstack sfc port chain delete [-h] <port-chain>

表74.28 位置引数

概要

<port-chain>

削除するポートチェーン(名前または ID)

表74.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

74.8. sfc port chain list

ポートチェーンの一覧を表示します。

使用方法

openstack sfc port chain list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN] [--long]

表74.30 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

表74.31 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表74.32 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表74.33 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.34 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

74.9. sfc port chain set

ポートチェーンの属性を設定します。

使用方法

openstack sfc port chain set [-h] [--name <name>]
                                    [--description <description>]
                                    [--flow-classifier <flow-classifier>]
                                    [--no-flow-classifier]
                                    [--port-pair-group <port-pair-group>]
                                    [--no-port-pair-group]
                                    <port-chain>

表74.35 位置引数

概要

<port-chain>

変更するポートチェーン(名前または ID)

表74.36 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ポートチェーンの名前

--description <description>

ポートチェーンの説明

--flow-classifier <flow-classifier>

フロー分類子を追加します(名前または id)。このオプションを繰り返すことができます。

--no-flow-classifier

ポートチェーンから関連するフロー分類子を削除します。

--port-pair-group <port-pair-group>

ポートペアのグループを追加します(名前または ID)。現在のポートペアグループの順番が保持され、追加されたポートペアグループはポートチェーンの最後に配置されます。このオプションを繰り返すことができます。

--no-port-pair-group

ポートチェーンから関連付けられたポートペアグループを削除します。少なくとも 1 つの --port-pair-group を共に指定する必要があります。

74.10. sfc port chain show

ポートチェーンの詳細を表示します。

使用方法

openstack sfc port chain show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <port-chain>

表74.37 位置引数

概要

<port-chain>

表示するポートチェーン(名前または ID)

表74.38 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表74.39 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.40 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.41 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表74.42 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

74.11. sfc port chain unset

ポートチェーン属性の設定を解除します。

使用方法

openstack sfc port chain unset [-h]
                                      [--flow-classifier <flow-classifier> | --all-flow-classifier]
                                      [--port-pair-group <port-pair-group>]
                                      <port-chain>

表74.43 位置引数

概要

<port-chain>

設定を解除するポートチェーン(名前または ID)

表74.44 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--flow-classifier <flow-classifier>

ポートチェーンからフロー分類子を削除します(名前または ID)。このオプションを繰り返すことができます。

--all-flow-classifier

ポートチェーンからすべてのフロー分類子を削除します。

--port-pair-group <port-pair-group>

ポートチェーンからポートペアグループを削除します(名前または ID)。このオプションを繰り返すことができます。

74.12. sfc port pair create

ポートペアを作成します。

使用方法

openstack sfc port pair create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--description <description>]
                                      [--service-function-parameters correlation=<correlation-type>,weight=<weight>]
                                      --ingress <ingress> --egress <egress>
                                      <name>

表74.45 位置引数

概要

<name>

ポートペアの名前

表74.46 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ポートペアの説明

--service-function-parameters correlation=<correlation-type>,weight=<weight>

サービス関数パラメーターのディクショナリー。現在 correlation=(None

mpls

nsh)および重みがサポートされます。重みは、フローのポートペアグループ内のポートペアの選択に影響を与える整数です。重みが高いほど、より多くのフローがポートペアにハッシュします。デフォルトの重みは 1 です。

--ingress <ingress>

受信 neutron ポート(名前または ID)

--egress <egress>

送信 neutron ポート(名前または ID)

表74.47 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.48 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.49 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表74.50 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

74.13. sfc port pair delete

指定のポートペアを削除します。

使用方法

openstack sfc port pair delete [-h] <port-pair>

表74.51 位置引数

概要

<port-pair>

削除するポートペア(名前または ID)

表74.52 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

74.14. sfc port pair group create

ポートペアグループを作成します。

使用方法

openstack sfc port pair group create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--description <description>]
                                            [--port-pair <port-pair>]
                                            [--enable-tap | --disable-tap]
                                            [--port-pair-group-parameters lb-fields=<lb-fields>]
                                            <name>

表74.53 位置引数

概要

<name>

ポートペアグループの名前

表74.54 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ポートペアグループの説明

--port-pair <port-pair>

ポートのペア(名前または ID)。このオプションを繰り返すことができます。

--enable-tap

このポートペアグループのポートペアがパッシブタップサービス関数としてデプロイされます。

--disable-tap

このポートペアグループのポートペアがl3サービス関数としてデプロイされます(デフォルト)。

--port-pair-group-parameters lb-fields=<lb-fields>

ポートペアグループパラメーターのディクショナリー。現在、1 つのパラメーター lb-fields のみがサポートされます。<lb-fields> は負荷分散フィールドの & 区切りリストです。

表74.55 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.56 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.57 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表74.58 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

74.15. sfc port pair group delete

指定されたポートペアグループを削除します。

使用方法

openstack sfc port pair group delete [-h] <port-pair-group>

表74.59 位置引数

概要

<port-pair-group>

削除するポートペアグループ(名前または ID)

表74.60 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

74.16. sfc port pair group list

ポートペアグループを一覧表示します。

使用方法

openstack sfc port pair group list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN] [--long]

表74.61 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

表74.62 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表74.63 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表74.64 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.65 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

74.17. sfc port pair group set

ポートペアグループの属性を設定します。

使用方法

openstack sfc port pair group set [-h] [--name <name>]
                                         [--description <description>]
                                         [--port-pair <port-pair>]
                                         [--no-port-pair]
                                         <port-pair-group>

表74.66 位置引数

概要

<port-pair-group>

変更するポートペアグループ(名前または ID)

表74.67 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ポートペアグループの名前

--description <description>

ポートペアグループの説明

--port-pair <port-pair>

ポートのペア(名前または ID)。このオプションを繰り返すことができます。

--no-port-pair

ポートペアグループからポートのペアをすべて削除します。

74.18. sfc port pair group show

ポートペアグループの詳細を表示します。

使用方法

openstack sfc port pair group show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <port-pair-group>

表74.68 位置引数

概要

<port-pair-group>

表示するポートペアグループ(名前または ID)

表74.69 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表74.70 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.71 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.72 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表74.73 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

74.19. sfc port pair group unset

ポートペアグループからポートペアの設定を解除します。

使用方法

openstack sfc port pair group unset [-h]
                                           [--port-pair <port-pair> | --all-port-pair]
                                           <port-pair-group>

表74.74 位置引数

概要

<port-pair-group>

設定を解除するポートペアグループ(名前または ID)

表74.75 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--port-pair <port-pair>

ポートペアグループからポートのペアを削除します(名前または ID)。このオプションを繰り返すことができます。

--all-port-pair

ポートペアグループからポートのペアをすべて削除します。

74.20. sfc port pair list

ポートペアの一覧を表示します。

使用方法

openstack sfc port pair list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN] [--long]

表74.76 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

表74.77 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表74.78 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表74.79 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.80 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

74.21. sfc port pair set

ポートペアの属性を設定します。

使用方法

openstack sfc port pair set [-h] [--name <name>]
                                   [--description <description>]
                                   <port-pair>

表74.81 位置引数

概要

<port-pair>

変更するポートペア(名前または ID)

表74.82 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ポートペアの名前

--description <description>

ポートペアの説明

74.22. sfc port pair show

ポートペアの詳細を表示します。

使用方法

openstack sfc port pair show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <port-pair>

表74.83 位置引数

概要

<port-pair>

表示するポートペア(名前または ID)

表74.84 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表74.85 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.86 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.87 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表74.88 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

74.23. sfc service graph create

サービスグラフを作成します。

使用方法

openstack sfc service graph create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--description DESCRIPTION]
                                          --branching-point
                                          SRC_CHAIN:DST_CHAIN_1,DST_CHAIN_2,DST_CHAIN_N
                                          <name>

表74.89 位置引数

概要

<name>

サービスグラフの名前。

表74.90 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description DESCRIPTION

サービスグラフの説明。

--branching-point SRC_CHAIN:DST_CHAIN_1,DST_CHAIN_2,DST_CHAIN_N

サービスグラフの分岐点:キーは、ソースポートチェーンで、値は宛先ポートチェーンのリストです。このオプションを繰り返すことができます。

表74.91 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.92 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.93 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表74.94 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

74.24. sfc service graph delete

特定のサービスグラフを削除します。

使用方法

openstack sfc service graph delete [-h] <service-graph>

表74.95 位置引数

概要

<service-graph>

削除するサービスグラフの ID または名前。

表74.96 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

74.25. sfc service graph list

サービスグラフの一覧を表示します。

使用方法

openstack sfc service graph list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN] [--long]

表74.97 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

表74.98 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表74.99 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表74.100 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.101 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

74.26. sfc service graph set

サービスグラフの属性を設定します。

使用方法

openstack sfc service graph set [-h] [--name <name>]
                                       [--description <description>]
                                       <service-graph>

表74.102 位置引数

概要

<service-graph>

変更するサービスグラフ(名前または ID)

表74.103 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

サービスグラフの名前

--description <description>

サービスグラフの説明

74.27. sfc service graph show

特定のサービスグラフの情報を表示します。

使用方法

openstack sfc service graph show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <service-graph>

表74.104 位置引数

概要

<service-graph>

表示するサービスグラフの ID または名前。

表74.105 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表74.106 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表74.107 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表74.108 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表74.109 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第75章 ソフトウェア

本章では、software コマンドに含まれるコマンドについて説明します。

75.1. software config create

ソフトウェア設定を作成します。

使用方法

openstack software config create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--config-file <config-file>]
                                        [--definition-file <destination-file>]
                                        [--group <group>]
                                        <config-name>

表75.1 位置引数

概要

<config-name>

作成するソフトウェア設定の名前

表75.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--config-file <config-file>

<inputs>、<outputs>、および <options> を定義するマップが含まれる json/yaml へのパス

--definition-file <destination-file>

ソフトウェア設定スクリプト/データへのパス

--group=GROUP

ソフトウェア設定が必要とするツールのグループ名

表75.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは json です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表75.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表75.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表75.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

75.2. software config delete

ソフトウェア設定を削除します。

使用方法

openstack software config delete [-h] <config> [<config> ...]

表75.7 位置引数

概要

<config>

削除するソフトウェア設定の ID

表75.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

75.3. software config list

ソフトウェア設定の一覧を表示します。

使用方法

openstack software config list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--limit <limit>] [--marker <id>]

表75.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--limit <limit>

返される設定の数を制限します。

--marker <id>

指定された設定 ID の後に表示される設定を返します。

表75.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表75.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表75.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表75.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

75.4. software config show

ソフトウェア設定の詳細を表示します。

使用方法

openstack software config show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--config-only]
                                      <config>

表75.14 位置引数

概要

<config>

設定の ID

表75.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--config-only

<config> 属性の値のみを表示します。

表75.16 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表75.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表75.18 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表75.19 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

75.5. software deployment create

ソフトウェアデプロイメントを作成します。

使用方法

openstack software deployment create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--input-value <key=value>]
                                            [--action <action>]
                                            [--config <config>]
                                            [--signal-transport <signal-transport>]
                                            [--container <container>]
                                            [--timeout <timeout>] --server
                                            <server>
                                            <deployment-name>

表75.20 位置引数

概要

<deployment-name>

このデプロイメントに関連する派生設定の名前。これは、サーバーに現在デプロイされている設定のリストにソート順序を適用するために使用されます。

表75.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--input-value <key=value>

デプロイメントに設定する入力値。これは複数回指定できます。

--action <action>

このデプロイメントのアクションの名前。カスタムアクション、または CREATE、UPDATE、DELETE、SUSPEND、RESUME のいずれか。デフォルトは UPDATE です。

--config <config>

デプロイする設定の ID

--signal-transport <signal-transport>

デプロイメント出力値を使用して、サーバーが heat にシグナルを送信する方法。TEMP_URL_SIGNAL は、HTTP PUT 経由でシグナル送信する Swift TempURL を作成します。ZAQAR_SIGNAL は、提供された keystone 認証情報を使用してシグラル送信する専用の zaqar キューを作成します。NO_SIGNAL は、シグナルを待たずにリソースを COMPLETE 状態にします。

--container <container>

temp_url_signal オブジェクトを保存するオプションのコンテナー名指定しない場合は、DEPLOY_NAME から派生した名前でコンテナーが作成されます。

--timeout <timeout>

デプロイメントのタイムアウト (分単位)

--server <server>

デプロイ先のサーバーの ID

表75.22 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表75.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表75.24 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表75.25 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

75.6. software deployment delete

ソフトウェアデプロイメントおよび依存関係にある設定を削除します。

使用方法

openstack software deployment delete [-h]
                                            <deployment> [<deployment> ...]

表75.26 位置引数

概要

<deployment>

削除するデプロイメントの ID。

表75.27 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

75.7. software deployment list

ソフトウェアデプロイメントを一覧表示します。

使用方法

openstack software deployment list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          [--server <server>] [--long]

表75.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--server <server>

デプロイメントを取得するサーバーの ID

--long

出力でより多くのフィールドを一覧表示します。

表75.29 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表75.30 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表75.31 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表75.32 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

75.8. software deployment metadata show

指定されたサーバーのデプロイメント設定のメタデータを取得します。

使用方法

openstack software deployment metadata show [-h] <server>

表75.33 位置引数

概要

<server>

デプロイメントを取得するサーバーの ID

表75.34 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

75.9. software deployment output show

特定のデプロイメント出力を表示します。

使用方法

openstack software deployment output show [-h] [--all] [--long]
                                                 <deployment> [<output-name>]

表75.35 位置引数

概要

<deployment>

出力を表示するデプロイメントの ID

<output-name>

表示する出力の名前

表75.36 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all

すべてのデプロイメント出力を表示します。

--long

完全なデプロイメントログを出力に表示します。

75.10. software deployment show

ソフトウェアデプロイメントの詳細を表示します。

使用方法

openstack software deployment show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--long]
                                          <deployment>

表75.37 位置引数

概要

<deployment>

デプロイメントの ID

表75.38 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力により多くのフィールドを表示します。

表75.39 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表75.40 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表75.41 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表75.42 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第76章 stack

本章では、stack コマンドに含まれるコマンドについて説明します。

76.1. stack abandon

スタックおよび出力の結果を破棄します。

使用方法

openstack stack abandon [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--output-file <output-file>]
                               <stack>

表76.1 位置引数

概要

<stack>

破棄するスタックの名前または ID

表76.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--output-file <output-file>

破棄の結果を出力するファイル

表76.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは json です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.2. stack adopt

スタックを受け入れます。

使用方法

openstack stack adopt [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [-e <environment>]
                             [--timeout <timeout>] [--enable-rollback]
                             [--parameter <key=value>] [--wait] --adopt-file
                             <adopt-file>
                             <stack-name>

表76.7 位置引数

概要

<stack-name>

受け入れるスタックの名前

表76.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-e <environment>, --environment <environment>

環境へのパス。複数回指定できます。

--timeout <timeout>

スタック作成のタイムアウト(分単位)

--enable-rollback

作成/更新失敗時のロールバックを有効にします。

--parameter <key=value>

スタックの作成に使用するパラメーター値。複数回指定できます。

--wait

スタックの受け入れが完了するまで待ちます。

--adopt-file <adopt-file>

受け入れスタックデータファイルへのパス

表76.9 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.10 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.11 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.12 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.3. stack cancel

スタックの現在のタスクを取り消します。取り消しがサポートされるタスク:* 更新 * 作成

使用方法

openstack stack cancel [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN] [--wait]
                              [--no-rollback]
                              <stack> [<stack> ...]

表76.13 位置引数

概要

<stack>

取り消すスタック(名前または ID)

表76.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait

取り消しが完了するまで待ちます。

--no-rollback

ロールバックせずに取り消します。

表76.15 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表76.16 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表76.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.18 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.4. stack check

スタックを確認します。

使用方法

openstack stack check [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--wait]
                             <stack> [<stack> ...]

表76.19 位置引数

概要

<stack>

更新を確認するスタック(名前または ID)

表76.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait

確認が完了するまで待ちます。

表76.21 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表76.22 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表76.23 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.24 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.5. stack create

スタックを作成します。

使用方法

openstack stack create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [-e <environment>]
                              [--timeout <timeout>] [--pre-create <resource>]
                              [--enable-rollback] [--parameter <key=value>]
                              [--parameter-file <key=file>] [--wait]
                              [--tags <tag1,tag2...>] [--dry-run] -t
                              <template>
                              <stack-name>

表76.25 位置引数

概要

<stack-name>

作成するスタックの名前

表76.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-e <environment>, --environment <environment>

環境へのパス。複数回指定できます。

--timeout <timeout>

スタック作成のタイムアウト(分単位)

--pre-create <resource>

作成前フックを設定するリソースの名前。入れ子状のスタックのリソースは、スラッシュを区切り文字として使用して設定できます (例: ``nested_stack/another/my_resource``)。ワイルドカードを使用すると、複数のスタックまたはリソースを照合できます(例:''nested_stack/an*/*_resource'')。これは複数回指定できます。

--enable-rollback

作成/更新失敗時のロールバックを有効にします。

--parameter <key=value>

スタックの作成に使用するパラメーター値。これは複数回指定できます。

--parameter-file <key=file>

スタックの作成に使用するファイルからのパラメーター値。これは複数回指定できます。パラメーター値は、ファイルのコンテンツです。

--wait

スタックが create_complete または CREATE_FAILED になるまで待機します。

--tags <tag1,tag2…​>

スタックに関連付けるタグの一覧

--dry-run

実際にはスタックの作成を行わずに、何が作成されるかを表示します。

-t <template>, --template <template>

テンプレートへのパス

表76.27 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.28 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.29 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.30 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.6. stack delete

スタックを削除します。

使用方法

openstack stack delete [-h] [-y] [--wait] <stack> [<stack> ...]

表76.31 位置引数

概要

<stack>

削除するスタック(名前または ID)

表76.32 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-y、--yes

yes/noプロンプトを省略します(yesと仮定)。

--wait

スタックの削除が完了するまで待ちます。

76.7. stack environment show

スタックの環境を表示します。

使用方法

openstack stack environment show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <NAME or ID>

表76.33 位置引数

概要

<NAME or ID>

クエリーを行うスタックの名前または ID

表76.34 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表76.35 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.36 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.37 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.38 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.8. stack event list

イベントを一覧表示します。

使用方法

openstack stack event list [-h] [-f {csv,json,log,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  [--resource <resource>]
                                  [--filter <key=value>] [--limit <limit>]
                                  [--marker <id>] [--nested-depth <depth>]
                                  [--sort <key>[:<direction>]] [--follow]
                                  <stack>

表76.39 位置引数

概要

<stack>

イベントを表示するスタックの名前または ID

表76.40 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resource <resource>

イベントを表示するリソースの名前。注記:--nested-depth と共に指定することはできません。

--filter <key=value>

返されたイベントに適用するフィルターパラメーター

--limit <limit>

返されるイベントの数を制限します。

--marker <id>

指定の id の後に表示されるイベントのみを返します。

--nested-depth <depth>

イベントを表示するネストされたスタックの深さ。注記:これは --resource と共に指定することはできません。

--sort <key>[:<direction>]

選択した鍵と方向(asc または desc、デフォルト:asc)で出力を並べ替えます。複数のキーでソートするには複数回指定します。ソート用のキーには、"event_time" (デフォルト)、"resource_name"、"links"、"logical_resource_id"、"resource_status"、"resource_status_reason"、"physical_resource_id"、または "id" を使用できます。キーは空のままにし、リバースタイムでソートするために「:desc」を指定できます。

--follow

プロセスが停止するまでイベントを出力します。

表76.41 出力形式の設定

概要

-f {csv,json,log,table,value,yaml}, --format {csv,json,log,table,value,yaml}

出力形式。デフォルトは log です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表76.42 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表76.43 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.44 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.9. stack event show

イベントの詳細を表示します。

使用方法

openstack stack event show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <stack> <resource> <event>

表76.45 位置引数

概要

<stack>

イベントを表示するスタックの名前または ID

<resource>

イベントが属するリソースの名前

<event>

詳細を表示するイベントの ID

表76.46 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表76.47 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.48 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.49 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.50 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.10. stack export

スタックデータ json をエクスポートします。

使用方法

openstack stack export [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--output-file <output-file>]
                              <stack>

表76.51 位置引数

概要

<stack>

エクスポートするスタックの名前または ID

表76.52 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--output-file <output-file>

エクスポートデータを出力するファイル

表76.53 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは json です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.54 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.55 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.56 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.11. stack failures list

障害が発生したスタックリソースに関する情報を表示します。

使用方法

openstack stack failures list [-h] [--long] <stack>

表76.57 位置引数

概要

<stack>

表示するスタック(名前または ID)

表76.58 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

完全なデプロイメントログを出力に表示します。

76.12. stack file list

スタックのファイルマップを表示します。

使用方法

openstack stack file list [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <NAME or ID>

表76.59 位置引数

概要

<NAME or ID>

クエリーを行うスタックの名前または ID

表76.60 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表76.61 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.62 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.63 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.64 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.13. stack hook clear

特定のスタックでリソースフックを消去します。

使用方法

openstack stack hook clear [-h] [--pre-create] [--pre-update]
                                  [--pre-delete]
                                  <stack> <resource> [<resource> ...]

表76.65 位置引数

概要

<stack>

表示するスタック(名前または ID)

<resource>

消去するフックが設定されたリソース名。入れ子状のスタックのリソースは、スラッシュを区切り文字として使用して設定できます (例: ``nested_stack/another/my_resource``)。ワイルドカードを使用すると、複数のスタックまたはリソースを照合できます(例:''nested_stack/an*/*_resource'')。

表76.66 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--pre-create

作成前フックを消去します。

--pre-update

更新前のフックを消去します。

--pre-delete

削除前フックを削除します。

76.14. stack hook poll

スタックの保留中のフックを持つリソースを一覧表示します。

使用方法

openstack stack hook poll [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN]
                                 [--nested-depth <nested-depth>]
                                 <stack>

表76.67 位置引数

概要

<stack>

表示するスタック(名前または ID)

表76.68 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--nested-depth <nested-depth>

フックを表示するネストされたスタックの深さ。

表76.69 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表76.70 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表76.71 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.72 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.15. stack list

スタックを一覧表示します。

使用方法

openstack stack list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--deleted] [--nested] [--hidden]
                            [--property <key=value>] [--tags <tag1,tag2...>]
                            [--tag-mode <mode>] [--limit <limit>]
                            [--marker <id>] [--sort <key>[:<direction>]]
                            [--all-projects] [--short] [--long]

表76.73 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--deleted

スタック一覧に、ソフト削除されたスタックを含めます。

--nested

スタック一覧に、ネスティングされたスタックを含めます。

--hidden

スタック一覧に、非表示のスタックを含めます。

--property <key=value>

返されたスタックに適用するフィルター属性(複数の属性で絞り込むには繰り返し指定します)

--tags <tag1,tag2…​>

絞り込みに使用するタグの一覧。--tag- modeと組み合わせることで、タグのフィルター方法を指定できます。

--tag-mode <mode>

タグをフィルタリングする方法。「any」、「not」、または「not-any」のいずれかでなければなりません。指定しない場合、複数のタグをブール値 AND 式で組み合わせます。

--limit <limit>

返されるスタックの数

--marker <id>

指定の id の後に表示されるスタックのみを返します。

--sort <key>[:<direction>]

選択した鍵と方向(asc または desc、デフォルト:asc)で出力を並べ替えます。複数の属性でソートするには複数回指定します。

--all-projects

すべてのプロジェクトを含めます(管理者のみ)。

--short

出力でより少ないフィールドを一覧表示します。

--long

出力の追加フィールドを一覧表示します。これは --all-projects によって暗示されます。

表76.74 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表76.75 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表76.76 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.77 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.16. stack output list

スタックの出力を一覧表示します。

使用方法

openstack stack output list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   <stack>

表76.78 位置引数

概要

<stack>

クエリーを行うスタックの名前または ID

表76.79 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表76.80 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表76.81 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表76.82 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.83 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.17. stack output show

スタックの出力を表示します。

使用方法

openstack stack output show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty] [--all]
                                   <stack> [<output>]

表76.84 位置引数

概要

<stack>

クエリーを行うスタックの名前または ID

<output>

表示する出力の名前

表76.85 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all

すべてのスタック出力を表示します。

表76.86 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.87 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.88 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.89 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.18. stack resource list

スタックリソースを一覧表示します。

使用方法

openstack stack resource list [-h] [-f {csv,dot,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN] [--long]
                                     [-n <nested-depth>]
                                     [--filter <key=value>]
                                     <stack>

表76.90 位置引数

概要

<stack>

クエリーを行うスタックの名前または ID

表76.91 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

リソース一覧の各リソースで提示される詳細情報を有効にする

-n <nested-depth>, --nested-depth <nested-depth>

リソースを表示するネストされたスタックの深さ。

--filter <key=value>

リソースの名前、ステータス、種別、アクション、id、および physical_resource_id をもとに返されるリソースに適用するフィルターパラメーター

表76.92 出力形式の設定

概要

-f {csv,dot,json,table,value,yaml}, --format {csv,dot,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表76.93 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表76.94 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.95 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.19. stack resource mark unhealthy

リソースの健全性を設定します。

使用方法

openstack stack resource mark unhealthy [-h] [--reset]
                                               <stack> <resource> [reason]

表76.96 位置引数

概要

<stack>

リソースが属するスタックの名前または ID

<resource>

リソースの名前

reason

状態変更の理由

表76.97 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--reset

リソースを健全として設定します。

76.20. stack resource metadata

リソースメタデータを表示します。

使用方法

openstack stack resource metadata [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <stack> <resource>

表76.98 位置引数

概要

<stack>

表示するスタック(名前または ID)

<resource>

メタデータを表示するリソースの名前

表76.99 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表76.100 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは json です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.101 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.102 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.103 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.21. stack resource show

スタックリソースを表示します。

使用方法

openstack stack resource show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--with-attr <attribute>]
                                     <stack> <resource>

表76.104 位置引数

概要

<stack>

クエリーを行うスタックの名前または ID

<resource>

リソースの名前

表76.105 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--with-attr <attribute>

表示する属性。複数回指定できます。

表76.106 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.107 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.108 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.109 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.22. stack resource signal

オプションのデータを持つリソースにシグナルを送ります。

使用方法

openstack stack resource signal [-h] [--data <data>]
                                       [--data-file <data-file>]
                                       <stack> <resource>

表76.110 位置引数

概要

<stack>

リソースが属するスタックの名前または ID

<resource>

シグナルを送るリソースの名前

表76.111 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--data <data>

シグナルハンドラーに送信する JSON データ

--data-file <data-file>

シグナルハンドラーに送信する json データが含まれるファイル

76.23. stack resume

スタックを再開します。

使用方法

openstack stack resume [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN] [--wait]
                              <stack> [<stack> ...]

表76.112 位置引数

概要

<stack>

再開するスタック(名前または ID)

表76.113 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait

再開が完了するまで待ちます。

表76.114 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表76.115 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表76.116 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.117 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.24. stack show

スタックの詳細を表示します。

使用方法

openstack stack show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--no-resolve-outputs]
                            <stack>

表76.118 位置引数

概要

<stack>

表示するスタック(名前または ID)

表76.119 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--no-resolve-outputs

スタックの出力を解決しません。

表76.120 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.121 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.122 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.123 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.25. stack snapshot create

スタックのスナップショットを作成します。

使用方法

openstack stack snapshot create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] [--name <name>]
                                       <stack>

表76.124 位置引数

概要

<stack>

スタックの名前または ID

表76.125 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

スナップショットの名前

表76.126 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.127 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.128 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.129 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.26. stack snapshot delete

スタックのスナップショットを削除します。

使用方法

openstack stack snapshot delete [-h] [-y] <stack> <snapshot>

表76.130 位置引数

概要

<stack>

スタックの名前または ID

<snapshot>

スタックスナップショットの ID

表76.131 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-y、--yes

yes/noプロンプトを省略します(yesと仮定)。

76.27. stack snapshot list

スタックのスナップショットを一覧表示します。

使用方法

openstack stack snapshot list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     <stack>

表76.132 位置引数

概要

<stack>

スナップショットが含まれるスタックの名前または ID

表76.133 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表76.134 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表76.135 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表76.136 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.137 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.28. stack snapshot restore

スタックのスナップショットを復元します。

使用方法

openstack stack snapshot restore [-h] <stack> <snapshot>

表76.138 位置引数

概要

<stack>

スナップショットが含まれるスタックの名前または ID

<snapshot>

復元するスナップショットの ID

表76.139 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

76.29. stack snapshot show

スタックのスナップショットを表示します。

使用方法

openstack stack snapshot show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <stack> <snapshot>

表76.140 位置引数

概要

<stack>

スナップショットが含まれるスタックの名前または ID

<snapshot>

表示するスナップショットの ID

表76.141 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表76.142 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.143 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.144 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.145 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.30. stack suspend

スタックを中断します。

使用方法

openstack stack suspend [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN] [--wait]
                               <stack> [<stack> ...]

表76.146 位置引数

概要

<stack>

中断するスタック(名前または ID)

表76.147 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--wait

中断が完了するまで待ちます。

表76.148 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表76.149 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表76.150 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.151 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.31. stack template show

スタックのテンプレートを表示します。

使用方法

openstack stack template show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <stack>

表76.152 位置引数

概要

<stack>

クエリーを行うスタックの名前または ID

表76.153 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表76.154 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは yaml です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.155 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.156 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.157 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

76.32. stack update

スタックを更新します。

使用方法

openstack stack update [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [-t <template>]
                              [-e <environment>] [--pre-update <resource>]
                              [--timeout <timeout>] [--rollback <value>]
                              [--dry-run] [--show-nested]
                              [--parameter <key=value>]
                              [--parameter-file <key=file>] [--existing]
                              [--clear-parameter <parameter>]
                              [--tags <tag1,tag2...>] [--wait] [--converge]
                              <stack>

表76.158 位置引数

概要

<stack>

更新するスタックの名前または ID

表76.159 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-t <template>, --template <template>

テンプレートへのパス

-e <environment>, --environment <environment>

環境へのパス。複数回指定できます。

--pre-update <resource>

更新前フックを設定するリソースの名前。入れ子状のスタックのリソースは、スラッシュを区切り文字として使用して設定できます (例: ``nested_stack/another/my_resource``)。ワイルドカードを使用すると、複数のスタックまたはリソースを照合できます(例:''nested_stack/an*/*_resource'')。これは複数回指定できます。

--timeout <timeout>

スタック更新のタイムアウト(分単位)

--rollback <value>

更新の失敗時にロールバックを設定します。値 "enabled" はロールバックを有効に設定します。値 "disabled" はロールバックを無効に設定します。値「keep」は、更新する既存のスタックの値を使用します(デフォルト)。

--dry-run

実際にはスタックの更新を行わずに、何が変更されるかを表示します。

--show-nested

--dry-run の実行時にネストされたスタックを表示します。

--parameter <key=value>

スタックの作成に使用するパラメーター値。これは複数回指定できます。

--parameter-file <key=file>

スタックの作成に使用するファイルからのパラメーター値。これは複数回指定できます。パラメーター値は、ファイルのコンテンツです。

--existing

現在のスタックのテンプレート、パラメーター、および環境を再利用します。テンプレートの引数を省略すると、既存のテンプレートが使用されます。--environment を指定しないと、既存の環境が使用されます。--parameter で指定したパラメーターは、現在のスタックの既存の値にパッチを適用します。省略されたパラメーターは既存の値を維持します。

--clear-parameter <parameter>

スタックの更新用に、現在のスタックのパラメーターセットからパラメーターを削除します。テンプレートのデフォルト値が使用されます。これは複数回指定できます。

--tags <tag1,tag2…​>

スタックに関連付ける更新されたタグの一覧

--wait

スタックが update_complete または UPDATE_FAILED になるまで待機します。

--converge

現実性を観察しながらのスタック更新。

表76.160 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表76.161 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表76.162 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表76.163 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第77章 subnet

本章では、subnet コマンドに含まれるコマンドについて説明します。

77.1. subnet create

サブネットを作成します。

使用方法

openstack subnet create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--project <project>]
                               [--project-domain <project-domain>]
                               [--subnet-pool <subnet-pool> | --use-prefix-delegation USE_PREFIX_DELEGATION | --use-default-subnet-pool]
                               [--prefix-length <prefix-length>]
                               [--subnet-range <subnet-range>]
                               [--dhcp | --no-dhcp] [--gateway <gateway>]
                               [--ip-version {4,6}]
                               [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
                               [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
                               [--network-segment <network-segment>] --network
                               <network> [--description <description>]
                               [--allocation-pool start=<ip-address>,end=<ip-address>]
                               [--dns-nameserver <dns-nameserver>]
                               [--host-route destination=<subnet>,gateway=<ip-address>]
                               [--service-type <service-type>]
                               [--tag <tag> | --no-tag]
                               <name>

表77.1 位置引数

概要

<name>

新規サブネット名

表77.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--subnet-pool <subnet-pool>

このサブネットが cidrを取得するサブネットプール(名前または ID)。

--use-prefix-delegation USE_PREFIX_DELEGATION

ip が ipv6 形式で、ip が外部に委譲される場合は prefix-delegation を使用します。

--use-default-subnet-pool

--ip-version のデフォルトのサブネットプールを使用します。

--prefix-length <prefix-length>

サブネットプールからのサブネット割り当てのプレフィックス長

--subnet-range <subnet-range>

cidr 表記のサブネット範囲(--subnet- pool が指定されていない場合には必須、それ以外の場合はオプション)

--dhcp

dhcpを有効にします(デフォルト)。

--no-dhcp

dhcp を無効にします。

--gateway <gateway>

サブネットのゲートウェイを指定します。3 つのオプションは、<ip-address>: ゲートウェイとして使用する特定の IP アドレス、auto: ゲートウェイのアドレスはサブネット自体から自動的に選択される、none: このサブネットはゲートウェイを使用しない、です(例:--gateway 192.168.9.1、--gateway auto、--gateway none(デフォルトは auto))。

--ip-version {4,6}

IP バージョン(デフォルトは 4)。サブネットプールが指定されている場合には、サブネットプールから IP バージョンが決定され、このオプションは無視されます。

--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}

Ipv6 ra(ルーター広告)モード。有効なモード:[dhcpv6-stateful、dhcpv6-stateless、slaac]

--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}

Ipv6 アドレスモード。有効なモード:[dhcpv6-stateful、dhcpv6-stateless、slaac]

--network-segment <network-segment>

このサブネットに関連付けるネットワークセグメント(名前または ID)

--network <network>

このサブネットが属するネットワーク(名前または ID)

--description <description>

サブネットの説明を設定します。

--allocation-pool start=<ip-address>,end=<ip-address>

このサブネットの割り当てプール IP アドレス(例:start=192.168.199.2,end=192.168.199.254)(複数の IP アドレスを追加する場合はオプションを繰り返し使用します)

--dns-nameserver <dns-nameserver>

このサブネットの DNS サーバー(複数の DNS サーバーを設定する場合はオプションを繰り返し使用します)

--host-route destination=<subnet>,gateway=<ip-address>

このサブネットの追加のルート(例:destination=10.10.0.0/16,gateway=192.168.71.254、 destination: 宛先のサブネット (CIDR 表記)、gateway: 次のホップの IP アドレス)(複数のルートを追加する場合はオプションを繰り返し使用します)

--service-type <service-type>

このサブネットのサービス種別(例:network:floatingip_agent_gateway)。ネットワークポートの有効なデバイス所有者の値でなければなりません(複数のサービス種別を設定する場合はオプションを繰り返し使用します)。

--tag <tag>

サブネットに追加されるタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

サブネットにタグを関連付けません。

表77.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表77.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表77.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表77.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

77.2. subnet delete

サブネットを削除します。

使用方法

openstack subnet delete [-h] <subnet> [<subnet> ...]

表77.7 位置引数

概要

<subnet>

削除するサブネット(名前または ID)

表77.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

77.3. subnet list

サブネットを一覧表示します。

使用方法

openstack subnet list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--long]
                             [--ip-version <ip-version>] [--dhcp | --no-dhcp]
                             [--service-type <service-type>]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--network <network>] [--gateway <gateway>]
                             [--name <name>] [--subnet-range <subnet-range>]
                             [--tags <tag>[,<tag>,...]]
                             [--any-tags <tag>[,<tag>,...]]
                             [--not-tags <tag>[,<tag>,...]]
                             [--not-any-tags <tag>[,<tag>,...]]

表77.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--ip-version <ip-version>

出力に、指定した ip バージョンのサブネットのみを一覧表示します。IP バージョンに使用可能な値は 4 および 6 です。

--dhcp

dhcp が有効になっているサブネットを一覧表示します。

--no-dhcp

dhcp が無効になっているサブネットを一覧表示します。

--service-type <service-type>

出力に、指定のサービス種別のサブネットのみを一覧表示します(例:network:floatingip_agent_gateway)。ネットワークポートの有効なデバイス所有者の値でなければなりません(複数のサービス種別を一覧表示する場合はオプションを繰り返し使用します)。

--project <project>

出力に、指定のプロジェクトに属するサブネットのみを一覧表示します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--network <network>

出力に、指定のネットワークに属するサブネットのみを一覧表示します(名前または ID)。

--gateway <gateway>

出力に、指定したゲートウェイのサブネットのみを一覧表示します。

--name <name>

出力に、指定した名前のサブネットのみを一覧表示します。

--subnet-range <subnet-range>

出力に、指定のサブネット範囲(cidr 表記)のサブネットのみを一覧表示します(例:--subnet-range 10.10.0.0/16)。

--tags <tag>[,<tag>,…​]

指定したすべてのタグ(タグのコンマ区切りリスト)が設定されたサブネットを一覧表示します。

--any-tags <tag>[,<tag>,…​]

指定したタグ(タグのコンマ区切りリスト)のいずれかが設定されたサブネットを一覧表示します。

--not-tags <tag>[,<tag>,…​]

指定したすべてのタグ(タグのコンマ区切りリスト)が設定されたサブネットを除外します。

--not-any-tags <tag>[,<tag>,…​]

指定したタグ(タグのコンマ区切りリスト)のいずれかが設定されたサブネットを除外します。

表77.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表77.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表77.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表77.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

77.4. subnet pool create

サブネットプールを作成します。

使用方法

openstack subnet pool create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] --pool-prefix
                                    <pool-prefix>
                                    [--default-prefix-length <default-prefix-length>]
                                    [--min-prefix-length <min-prefix-length>]
                                    [--max-prefix-length <max-prefix-length>]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--address-scope <address-scope>]
                                    [--default | --no-default]
                                    [--share | --no-share]
                                    [--description <description>]
                                    [--default-quota <num-ip-addresses>]
                                    [--tag <tag> | --no-tag]
                                    <name>

表77.14 位置引数

概要

<name>

新規サブネットプールの名前

表77.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--pool-prefix <pool-prefix>

サブネットプールのプレフィックス(cidr 表記)を設定します(複数のプレフィックスを設定する場合はオプションを繰り返し使用します)。

--default-prefix-length <default-prefix-length>

サブネットプールのデフォルトプレフィックス長を設定します。

--min-prefix-length <min-prefix-length>

サブネットプールの最小プレフィックス長を設定します。

--max-prefix-length <max-prefix-length>

サブネットプールの最大プレフィックス長を設定します。

--project <project>

所有者のプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--address-scope <address-scope>

サブネットプールに関連付けられたアドレススコープを設定します(名前または ID)。プレフィックスは、アドレススコープ全体で一意でなければなりません。

--default

これをデフォルトのサブネットプールとして設定します。

--no-default

これをデフォルト以外のサブネットプールとして設定します。

--share

このサブネットプールを共有として設定します。

--no-share

このサブネットプールを非共有として設定します。

--description <description>

サブネットプールの説明を設定します。

--default-quota <num-ip-addresses>

このサブネットプールのデフォルトのプロジェクトクォータを、サブネットプールから割り当て可能な IP アドレスの数として設定します。

--tag <tag>

サブネットプールに追加されるタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

サブネットプールにタグを関連付けません。

表77.16 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表77.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表77.18 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表77.19 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

77.5. subnet pool delete

サブネットプールを削除します。

使用方法

openstack subnet pool delete [-h] <subnet-pool> [<subnet-pool> ...]

表77.20 位置引数

概要

<subnet-pool>

削除するサブネットプール(名前または ID)

表77.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

77.6. subnet pool list

サブネットプールを一覧表示します。

使用方法

openstack subnet pool list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN] [--long]
                                  [--share | --no-share]
                                  [--default | --no-default]
                                  [--project <project>]
                                  [--project-domain <project-domain>]
                                  [--name <name>]
                                  [--address-scope <address-scope>]
                                  [--tags <tag>[,<tag>,...]]
                                  [--any-tags <tag>[,<tag>,...]]
                                  [--not-tags <tag>[,<tag>,...]]
                                  [--not-any-tags <tag>[,<tag>,...]]

表77.22 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--share

プロジェクト間で共有されるサブネットプールを一覧表示します。

--no-share

プロジェクト間で共有されないサブネットプールを一覧表示します。

--default

デフォルトの外部サブネットプールとして使用されるサブネットプールを一覧表示します。

--no-default

デフォルトの外部サブネットプールとして使用されないサブネットプールを一覧表示します。

--project <project>

プロジェクトに従ってサブネットプールを一覧表示します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--name <name>

出力に、指定した名前のサブネットプールのみを一覧表示します。

--address-scope <address-scope>

出力に、指定したアドレススコープのサブネットプールのみを一覧表示します(名前または ID)。

--tags <tag>[,<tag>,…​]

指定したすべてのタグ(タグのコンマ区切りリスト)が設定されたサブネットプールを一覧表示します。

--any-tags <tag>[,<tag>,…​]

指定したタグ(タグのコンマ区切りリスト)のいずれかが設定されたサブネットプールを一覧表示します。

--not-tags <tag>[,<tag>,…​]

指定したすべてのタグ(タグのコンマ区切りリスト)が設定されたサブネットプールを除外します。

--not-any-tags <tag>[,<tag>,…​]

指定したタグ(タグのコンマ区切りリスト)のいずれかが設定されたサブネットプールを除外します。

表77.23 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表77.24 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表77.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表77.26 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

77.7. subnet pool set

サブネットプールの属性を設定します。

使用方法

openstack subnet pool set [-h] [--name <name>]
                                 [--pool-prefix <pool-prefix>]
                                 [--default-prefix-length <default-prefix-length>]
                                 [--min-prefix-length <min-prefix-length>]
                                 [--max-prefix-length <max-prefix-length>]
                                 [--address-scope <address-scope> | --no-address-scope]
                                 [--default | --no-default]
                                 [--description <description>]
                                 [--default-quota <num-ip-addresses>]
                                 [--tag <tag>] [--no-tag]
                                 <subnet-pool>

表77.27 位置引数

概要

<subnet-pool>

変更するサブネットプール(名前または ID)

表77.28 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

サブネットプールの名前を設定します。

--pool-prefix <pool-prefix>

サブネットプールのプレフィックス(cidr 表記)を設定します(複数のプレフィックスを設定する場合はオプションを繰り返し使用します)。

--default-prefix-length <default-prefix-length>

サブネットプールのデフォルトプレフィックス長を設定します。

--min-prefix-length <min-prefix-length>

サブネットプールの最小プレフィックス長を設定します。

--max-prefix-length <max-prefix-length>

サブネットプールの最大プレフィックス長を設定します。

--address-scope <address-scope>

サブネットプールに関連付けられたアドレススコープを設定します(名前または ID)。プレフィックスは、アドレススコープ全体で一意でなければなりません。

--no-address-scope

サブネットプールに関連付けられたアドレススコープを削除します。

--default

これをデフォルトのサブネットプールとして設定します。

--no-default

これをデフォルト以外のサブネットプールとして設定します。

--description <description>

サブネットプールの説明を設定します。

--default-quota <num-ip-addresses>

このサブネットプールのデフォルトのプロジェクトクォータを、サブネットプールから割り当て可能な IP アドレスの数として設定します。

--tag <tag>

サブネットプールに追加されるタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

サブネットプールに関連付けられたタグを消去します。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。

77.8. subnet pool show

サブネットプールの詳細を表示します。

使用方法

openstack subnet pool show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <subnet-pool>

表77.29 位置引数

概要

<subnet-pool>

表示するサブネットプール(名前または ID)

表77.30 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表77.31 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表77.32 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表77.33 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表77.34 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

77.9. subnet pool unset

サブネットプール属性の設定を解除します。

使用方法

openstack subnet pool unset [-h] [--tag <tag> | --all-tag]
                                   <subnet-pool>

表77.35 位置引数

概要

<subnet-pool>

変更するサブネットプール(名前または ID)

表77.36 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--tag <tag>

サブネットプールから削除するタグ(複数のタグを削除する場合はオプションを繰り返し使用します)

--all-tag

サブネットプールに関連付けられたすべてのタグを消去します。

77.10. subnet set

サブネットの属性を設定します。

使用方法

openstack subnet set [-h] [--name <name>] [--dhcp | --no-dhcp]
                            [--gateway <gateway>]
                            [--network-segment <network-segment>]
                            [--description <description>] [--tag <tag>]
                            [--no-tag]
                            [--allocation-pool start=<ip-address>,end=<ip-address>]
                            [--no-allocation-pool]
                            [--dns-nameserver <dns-nameserver>]
                            [--no-dns-nameservers]
                            [--host-route destination=<subnet>,gateway=<ip-address>]
                            [--no-host-route] [--service-type <service-type>]
                            <subnet>

表77.37 位置引数

概要

<subnet>

変更するサブネット(名前または ID)

表77.38 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

サブネットの更新された名前

--dhcp

dhcp を有効にします。

--no-dhcp

dhcp を無効にします。

--gateway <gateway>

サブネットのゲートウェイを指定します。オプションは、<ip-address>: ゲートウェイとして使用する特定の IP アドレス、none: このサブネットはゲートウェイを使用しない、です(例:--gateway 192.168.9.1、--gateway none)。

--network-segment <network-segment>

このサブネットに関連付けるネットワークセグメント(名前または ID)現在の値が None の場合のみセグメントを設定することができます。また、ネットワークにはセグメントを 1 つしか設定できず、ネットワーク上には 1 つのサブネットしか存在できません。

--description <description>

サブネットの説明を設定します。

--tag <tag>

サブネットに追加されるタグ(複数のタグを設定する場合はオプションを繰り返し使用します)

--no-tag

サブネットに関連付けられたタグを消去します。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。

--allocation-pool start=<ip-address>,end=<ip-address>

このサブネットの割り当てプール IP アドレス(例:start=192.168.199.2,end=192.168.199.254)(複数の IP アドレスを追加する場合はオプションを繰り返し使用します)

--no-allocation-pool

サブネットから、関連付けられた割り当てプールを消去します。現在の割り当てプール情報を上書きするには、--allocation-pool と --no-allocation- poolの両方を指定します。

--dns-nameserver <dns-nameserver>

このサブネットの DNS サーバー(複数の DNS サーバーを設定する場合はオプションを繰り返し使用します)

--no-dns-nameservers

dns ネームサーバーの既存の情報を消去します。現在の DNS ネームサーバーの情報を上書きするには、--dns-nameserver と --no-dns-nameserver の両方を指定します。

--host-route destination=<subnet>,gateway=<ip-address>

このサブネットの追加のルート(例:destination=10.10.0.0/16,gateway=192.168.71.254、 destination: 宛先のサブネット (CIDR 表記)、gateway: 次のホップの IP アドレス)(複数のルートを追加する場合はオプションを繰り返し使用します)

--no-host-route

サブネットから関連するホストルートを消去します。現在のホストルート情報を上書きするには、--host-route と --no-host-route の両方を指定します。

--service-type <service-type>

このサブネットのサービス種別(例:network:floatingip_agent_gateway)。ネットワークポートの有効なデバイス所有者の値でなければなりません(複数のサービス種別を設定する場合はオプションを繰り返し使用します)。

77.11. subnet show

サブネットの詳細を表示します。

使用方法

openstack subnet show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <subnet>

表77.39 位置引数

概要

<subnet>

表示するサブネット(名前または ID)

表77.40 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表77.41 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表77.42 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表77.43 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表77.44 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

77.12. subnet unset

サブネット属性の設定を解除します。

使用方法

openstack subnet unset [-h]
                              [--allocation-pool start=<ip-address>,end=<ip-address>]
                              [--dns-nameserver <dns-nameserver>]
                              [--host-route destination=<subnet>,gateway=<ip-address>]
                              [--service-type <service-type>]
                              [--tag <tag> | --all-tag]
                              <subnet>

表77.45 位置引数

概要

<subnet>

変更するサブネット(名前または ID)

表77.46 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--allocation-pool start=<ip-address>,end=<ip-address>

このサブネットから削除する割り当てプール IP アドレス(例:start=192.168.199.2,end=192.168.199.254)(複数の割り当てプールの設定を解除する場合はオプションを繰り返し使用します)

--dns-nameserver <dns-nameserver>

このサブネットから削除する DNS サーバー(複数の DNS サーバーの設定を解除する場合はオプションを繰り返し使用します)

--host-route destination=<subnet>,gateway=<ip-address>

このサブネットから削除するルート(例:destination=10.10.0.0/16,gateway=192.168.71.254、 destination: 宛先のサブネット (CIDR 表記)、gateway: 次のホップの IP アドレス)(複数のホストルートの設定を解除する場合はオプションを繰り返し使用します)

--service-type <service-type>

このサブネットから削除するサービス種別(例:network:floatingip_agent_gateway)。ネットワークポートの有効なデバイス所有者の値でなければなりません(複数のサービス種別の設定を解除する場合はオプションを繰り返し使用します)。

--tag <tag>

サブネットから削除するタグ(複数のタグを削除する場合はオプションを繰り返し使用します)

--all-tag

サブネットに関連付けられたすべてのタグを消去します。

第78章 task

本章では、task コマンドに含まれるコマンドについて説明します。

78.1. task execution list

全タスクを一覧表示します。

使用方法

openstack task execution list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--marker [MARKER]] [--limit [LIMIT]]
                                     [--sort_keys [SORT_KEYS]]
                                     [--sort_dirs [SORT_DIRS]]
                                     [--filter FILTERS] [--oldest]
                                     [workflow_execution]

表78.1 位置引数

概要

workflow_execution

タスクの一覧に関連付けられたワークフロー実行 ID。

表78.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

--oldest

最新のエントリーからではなく、最も古いエントリーから開始する実行を表示します。

表78.3 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表78.4 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表78.5 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表78.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

78.2. task execution published show

タスクが公開した変数を表示します。

使用方法

openstack task execution published show [-h] id

表78.7 位置引数

概要

id

タスク ID

表78.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

78.3. task execution rerun

既存タスクを再度実行します。

使用方法

openstack task execution rerun [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--resume] [-e ENV]
                                      id

表78.9 位置引数

概要

id

タスクの識別子

表78.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--resume

with-items タスクで失敗または開始されていないアクション実行だけを再実行します。

-e ENV、--env ENV

環境変数

表78.11 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表78.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表78.13 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表78.14 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

78.4. task execution result show

タスクの出力データを表示します。

使用方法

openstack task execution result show [-h] id

表78.15 位置引数

概要

id

タスク ID

表78.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

78.5. task execution show

特定のタスクを表示します。

使用方法

openstack task execution show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     task

表78.17 位置引数

概要

task

タスクの識別子

表78.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表78.19 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表78.20 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表78.21 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表78.22 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第79章 tld

本章では、tld コマンドに含まれるコマンドについて説明します。

79.1. tld create

新規 tld を作成します。

使用方法

openstack tld create [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] --name NAME
                            [--description DESCRIPTION] [--all-projects]
                            [--edit-managed]
                            [--sudo-project-id SUDO_PROJECT_ID]

表79.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

TLD 名

--description DESCRIPTION

説明

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表79.2 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表79.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表79.4 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表79.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

79.2. tld delete

tldを削除します。

使用方法

openstack tld delete [-h] [--all-projects] [--edit-managed]
                            [--sudo-project-id SUDO_PROJECT_ID]
                            id

表79.6 位置引数

概要

id

TLD id

表79.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

79.3. tld list

tldを一覧表示します。

使用方法

openstack tld list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                          [--quote {all,minimal,none,nonnumeric}] [--noindent]
                          [--max-width <integer>] [--fit-width]
                          [--print-empty] [--sort-column SORT_COLUMN]
                          [--name NAME] [--description DESCRIPTION]
                          [--all-projects] [--edit-managed]
                          [--sudo-project-id SUDO_PROJECT_ID]

表79.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

TLD 名

--description DESCRIPTION

TLD の説明

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表79.9 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表79.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表79.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表79.12 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

79.4. tld set

tld の属性を設定します。

使用方法

openstack tld set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                         [--noindent] [--prefix PREFIX]
                         [--max-width <integer>] [--fit-width] [--print-empty]
                         [--name NAME]
                         [--description DESCRIPTION | --no-description]
                         [--all-projects] [--edit-managed]
                         [--sudo-project-id SUDO_PROJECT_ID]
                         id

表79.13 位置引数

概要

id

TLD id

表79.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

TLD 名

--description DESCRIPTION

説明

--no-description—​all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表79.15 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表79.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表79.17 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表79.18 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

79.5. tld show

tld の詳細を表示します。

使用方法

openstack tld show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                          [--noindent] [--prefix PREFIX]
                          [--max-width <integer>] [--fit-width]
                          [--print-empty] [--all-projects] [--edit-managed]
                          [--sudo-project-id SUDO_PROJECT_ID]
                          id

表79.19 位置引数

概要

id

TLD id

表79.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表79.21 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表79.22 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表79.23 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表79.24 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第80章 token

本章では、token コマンドに含まれるコマンドについて説明します。

80.1. token issue

新しいトークンを発行します。

使用方法

openstack token issue [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]

表80.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表80.2 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表80.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表80.4 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表80.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

80.2. token revoke

既存のトークンを取り消します。

使用方法

openstack token revoke [-h] <token>

表80.6 位置引数

概要

<token>

削除するトークン

表80.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

第81章 tripleo

本章では、tripleo コマンドに含まれるコマンドについて説明します。

81.1. tripleo config generate ansible

デプロイメント用のデフォルトの ansible.cfg を生成します。

使用方法

openstack tripleo config generate ansible
                                                 [--deployment-user DEPLOYMENT_USER]
                                                 [--output-dir OUTPUT_DIR]

表81.1 その他の引数 (オプション):

概要

--deployment-user DEPLOYMENT_USER

tripleo config generate コマンドを実行するユーザー。デフォルトは stack です。

--output-dir OUTPUT_DIR

ansible.cfg ファイルおよび ansible.log ファイルを出力するディレクトリー。

81.2. tripleo container image delete

レジストリーから指定されたイメージを削除します。

使用方法

openstack tripleo container image delete [-h]
                                                [--registry-url <registry url>]
                                                [--username <username>]
                                                [--password <password>] [-y]
                                                <image to delete>

表81.2 位置引数

概要

<image to delete>

削除されるイメージのフル URL (形式: <fqdn>:<port>/path/to/image)

表81.3 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--registry-url <registry url>

イメージを一覧表示するレジストリーの URL (形式: <fqdn>:<port>)

--username <username>

イメージレジストリーのユーザー名。

--password <password>

イメージレジストリーのパスワード。

-y、--yes

yes/noプロンプトを省略します(yesと仮定)。

81.3. tripleo container image list

レジストリーで検出されたイメージを一覧表示します。

使用方法

openstack tripleo container image list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              [--registry-url <registry url>]
                                              [--username <username>]
                                              [--password <password>]

表81.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--registry-url <registry url>

イメージを一覧表示するレジストリーの URL (形式: <fqdn>:<port>)

--username <username>

イメージレジストリーのユーザー名。

--password <password>

イメージレジストリーのパスワード。

表81.5 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表81.6 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表81.7 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表81.8 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

81.4. tripleo container image prepare default

デフォルトの ContainerImagePrepare パラメーターを生成します。

使用方法

openstack tripleo container image prepare default [-h]
                                                         [--output-env-file <file path>]
                                                         [--local-push-destination]

表81.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--output-env-file <file path>

デフォルトの ContainerImagePrepare 値が含まれる環境ファイルを書き込むファイル。

--local-push-destination

ローカルレジストリーへのアップロードをトリガーするpush_destination を追加します。

81.5. tripleo container image prepare

1 つのコマンドからコンテナーを準備してアップロードします。

使用方法

openstack tripleo container image prepare [-h]
                                                 [--environment-file <file path>]
                                                 [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                                 [--roles-file ROLES_FILE]
                                                 [--output-env-file <file path>]
                                                 [--dry-run]
                                                 [--cleanup <full, partial, none>]

表81.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--environment-file <file path>, -e <file path>

すべての準備アクションを指定する containerimageprepare パラメーターが含まれる環境ファイル。どのサービスをコンテナー化するかを指定する環境ファイルも追加します。エントリーは、コンテナー化されるサービスで使用されるイメージのみを含むようにフィルターされます。(複数回指定することが可能です。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

環境に自動的に追加される環境ファイルのディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。デプロイメントに使用する t-h-t templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは templates ディレクトリーへの相対パスを指定できます。

--output-env-file <file path>

すべてのイメージパラメーターを指定する heat 環境ファイルを書き込むファイル。既存のファイルは上書きされます。

--dry-run

プル、変更、またはプッシュ操作を実行しません。ただし、これらの操作が実施されたかのように、環境ファイルが反映されます。

--cleanup <full, partial, none>

アップロード後に残されたローカルイメージの動作をクリーンアップします。デフォルトの full は、すべてのローカルイメージの削除を試行します。partial は、このホストでのデプロイメントに必要なイメージを残します。noneは、クリーンアップを実行しません。

81.6. tripleo container image push

指定されたイメージをレジストリーにプッシュします。

使用方法

openstack tripleo container image push [-h] [--local]
                                              [--registry-url <registry url>]
                                              [--append-tag APPEND_TAG]
                                              [--username <username>]
                                              [--password <password>]
                                              [--source-username <source_username>]
                                              [--source-password <source_password>]
                                              [--dry-run] [--multi-arch]
                                              [--cleanup]
                                              <image to push>

表81.11 位置引数

概要

<image to push>

アップロードするコンテナーイメージ。<registry>/<namespace>/<name>:<tag> の形式にする必要があります。タグが指定されていない場合は、latest が使用されます。

表81.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--local

コンテナーイメージが現在のシステムにすでにあり、リモートレジストリーからプルする必要がない場合は、このフラグを使用します。

--registry-url <registry url>

<fqdn>:<port> 形式のプッシュ先レジストリーの URL。

--append-tag APPEND_TAG

コンテナーのプッシュ時に既存のタグに追加するタグ。

--username <username>

プッシュ先イメージレジストリーのユーザー名。

--password <password>

プッシュ先イメージレジストリーのパスワード。

--source-username <source_username>

ソースイメージレジストリーのユーザー名。

--source-password <source_password>

ソースイメージレジストリーのパスワード

--dry-run

アップロードのドライランを実行します。アップロードアクションは実行されませんが、認証プロセスが試行されます。

--multi-arch

アップロードのマルチアーキテクチャーサポートを有効にします。

--cleanup

アップロード後にイメージのローカルコピーを削除します。

81.7. tripleo container image show

レジストリーから選択したイメージを表示します。

使用方法

openstack tripleo container image show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--username <username>]
                                              [--password <password>]
                                              <image to inspect>

表81.13 位置引数

概要

<image to inspect>

検査するイメージ(docker.io/library/centos:7 または docker://docker.io/library/centos:7 など)

表81.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--username <username>

イメージレジストリーのユーザー名。

--password <password>

イメージレジストリーのパスワード。

表81.15 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは json です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表81.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表81.17 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表81.18 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

81.8. tripleo deploy

コンテナー化されたアンダークラウドをデプロイします。

使用方法

openstack tripleo deploy [--templates [TEMPLATES]] [--standalone]
                                [--upgrade] [-y] [--stack STACK]
                                [--output-dir OUTPUT_DIR] [--output-only]
                                [--standalone-role STANDALONE_ROLE]
                                [-t <TIMEOUT>] [-e <HEAT ENVIRONMENT FILE>]
                                [--roles-file ROLES_FILE]
                                [--networks-file NETWORKS_FILE]
                                [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                [--heat-api-port <HEAT_API_PORT>]
                                [--heat-user <HEAT_USER>]
                                [--deployment-user DEPLOYMENT_USER]
                                [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                [--heat-container-image <HEAT_CONTAINER_IMAGE>]
                                [--heat-native [HEAT_NATIVE]]
                                [--local-ip <LOCAL_IP>]
                                [--control-virtual-ip <CONTROL_VIRTUAL_IP>]
                                [--public-virtual-ip <PUBLIC_VIRTUAL_IP>]
                                [--local-domain <LOCAL_DOMAIN>] [--cleanup]
                                [--hieradata-override [HIERADATA_OVERRIDE]]
                                [--keep-running] [--inflight-validations]
                                [--force-stack-update | --force-stack-create]

表81.19 その他の引数 (オプション):

概要

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--standalone

アンダークラウドを持たないスタンドアロンデプロイメントとしてデプロイメントを実行します。

--upgrade

既存のデプロイメントをアップグレードします。

-y、--yes

yes/noプロンプトを省略します(yesと仮定)。

--stack STACK

一時(一時的に作成して破棄する)heat スタックの名前

--output-dir OUTPUT_DIR

状態、処理された heat テンプレート、Ansible デプロイメントファイルを出力するディレクトリー。

--output-only

Ansible Playbook は実行されません。デフォルトでは、Playbook は output-dir に保存され、その後実行されます。

--standalone-role STANDALONE_ROLE

デプロイメントのアクションを反映するときに、スタンドアロン設定に使用するロール。

-t <TIMEOUT>, --timeout <TIMEOUT>

デプロイメントのタイムアウト (分単位)

-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。デプロイメントに使用する t-h-t templates ディレクトリーのデフォルトの roles_data_undercloud.yaml を上書きします。絶対パスまたは templates ディレクトリーへの相対パスを指定できます。

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ロールファイル。デプロイメントに使用する t-h-t templates ディレクトリーのデフォルトの /dev/null を上書きします。絶対パスまたは templates ディレクトリーへの相対パスを指定できます。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--heat-api-port <HEAT_API_PORT>

インストーラーのプライベート heat API インスタンスに使用する heat api ポートオプション:デフォルト: 8006。

--heat-user <HEAT_USER>

非特権 heat-all プロセスを実行するユーザー。デフォルトは heat です。

--deployment-user DEPLOYMENT_USER

tripleo deploy コマンドを実行するユーザー。デフォルトは $SUDO_USER です。$SUDO_USER が設定されていない場合は、デフォルトで stack に設定されます。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

デプロイメントアクションに使用する Python インタープリターへのパス。指定しない場合は、openstackclient の python バージョンが使用されます。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。

--heat-container-image <HEAT_CONTAINER_IMAGE>

heat-all プロセスの起動時に使用するコンテナーイメージデフォルト:tripleomaster/centos-binary- heat-all:current-tripleo です。

--heat-native [HEAT_NATIVE]

このホストで heat-all プロセスをネイティブに実行します。このオプションは、heat-all バイナリーをこのマシンにローカルにインストールすることを要求します。このオプションはデフォルトで有効になっています。したがって、heat-all はホスト OS 上で直接実行されます。

--local-ip <LOCAL_IP>

アンダークラウドトラフィックのローカルの ip/cidr (必須)

--control-virtual-ip <CONTROL_VIRTUAL_IP>

コントロールプレーンの仮想 IP。これにより、アンダークラウドのインストーラーはコントロールプレーンにカスタム仮想 IP を設定できます。

--public-virtual-ip <PUBLIC_VIRTUAL_IP>

パブリックの nw 仮想 IP。これにより、アンダークラウドインストーラーはパブリック(外部)NW でカスタム仮想 IP を設定できます。

--local-domain <LOCAL_DOMAIN>

スタンドアロンクラウドおよびその API エンドポイントのローカルドメイン

--cleanup

一時ファイルをクリーンアップします。このフラグを使用すると、コマンド実行後にデプロイメント時に使用される一時ファイルが削除されます。

--hieradata-override [HIERADATA_OVERRIDE]

hieradata オーバーライドファイルへのパス。heat 環境ファイルを参照する際には、--environment-file により t-h-t に渡されます。ファイルにレガシーの instack データが含まれている場合には、<role>ExtraConfig でラップされ、--output-dir に成される一時ファイルとして t-h-t に渡されます。instack hiera データには t-h-t との互換性がないので、手動によるリビジョンが必要になる可能性が高くなっています。

--keep-running

スタック操作が完了した後に、一時 heat を稼働したままにします。これはデバッグ目的にのみ使用されます。一時 Heat は、OS_AUTH_TYPE=none OS_ENDPOINT=http://127.0.0.1:8006/v1/admin openstack スタックリストで openstackclient により使用されます。ここで、8006 は --heat- api-port で指定したポートです。

--inflight-validations

デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。

--force-stack-update

一時 heat スタックの仮想更新を行います(実際の更新はできません)。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=UPDATE を強制します。

--force-stack-create

一時 heat スタックの仮想的な作成を行います。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=CREATE を強制します。

81.9. tripleo upgrade

TripleOをアップグレードします。

使用方法

openstack tripleo upgrade [--templates [TEMPLATES]] [--standalone]
                                 [--upgrade] [-y] [--stack STACK]
                                 [--output-dir OUTPUT_DIR] [--output-only]
                                 [--standalone-role STANDALONE_ROLE]
                                 [-t <TIMEOUT>] [-e <HEAT ENVIRONMENT FILE>]
                                 [--roles-file ROLES_FILE]
                                 [--networks-file NETWORKS_FILE]
                                 [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                 [--heat-api-port <HEAT_API_PORT>]
                                 [--heat-user <HEAT_USER>]
                                 [--deployment-user DEPLOYMENT_USER]
                                 [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                 [--heat-container-image <HEAT_CONTAINER_IMAGE>]
                                 [--heat-native [HEAT_NATIVE]]
                                 [--local-ip <LOCAL_IP>]
                                 [--control-virtual-ip <CONTROL_VIRTUAL_IP>]
                                 [--public-virtual-ip <PUBLIC_VIRTUAL_IP>]
                                 [--local-domain <LOCAL_DOMAIN>] [--cleanup]
                                 [--hieradata-override [HIERADATA_OVERRIDE]]
                                 [--keep-running] [--inflight-validations]
                                 [--force-stack-update | --force-stack-create]

表81.20 その他の引数 (オプション):

概要

--templates [TEMPLATES]

デプロイする Heat テンプレートが格納されているディレクトリー。

--standalone

アンダークラウドを持たないスタンドアロンデプロイメントとしてデプロイメントを実行します。

--upgrade

既存のデプロイメントをアップグレードします。

-y、--yes

yes/noプロンプトを省略します(yesと仮定)。

--stack STACK

一時(一時的に作成して破棄する)heat スタックの名前

--output-dir OUTPUT_DIR

状態、処理された heat テンプレート、Ansible デプロイメントファイルを出力するディレクトリー。

--output-only

Ansible Playbook は実行されません。デフォルトでは、Playbook は output-dir に保存され、その後実行されます。

--standalone-role STANDALONE_ROLE

デプロイメントのアクションを反映するときに、スタンドアロン設定に使用するロール。

-t <TIMEOUT>, --timeout <TIMEOUT>

デプロイメントのタイムアウト (分単位)

-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>

heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。)

--roles-file ROLES_FILE, -r ROLES_FILE

ロールファイル。デプロイメントに使用する t-h-t templates ディレクトリーのデフォルトの roles_data_undercloud.yaml を上書きします。絶対パスまたは templates ディレクトリーへの相対パスを指定できます。

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

ロールファイル。デプロイメントに使用する t-h-t templates ディレクトリーのデフォルトの /dev/null を上書きします。絶対パスまたは templates ディレクトリーへの相対パスを指定できます。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。

--heat-api-port <HEAT_API_PORT>

インストーラーのプライベート heat API インスタンスに使用する heat api ポートオプション:デフォルト: 8006。

--heat-user <HEAT_USER>

非特権 heat-all プロセスを実行するユーザー。デフォルトは heat です。

--deployment-user DEPLOYMENT_USER

tripleo deploy コマンドを実行するユーザー。デフォルトは $SUDO_USER です。$SUDO_USER が設定されていない場合は、デフォルトで stack に設定されます。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

デプロイメントアクションに使用する Python インタープリターへのパス。指定しない場合は、openstackclient の python バージョンが使用されます。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。

--heat-container-image <HEAT_CONTAINER_IMAGE>

heat-all プロセスの起動時に使用するコンテナーイメージデフォルト:tripleomaster/centos-binary- heat-all:current-tripleo です。

--heat-native [HEAT_NATIVE]

このホストで heat-all プロセスをネイティブに実行します。このオプションは、heat-all バイナリーをこのマシンにローカルにインストールすることを要求します。このオプションはデフォルトで有効になっています。したがって、heat-all はホスト OS 上で直接実行されます。

--local-ip <LOCAL_IP>

アンダークラウドトラフィックのローカルの ip/cidr (必須)

--control-virtual-ip <CONTROL_VIRTUAL_IP>

コントロールプレーンの仮想 IP。これにより、アンダークラウドのインストーラーはコントロールプレーンにカスタム仮想 IP を設定できます。

--public-virtual-ip <PUBLIC_VIRTUAL_IP>

パブリックの nw 仮想 IP。これにより、アンダークラウドインストーラーはパブリック(外部)NW でカスタム仮想 IP を設定できます。

--local-domain <LOCAL_DOMAIN>

スタンドアロンクラウドおよびその API エンドポイントのローカルドメイン

--cleanup

一時ファイルをクリーンアップします。このフラグを使用すると、コマンド実行後にデプロイメント時に使用される一時ファイルが削除されます。

--hieradata-override [HIERADATA_OVERRIDE]

hieradata オーバーライドファイルへのパス。heat 環境ファイルを参照する際には、--environment-file により t-h-t に渡されます。ファイルにレガシーの instack データが含まれている場合には、<role>ExtraConfig でラップされ、--output-dir に成される一時ファイルとして t-h-t に渡されます。instack hiera データには t-h-t との互換性がないので、手動によるリビジョンが必要になる可能性が高くなっています。

--keep-running

スタック操作が完了した後に、一時 heat を稼働したままにします。これはデバッグ目的にのみ使用されます。一時 Heat は、OS_AUTH_TYPE=none OS_ENDPOINT=http://127.0.0.1:8006/v1/admin openstack スタックリストで openstackclient により使用されます。ここで、8006 は --heat- api-port で指定したポートです。

--inflight-validations

デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。

--force-stack-update

一時 heat スタックの仮想更新を行います(実際の更新はできません)。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=UPDATE を強制します。

--force-stack-create

一時 heat スタックの仮想的な作成を行います。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=CREATE を強制します。

81.10. tripleo validator group info

検証グループに関する情報を表示します。

使用方法

openstack tripleo validator group info [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]

表81.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表81.22 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表81.23 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表81.24 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表81.25 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

81.11. tripleo validator list

利用可能な検証を一覧表示します。

使用方法

openstack tripleo validator list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--group <group>[,<group>,...]]

表81.26 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--group <group>[,<group>,…​]

特定のグループの検証を一覧表示します。複数のグループが必要な場合は、グループ名をコンマで区切ります(--group pre-upgrade,prep)。

表81.27 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表81.28 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表81.29 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表81.30 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

81.12. tripleo validator run

利用可能な検証を実行します。

使用方法

openstack tripleo validator run [--plan PLAN] [--workers N]
                                       [--extra-vars EXTRA_VARS | --extra-vars-file EXTRA_VARS_FILE]
                                       (--validation <validation_id>[,<validation_id>,...] | --group <group>[,<group>,...])

表81.31 その他の引数 (オプション):

Summary

--plan PLAN、--stack PLAN

カスタムプラン名(デフォルト: overcloud)を使用して検証を実行します。

--workers N, -w N

指定された検証を実行するのに使用できるスレッドの最大数(デフォルト: 1)。

--extra-vars EXTRA_VARS

検証にディクショナリーを追加変数として追加します。--extra-vars {"min_undercloud_ram_gb": 24} (デフォルト: {})

--extra-vars-file EXTRA_VARS_FILE

追加変数が含まれる json/yaml ファイルを検証に追加します(--extra-vars-file /home/stack/vars.[json

yaml]。Mistral を使用する場合は、有効な JSON ファイルのみがサポートされます(デフォルト:)。

--validation <validation_id>[,<validation_id>,…​]

特定の検証を実行します。複数の検証が必要な場合は、名前をコンマで区切ります(--validation check-ftype,512e)。

--validation 512e (default: [])

--group <group>[,<group>,…​]

特定のグループの検証を実行します。複数のグループが必要な場合は、グループ名をコンマで区切ります(--group pre-upgrade,prep)。

81.13. tripleo validator show parameter

検証パラメーターを表示します。

使用方法

openstack tripleo validator show parameter [-h]
                                                  [--validation <validation_id>[,<validation_id>,...]
                                                  | --group
                                                  <group_id>[,<group_id>,...]]
                                                  [--download [json|yaml]
                                                  /tmp/myvars] [-f <format>]

表81.32 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--validation <validation_id>[,<validation_id>,…​]

特定の検証を一覧表示します。複数の検証が必要な場合は、名前をコンマで区切ります(--validation check-ftype,512e)。

--validation 512e (default: [])

--group <group_id>[,<group_id>,…​]

特定のグループの検証を一覧表示します。複数のグループが必要な場合は、グループ名をコンマで区切ります(pre-upgrade,prep)。

openshift-on-openstack (default: [])

--download [json

yaml] /tmp/myvars

検証に使用できるすべての変数を含む json または yaml ファイルを作成します。[yaml

json] /tmp/myvars (default: [])

-f <format>, --format <format>

検証結果を出力します。出力形式の選択肢は json,yaml です(デフォルト:json)。

81.14. tripleo validator show

検証に関する詳細情報を表示します。

使用方法

openstack tripleo validator show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <validation>

表81.33 位置引数

概要

<validation>

検証 id

表81.34 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表81.35 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表81.36 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表81.37 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表81.38 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第82章 trust

本章では、trust コマンドに含まれるコマンドについて説明します。

82.1. trust create

新規信頼を作成します。

使用方法

openstack trust create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] --project <project> --role
                              <role> [--impersonate]
                              [--expiration <expiration>]
                              [--project-domain <project-domain>]
                              [--trustor-domain <trustor-domain>]
                              [--trustee-domain <trustee-domain>]
                              <trustor-user> <trustee-user>

表82.1 位置引数

概要

<trustor-user>

承認を委譲されるユーザー(名前または ID)

<trustee-user>

承認を想定するユーザー(名前または ID)

表82.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

委譲されるプロジェクト(名前または ID)(必須)

--role <role>

承認するロール (名前または ID) (複数の値を設定する場合はオプションを繰り返し使用します。必須)

--impersonate

信頼から生成されたトークンは <trustor> を表します(デフォルトは False)。

--expiration <expiration>

信頼の有効期限を設定します(yyyy- mm-ddTHH:MM:SS の形式)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--trustor-domain <trustor-domain>

<trustor>が含まれるドメイン(名前または ID)

--trustee-domain <trustee-domain>

<trustee>が含まれるドメイン(名前または ID)

表82.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表82.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表82.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表82.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

82.2. trust delete

信頼を削除します。

使用方法

openstack trust delete [-h] <trust> [<trust> ...]

表82.7 位置引数

概要

<trust>

削除する信頼

表82.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

82.3. trust list

信頼の一覧を表示します。

使用方法

openstack trust list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]

表82.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表82.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表82.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表82.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表82.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

82.4. trust show

信頼の詳細を表示します。

使用方法

openstack trust show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty]
                            <trust>

表82.14 位置引数

概要

<trust>

表示する信頼

表82.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表82.16 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表82.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表82.18 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表82.19 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第83章 tsigkey

本章では、tsigkey コマンドに含まれるコマンドについて説明します。

83.1. tsigkey create

新規 tsigkey を作成します。

使用方法

openstack tsigkey create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] --name NAME --algorithm
                                ALGORITHM --secret SECRET --scope SCOPE
                                --resource-id RESOURCE_ID [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]

表83.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

Tsigkey 名

--algorithm ALGORITHM

Tsigkey アルゴリズム

--secret SECRET

Tsigkey シークレット

--scope SCOPE

Tsigkey スコープ

--resource-id RESOURCE_ID

Tsigkey のリソース id

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表83.2 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表83.3 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表83.4 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表83.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

83.2. tsigkey delete

tsigkeyを削除します。

使用方法

openstack tsigkey delete [-h] [--all-projects] [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                id

表83.6 位置引数

概要

id

Tsigkey id

表83.7 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

83.3. tsigkey list

tsigkeyを一覧表示します。

使用方法

openstack tsigkey list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN] [--name NAME]
                              [--algorithm ALGORITHM] [--scope SCOPE]
                              [--all-projects] [--edit-managed]
                              [--sudo-project-id SUDO_PROJECT_ID]

表83.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

Tsigkey 名

--algorithm ALGORITHM

Tsigkey アルゴリズム

--scope SCOPE

Tsigkey スコープ

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表83.9 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表83.10 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表83.11 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表83.12 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

83.4. tsigkey set

tsigkey の属性を設定します。

使用方法

openstack tsigkey set [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--name NAME]
                             [--algorithm ALGORITHM] [--secret SECRET]
                             [--scope SCOPE] [--all-projects] [--edit-managed]
                             [--sudo-project-id SUDO_PROJECT_ID]
                             id

表83.13 位置引数

概要

id

Tsigkey id

表83.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

Tsigkey 名

--algorithm ALGORITHM

Tsigkey アルゴリズム

--secret SECRET

Tsigkey シークレット

--scope SCOPE

Tsigkey スコープ

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表83.15 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表83.16 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表83.17 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表83.18 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

83.5. tsigkey show

tsigkey の詳細を表示します。

使用方法

openstack tsigkey show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--all-projects]
                              [--edit-managed]
                              [--sudo-project-id SUDO_PROJECT_ID]
                              id

表83.19 位置引数

概要

id

Tsigkey id

表83.20 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表83.21 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表83.22 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表83.23 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表83.24 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第84章 undercloud

本章では、undercloud コマンドに含まれるコマンドについて説明します。

84.1. undercloud backup

アンダークラウドのバックアップを作成します。

使用方法

openstack undercloud backup [--add-path ADD_PATH]
                                   [--exclude-path EXCLUDE_PATH]

表84.1 その他の引数 (オプション):

概要

--add-path ADD_PATH

バックアップに追加のファイルを追加します。デフォルトは /home/stack/ です(例: --add-path /this/is/a/folder/ --add- path /this/is/a/texfile.txt)。

--exclude-path EXCLUDE_PATH

アンダークラウドのバックアップを実行する際の除外パス。このオプションは複数回指定することができます。デフォルト:none (例: --exclude-path /this/is/a/folder/ --exclude-path /this/is/a/texfile.txt)

84.2. undercloud install

アンダークラウドをインストールおよび設定します。

使用方法

openstack undercloud install [--force-stack-update] [--no-validations]
                                    [--inflight-validations] [--dry-run] [-y]

表84.2 その他の引数 (オプション):

概要

--force-stack-update

一時 heat スタックの仮想的な更新を行います。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=UPDATE を強制します。

--no-validations

アンダークラウド設定の検証を実行しません。

--inflight-validations

デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。

--dry-run

install コマンドを実行せずに出力します。

-y、--yes

yes/noプロンプトを省略します(yesと仮定)。

84.3. undercloud minion install

アンダークラウドミニオンをインストールおよび設定します。

使用方法

openstack undercloud minion install [--force-stack-update]
                                           [--no-validations] [--dry-run] [-y]

表84.3 その他の引数 (オプション):

概要

--force-stack-update

一時 heat スタックの仮想的な更新を行います。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=UPDATE を強制します。

--no-validations

ミニオン設定の検証を実行しません。

--dry-run

install コマンドを実行せずに出力します。

-y、--yes

yes/noプロンプトを省略します(yesと仮定)。

84.4. undercloud minion upgrade

アンダークラウドミニオンをアップグレードします。

使用方法

openstack undercloud minion upgrade [--force-stack-update]
                                           [--no-validations] [--dry-run] [-y]

表84.4 その他の引数 (オプション):

概要

--force-stack-update

一時 heat スタックの仮想的な更新を行います。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=UPDATE を強制します。

--no-validations

ミニオン設定の検証を実行しません。

--dry-run

install コマンドを実行せずに出力します。

-y、--yes

yes/noプロンプトを省略します(yesと仮定)。

84.5. undercloud upgrade

アンダークラウドをアップグレードします。

使用方法

openstack undercloud upgrade [--force-stack-update] [--no-validations]
                                    [--inflight-validations] [--dry-run] [-y]

表84.5 その他の引数 (オプション):

概要

--force-stack-update

一時 heat スタックの仮想的な更新を行います。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=UPDATE を強制します。

--no-validations

アンダークラウド設定の検証を実行しません。

--inflight-validations

デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。

--dry-run

install コマンドを実行せずに出力します。

-y、--yes

yes/noプロンプトを省略します(yesと仮定)。

第85章 使用方法

本章では、usage コマンドに含まれるコマンドについて説明します。

85.1. usage list

プロジェクトごとのリソース使用状況を一覧表示します。

使用方法

openstack usage list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--start <start>] [--end <end>]

表85.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--start <start>

使用範囲の開始日(例:2012-01-20)(デフォルト:4 週間前)

--end <end>

使用範囲の終了日(例:2012-01-20)(デフォルト:明日)

表85.2 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表85.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表85.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表85.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

85.2. usage show

単一プロジェクトのリソース使用状況を表示します。

使用方法

openstack usage show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--project <project>]
                            [--start <start>] [--end <end>]

表85.6 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

使用状況を表示するプロジェクトの名前または ID

--start <start>

使用範囲の開始日(例:2012-01-20)(デフォルト:4 週間前)

--end <end>

使用範囲の終了日(例:2012-01-20)(デフォルト:明日)

表85.7 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表85.8 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表85.9 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表85.10 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第86章 user

本章では、user コマンドに含まれるコマンドについて説明します。

86.1. user create

新規ユーザーを作成します。

使用方法

openstack user create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--domain <domain>]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--password <password>] [--password-prompt]
                             [--email <email-address>]
                             [--description <description>]
                             [--enable | --disable] [--or-show]
                             <name>

表86.1 位置引数

概要

<name>

新しいユーザー名

表86.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

デフォルトのドメイン(名前または ID)

--project <project>

デフォルトプロジェクト(名前または ID)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--password <password>

ユーザーのパスワードを設定します。

--password-prompt

パスワードを対話的に要求します。

--email <email-address>

ユーザーのメールアドレスを設定します。

--description <description>

ユーザーの説明

--enable

ユーザーを有効にします(デフォルト)。

--disable

ユーザーを無効にします。

--or-show

既存ユーザーを返します。

表86.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表86.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表86.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表86.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

86.2. user delete

ユーザーを削除します。

使用方法

openstack user delete [-h] [--domain <domain>] <user> [<user> ...]

表86.7 位置引数

概要

<user>

削除するユーザー(名前または ID)

表86.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

<user> を所有するドメイン(名前または ID)

86.3. user list

ユーザーを一覧表示します。

使用方法

openstack user list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           [--domain <domain>]
                           [--group <group> | --project <project>] [--long]

表86.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

<domain>でユーザーをフィルターします(名前または id)。

--group=GROUP

<group> メンバーシップでユーザーをフィルターします(名前または ID)。

--project <project>

<project>でユーザーをフィルターします(名前または id)。

--long

出力の追加フィールドを一覧表示します。

表86.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表86.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表86.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表86.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

86.4. user password set

現在のユーザーのパスワードを変更します。

使用方法

openstack user password set [-h] [--password <new-password>]
                                   [--original-password <original-password>]

表86.14 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--password <new-password>

新しいユーザーパスワード

--original-password <original-password>

元のユーザーパスワード

86.5. user set

ユーザーの属性を設定します。

使用方法

openstack user set [-h] [--name <name>] [--domain <domain>]
                          [--project <project>]
                          [--project-domain <project-domain>]
                          [--password <password>] [--password-prompt]
                          [--email <email-address>]
                          [--description <description>] [--enable | --disable]
                          <user>

表86.15 位置引数

概要

<user>

変更するユーザー(名前または ID)

表86.16 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ユーザー名を設定します。

--domain <domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

--project <project>

デフォルトプロジェクトを設定します(名前または ID)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--password <password>

ユーザーのパスワードを設定します。

--password-prompt

パスワードを対話的に要求します。

--email <email-address>

ユーザーのメールアドレスを設定します。

--description <description>

ユーザーの説明を設定します。

--enable

ユーザーを有効にします(デフォルト)。

--disable

ユーザーを無効にします。

86.6. user show

ユーザーの詳細を表示します。

使用方法

openstack user show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--domain <domain>]
                           <user>

表86.17 位置引数

概要

<user>

表示するユーザー(名前または ID)

表86.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--domain <domain>

<user> を所有するドメイン(名前または ID)

表86.19 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表86.20 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表86.21 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表86.22 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第87章 versions

本章では、versions コマンドに含まれるコマンドについて説明します。

87.1. versions show

利用可能なサービスのバージョンを表示します。

使用方法

openstack versions show [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN]
                               [--all-interfaces | --interface <interface>]
                               [--region-name <region_name>]
                               [--service <region_name>]
                               [--status <region_name>]

表87.1 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-interfaces

すべてのインターフェースの値を表示します。

--interface <interface>

特定のインターフェースのバージョンを表示します。

--region-name <region_name>

特定のリージョンのバージョンを表示します。

--service <region_name>

特定のサービスのバージョンを表示します。

--status <region_name>

特定のステータスのバージョンを表示します[有効な値はSUPPORTED、CURRENT、DEPRECATED、EXPERIMENTALです]。

表87.2 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表87.3 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表87.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表87.5 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第88章 volume

本章では、volume コマンドに含まれるコマンドについて説明します。

88.1. volume backup create

新しいボリュームのバックアップを作成します。

使用方法

openstack volume backup create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--name <name>]
                                      [--description <description>]
                                      [--container <container>]
                                      [--snapshot <snapshot>] [--force]
                                      [--incremental]
                                      <volume>

表88.1 位置引数

概要

<volume>

バックアップするボリューム(名前または ID)

表88.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

バックアップの名前

--description <description>

バックアップの説明

--container <container>

オプションのバックアップコンテナー名

--snapshot <snapshot>

バックアップするスナップショット(名前または ID)

--force

使用中のボリュームのバックアップを許可します。

--incremental

増分バックアップを実行します。

表88.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表88.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表88.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.2. volume backup delete

ボリュームバックアップを削除します。

使用方法

openstack volume backup delete [-h] [--force] <backup> [<backup> ...]

表88.7 位置引数

概要

<backup>

削除するバックアップ(名前または ID)

表88.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--force

Error または available 以外の状態で削除を可能にします。

88.3. volume backup list

ボリュームのバックアップを一覧表示します。

使用方法

openstack volume backup list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN] [--long]
                                    [--name <name>] [--status <status>]
                                    [--volume <volume>]
                                    [--marker <volume-backup>]
                                    [--limit <num-backups>] [--all-projects]

表88.9 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--name <name>

バックアップ名で結果をフィルタリングします。

--status <status>

バックアップのステータス(creatingavailabledeletingerrorrestoring、または error_restoring)で結果をフィルタリングします。

--volume <volume>

バックアップするボリュームで結果をフィルタリングします(名前または ID)。

--marker <volume-backup>

前のページにある最後のバックアップ(名前または ID)

--limit <num-backups>

表示するバックアップの最大数。

--all-projects

すべてのプロジェクトを含めます(管理者のみ)。

表88.10 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表88.11 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表88.12 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.13 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.4. volume backup restore

ボリュームのバックアップを復元します。

使用方法

openstack volume backup restore [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <backup> <volume>

表88.14 位置引数

概要

<backup>

復元するバックアップ(名前または ID)

<volume>

復元先のボリューム(名前または ID)

表88.15 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表88.16 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表88.17 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.18 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表88.19 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.5. volume backup set

ボリュームのバックアップの属性を設定します。

使用方法

openstack volume backup set [-h] [--name <name>]
                                   [--description <description>]
                                   [--state <state>]
                                   <backup>

表88.20 位置引数

概要

<backup>

変更するバックアップ(名前または ID)

表88.21 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新しいバックアップ名

--description <description>

新しいバックアップの説明

--state <state>

新しいバックアップの状態("available" または "error")(管理者のみ)(このオプションは、実際のステータスに関係なくデータベースのバックアップの状態を変更するだけで、使用時には注意が必要です)

88.6. volume backup show

ボリュームのバックアップの詳細を表示します。

使用方法

openstack volume backup show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <backup>

表88.22 位置引数

概要

<backup>

表示するバックアップ(名前または ID)

表88.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表88.24 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表88.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.26 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表88.27 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.7. volume create

新規ボリュームを作成します。

使用方法

openstack volume create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--size <size>]
                               [--type <volume-type>]
                               [--image <image> | --snapshot <snapshot> | --source <volume>]
                               [--description <description>]
                               [--availability-zone <availability-zone>]
                               [--consistency-group consistency-group>]
                               [--property <key=value>] [--hint <key=value>]
                               [--bootable | --non-bootable]
                               [--read-only | --read-write]
                               <name>

表88.28 位置引数

概要

<name>

ボリューム名

表88.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--size <size>

gb 単位のボリュームサイズ(--snapshot または --source が指定されていない場合に必要)

--type <volume-type>

ボリュームの種別を設定します。

--image <image>

<image> をボリュームのソースとして使用します(名前または ID)。

--snapshot <snapshot>

<snapshot> をボリュームのソースとして使用します(名前または ID)。

--source <volume>

クローンを作成するボリューム(名前または ID)

--description <description>

ボリュームの説明

--availability-zone <availability-zone>

<availability-zone> にボリュームを作成します。

--consistency-group consistency-group>

新しいボリュームが属する整合性グループ

--property <key=value>

このボリュームに属性を設定します(複数の属性を設定する場合はオプションを繰り返し使用します)

--hint <key=value>

インスタンスのブートに役立つ任意のスケジューラーヒントのキーと値のペア(複数のヒントを設定する場合はオプションを繰り返し使用します)

--bootable

ボリュームをブート可能としてマークします。

--non-bootable

ボリュームをブート不可としてマークします(デフォルト)。

--read-only

volume を読み取り専用モードに設定します。

--read-write

volume を読み取り/書き込みアクセスモードに設定します(デフォルト)。

表88.30 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表88.31 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.32 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表88.33 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.8. volume delete

ボリュームを削除します。

使用方法

openstack volume delete [-h] [--force | --purge]
                               <volume> [<volume> ...]

表88.34 位置引数

概要

<volume>

削除するボリューム(名前または ID)

表88.35 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--force

状態に関係なく、ボリュームを強制的に削除しようとします(デフォルトは False)。

--purge

ボリュームと共にすべてのスナップショットを削除します(デフォルトは false)。

88.9. volume host set

ボリュームのホストの属性を設定します。

使用方法

openstack volume host set [-h] [--disable | --enable] <host-name>

表88.36 位置引数

概要

<host-name>

ボリュームホスト名

表88.37 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--disable

指定したボリュームホストをフリーズおよび無効化します。

--enable

指定されたボリュームホストをフリーズ解除および有効化します。

88.10. volume list

ボリュームを一覧表示します。

使用方法

openstack volume list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--project <project>]
                             [--project-domain <project-domain>]
                             [--user <user>] [--user-domain <user-domain>]
                             [--name <name>] [--status <status>]
                             [--all-projects] [--long] [--marker <volume>]
                             [--limit <num-volumes>]

表88.38 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--project <project>

プロジェクト(名前または ID)で結果をフィルターします(管理者のみ)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--user <user>

ユーザー(名前または ID)で結果をフィルターします(管理者のみ)。

--user-domain <user-domain>

ユーザーが所属するドメイン(名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。

--name <name>

ボリューム名で結果をフィルタリングします。

--status <status>

ステータスで結果をフィルタリングします。

--all-projects

すべてのプロジェクトを含めます(管理者のみ)。

--long

出力の追加フィールドを一覧表示します。

--marker <volume>

前のページにある最後のボリューム ID

--limit <num-volumes>

表示するボリュームの最大数。

表88.39 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表88.40 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表88.41 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.42 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.11. volume migrate

新規ホストにボリュームを移行します。

使用方法

openstack volume migrate [-h] --host <host> [--force-host-copy]
                                [--lock-volume]
                                <volume>

表88.43 位置引数

概要

<volume>

移行するボリューム(名前または ID)

表88.44 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--host <host>

移行先ホスト(形式:host@backend-name#pool)

--force-host-copy

汎用のホストベースの強制移行を有効にし、ドライバーの最適化をバイパスします。

--lock-volume

指定されている場合には、ボリュームの状態がロックされ、(別の操作で)移行が中断されなくなります。

88.12. volume qos associate

QoS 仕様をボリューム種別に関連付けます。

使用方法

openstack volume qos associate [-h] <qos-spec> <volume-type>

表88.45 位置引数

概要

<qos-spec>

変更する QoS 仕様(名前または ID)

<volume-type>

qosを関連付けるボリューム種別(名前または id)

表88.46 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

88.13. volume qos create

新規 QoS 仕様を作成します。

使用方法

openstack volume qos create [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty] [--consumer <consumer>]
                                   [--property <key=value>]
                                   <name>

表88.47 位置引数

概要

<name>

新しい qos 仕様の名前

表88.48 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--consumer <consumer>

qosのコンシューマー。有効なコンシューマー:back-end、both、front-end (デフォルトは both)

--property <key=value>

qos 仕様の属性を設定します(複数の属性を設定する場合はオプションを繰り返し使用します)

表88.49 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表88.50 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.51 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表88.52 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.14. volume qos delete

QoS 仕様を削除します。

使用方法

openstack volume qos delete [-h] [--force] <qos-spec> [<qos-spec> ...]

表88.53 位置引数

概要

<qos-spec>

削除する QoS 仕様(名前または ID)

表88.54 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--force

使用中の qos 仕様の削除を許可します。

88.15. volume qos disassociate

ボリューム種別から QoS 仕様の関連付けを解除します。

使用方法

openstack volume qos disassociate [-h]
                                         [--volume-type <volume-type> | --all]
                                         <qos-spec>

表88.55 位置引数

概要

<qos-spec>

変更する QoS 仕様(名前または ID)

表88.56 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--volume-type <volume-type>

qos の関連付けを解除するボリューム種別(名前または ID)

--all

すべてのボリューム種別から qos の関連付けを解除します。

88.16. volume qos list

QoS 仕様の一覧を表示します。

使用方法

openstack volume qos list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN]

表88.57 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表88.58 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表88.59 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表88.60 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.61 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.17. volume qos set

QoS 仕様の属性を設定します。

使用方法

openstack volume qos set [-h] [--property <key=value>] <qos-spec>

表88.62 位置引数

概要

<qos-spec>

変更する QoS 仕様(名前または ID)

表88.63 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key=value>

この qos 仕様に追加または変更する属性(複数の属性を設定する場合はオプションを繰り返し使用します)

88.18. volume qos show

QoS 仕様の詳細を表示します。

使用方法

openstack volume qos show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <qos-spec>

表88.64 位置引数

概要

<qos-spec>

表示する QoS 仕様(名前または ID)

表88.65 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表88.66 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表88.67 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.68 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表88.69 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.19. volume qos unset

QoS 仕様の属性の設定を解除します。

使用方法

openstack volume qos unset [-h] [--property <key>] <qos-spec>

表88.70 位置引数

概要

<qos-spec>

変更する QoS 仕様(名前または ID)

表88.71 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key>

qos使用から削除する属性(複数属性の設定を解除する場合はオプションを繰り返し使用します)

88.20. volume service list

サービスを一覧表示するコマンド

使用方法

openstack volume service list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--host <host>] [--service <service>]
                                     [--long]

表88.72 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--host <host>

指定したホストでサービスを一覧表示します(名前のみ)。

--service <service>

指定されたサービスのみを一覧表示します(名前のみ)。

--long

出力の追加フィールドを一覧表示します。

表88.73 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表88.74 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表88.75 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.76 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.21. volume service set

ボリュームサービスの属性を設定します。

使用方法

openstack volume service set [-h] [--enable | --disable]
                                    [--disable-reason <reason>]
                                    <host> <service>

表88.77 位置引数

概要

<host>

ホスト名

<service>

サービスの名前(バイナリー名)

表88.78 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--enable

ボリュームサービスを有効にします。

--disable

ボリュームサービスを無効にします。

--disable-reason <reason>

サービスを無効にする理由。--disable オプションと併用する必要があります。

88.22. volume set

ボリュームの属性を設定します。

使用方法

openstack volume set [-h] [--name <name>] [--size <size>]
                            [--description <description>] [--no-property]
                            [--property <key=value>]
                            [--image-property <key=value>] [--state <state>]
                            [--attached | --detached] [--type <volume-type>]
                            [--retype-policy <retype-policy>]
                            [--bootable | --non-bootable]
                            [--read-only | --read-write]
                            <volume>

表88.79 位置引数

概要

<volume>

変更するボリューム(名前または ID)

表88.80 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新規ボリューム名

--size <size>

ボリュームサイズを拡張します(gb単位)

--description <description>

新規ボリュームの説明

--no-property

<volume>からすべての属性を削除します(新しい属性を設定する前に現在の属性を削除するには --no-property と --property の両方を指定します)。

--property <key=value>

このボリュームに属性を設定します(複数の属性を設定する場合はオプションを繰り返し使用します)

--image-property <key=value>

このボリュームにイメージ属性を設定します(複数のイメージ属性を設定する場合はオプションを繰り返し使用します)

--state <state>

新しいボリュームの状態("available"、"error"、"creating"、"deleting"、"in-use"、"attaching"、"detaching"、"error_deleting"、または "maintenance") (管理者のみ) (このオプションは、実際のステータスに関係なくデータベースのボリュームの状態を変更するだけで、使用時には注意が必要です)

--attached

ボリューム割り当てのステータスを「attached」に設定します(管理者のみ)。(このオプションは、実際のステータスに関係なくデータベースのボリュームの状態を変更するだけで、使用時には注意が必要です)

--detached

ボリューム割り当てのステータスを「detached」に設定します(管理者のみ)。(このオプションは、実際のステータスに関係なくデータベースのボリュームの状態を変更するだけで、使用時には注意が必要です)

--type <volume-type>

新規ボリューム種別(名前または ID)

--retype-policy <retype-policy>

ボリューム種別の変更中の移行ポリシー(「never」または「on-demand」、デフォルトは「never」)(--type オプションが指定されている場合にのみ利用可能)

--bootable

ボリュームをブート可能としてマークします。

--non-bootable

ボリュームをブート不可としてマークします。

--read-only

volume を読み取り専用モードに設定します。

--read-write

volume を読み取り/書き込みアクセスモードに設定します。

88.23. volume show

ボリュームの詳細を表示します。

使用方法

openstack volume show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <volume>

表88.81 位置引数

概要

<volume>

表示するボリューム(名前または ID)

表88.82 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表88.83 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表88.84 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.85 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表88.86 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.24. volume snapshot create

新規ボリュームスナップショットを作成します。

使用方法

openstack volume snapshot create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--volume <volume>]
                                        [--description <description>]
                                        [--force] [--property <key=value>]
                                        [--remote-source <key=value>]
                                        <snapshot-name>

表88.87 位置引数

概要

<snapshot-name>

新規スナップショットの名前

表88.88 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--volume <volume>

スナップショットを作成するボリューム(名前または id)(デフォルトは <snapshot- name>)

--description <description>

スナップショットの説明

--force

インスタンスに割り当てられているスナップショットを作成します。デフォルトは False です。

--property <key=value>

属性をこのスナップショットに設定します(複数の属性を設定する場合はオプションを繰り返し使用します)。

--remote-source <key=value>

既存のリモートボリュームスナップショットの属性(管理者が必要)(複数属性を指定する場合はオプションを繰り返し使用します)(例: --remote-source source- name=test_name --remote-source source-id=test_id

表88.89 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表88.90 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.91 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表88.92 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.25. volume snapshot delete

ボリュームスナップショットを削除します。

使用方法

openstack volume snapshot delete [-h] [--force]
                                        <snapshot> [<snapshot> ...]

表88.93 位置引数

概要

<snapshot>

削除するスナップショット(名前または ID)

表88.94 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--force

状態に関係なく、スナップショットの強制的な削除を試行します(デフォルトは False)。

88.26. volume snapshot list

ボリュームスナップショットの一覧を表示します。

使用方法

openstack volume snapshot list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--all-projects] [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--long] [--marker <volume-snapshot>]
                                      [--limit <num-snapshots>]
                                      [--name <name>] [--status <status>]
                                      [--volume <volume>]

表88.95 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトを含めます(管理者のみ)。

--project <project>

プロジェクト(名前または ID)で結果をフィルターします(管理者のみ)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--long

出力の追加フィールドを一覧表示します。

--marker <volume-snapshot>

前のページにある最後のスナップショット ID

--limit <num-snapshots>

表示するスナップショットの最大数。

--name <name>

名前で結果をフィルタリングします。

--status <status>

ステータス(availableerrorcreatingdeleting、または error-deleting)で結果をフィルタリングします。

--volume <volume>

ボリュームで結果をフィルタリングします(名前または ID)。

表88.96 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表88.97 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表88.98 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.99 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.27. volume snapshot set

ボリュームスナップショットの属性を設定します。

使用方法

openstack volume snapshot set [-h] [--name <name>]
                                     [--description <description>]
                                     [--no-property] [--property <key=value>]
                                     [--state <state>]
                                     <snapshot>

表88.100 位置引数

概要

<snapshot>

変更するスナップショット(名前または ID)

表88.101 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新しいスナップショット名

--description <description>

新しいスナップショットの説明

--no-property

<snapshot>からすべての属性を削除します(新しい属性を設定する前に現在の属性を削除するには --no-property と --property の両方を指定します)。

--property <key=value>

このスナップショットに追加/変更する属性(複数の属性を設定する場合はオプションを繰り返し使用します)

--state <state>

新しいボリュームの状態("available"、"error"、"creating"、"deleting"、または "error_deleting") (管理者のみ) (このオプションは、実際のステータスに関係なくデータベースのスナップショットの状態を変更するだけで、使用時には注意が必要です)

88.28. volume snapshot show

ボリュームスナップショットの詳細を表示します。

使用方法

openstack volume snapshot show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <snapshot>

表88.102 位置引数

概要

<snapshot>

表示するスナップショット(名前または ID)

表88.103 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表88.104 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表88.105 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.106 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表88.107 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.29. volume snapshot unset

ボリュームスナップショット属性の設定を解除します。

使用方法

openstack volume snapshot unset [-h] [--property <key>] <snapshot>

表88.108 位置引数

概要

<snapshot>

変更するスナップショット(名前または ID)

表88.109 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key>

スナップショットから削除する属性(複数の属性を削除する場合はオプションを繰り返し使用します)

88.30. volume transfer request accept

ボリュームの譲渡要求を受け入れます。

使用方法

openstack volume transfer request accept [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                --auth-key <key>
                                                <transfer-request-id>

表88.110 位置引数

概要

<transfer-request-id>

受け入れるボリュームの譲渡要求(id のみ)

表88.111 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--auth-key <key>

ボリュームの転送要求の認証キー

表88.112 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表88.113 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.114 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表88.115 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.31. volume transfer request create

ボリュームの譲渡要求を作成します。

使用方法

openstack volume transfer request create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--name <name>]
                                                <volume>

表88.116 位置引数

概要

<volume>

譲渡するボリューム(名前または ID)

表88.117 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

新規譲渡要求の名前(デフォルトは none)

表88.118 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表88.119 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.120 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表88.121 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.32. volume transfer request delete

ボリュームの譲渡要求を削除します。

使用方法

openstack volume transfer request delete [-h]
                                                <transfer-request>
                                                [<transfer-request> ...]

表88.122 位置引数

概要

<transfer-request>

削除するボリュームの譲渡要求(名前または ID)

表88.123 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

88.33. volume transfer request list

すべてのボリュームの譲渡要求を一覧表示します。

使用方法

openstack volume transfer request list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              [--all-projects]

表88.124 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトを含めます(管理者のみ)。

表88.125 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表88.126 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表88.127 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.128 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.34. volume transfer request show

ボリュームの譲渡要求の詳細を表示します。

使用方法

openstack volume transfer request show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              <transfer-request>

表88.129 位置引数

概要

<transfer-request>

表示するボリュームの譲渡要求(名前または ID)

表88.130 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表88.131 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表88.132 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.133 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表88.134 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.35. volume type create

新規ボリューム種別を作成します。

使用方法

openstack volume type create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    [--description <description>]
                                    [--public | --private]
                                    [--property <key=value>]
                                    [--project <project>]
                                    [--encryption-provider <provider>]
                                    [--encryption-cipher <cipher>]
                                    [--encryption-key-size <key-size>]
                                    [--encryption-control-location <control-location>]
                                    [--project-domain <project-domain>]
                                    <name>

表88.135 位置引数

概要

<name>

ボリューム種別名

表88.136 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description <description>

ボリューム種別の説明

--public

ボリューム種別にパブリックからアクセスできる。

--private

ボリューム種別にパブリックからアクセスできない。

--property <key=value>

このボリューム種別に属性を設定します(複数の属性を設定する場合はオプションを繰り返し使用します)

--project <project>

<project>(名前または ID)がプライベート種別にアクセスできるようにします(--private オプションと併せて使用する必要があります)。

--encryption-provider <provider>

このボリューム種別の暗号化プロバイダー形式(「luks」または「plain」など)を設定します(このオプションは、ボリュームの暗号化種別を設定する際に必要です)。「-- encryption-cipher」、「--encryption-key-size」、および「-- encryption-control-location」などの他の暗号化オプションの使用を検討してください。

--encryption-cipher <cipher>

このボリューム種別の暗号化アルゴリズムまたはモードを設定します(例:「aes-xts-plain64」)。(管理者のみ)

--encryption-key-size <key-size>

このボリューム種別の暗号化キーのサイズを設定します(例:「128」または「256」)。(管理者のみ)

--encryption-control-location <control-location>

暗号化が実施される想定サービス("front-end" または "back-end")を設定します(管理者のみ)。(ボリュームの暗号化種別を設定する際のこのオプションのデフォルト値は、"front-end"です。「--encryption- cipher」、「--encryption-key-size」、および「--encryption- provider」などの他の暗号化オプションの使用を検討してください。)

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

表88.137 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表88.138 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.139 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表88.140 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.36. volume type delete

ボリューム種別を削除します。

使用方法

openstack volume type delete [-h] <volume-type> [<volume-type> ...]

表88.141 位置引数

概要

<volume-type>

削除するボリューム種別(名前または ID)

表88.142 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

88.37. volume type list

ボリューム種別を一覧表示します。

使用方法

openstack volume type list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN] [--long]
                                  [--default | --public | --private]
                                  [--encryption-type]

表88.143 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--long

出力の追加フィールドを一覧表示します。

--default

デフォルトのボリューム種別を一覧表示します。

--public

パブリック種別のみを一覧表示します。

--private

プライベート種別のみを一覧表示します(管理者のみ)。

--encryption-type

各ボリューム種別の暗号化情報を表示します(管理者のみ)。

表88.144 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表88.145 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表88.146 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.147 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.38. volume type set

ボリューム種別の属性を設定します。

使用方法

openstack volume type set [-h] [--name <name>]
                                 [--description <description>]
                                 [--property <key=value>]
                                 [--project <project>]
                                 [--project-domain <project-domain>]
                                 [--encryption-provider <provider>]
                                 [--encryption-cipher <cipher>]
                                 [--encryption-key-size <key-size>]
                                 [--encryption-control-location <control-location>]
                                 <volume-type>

表88.148 位置引数

概要

<volume-type>

変更するボリューム種別(名前または ID)

表88.149 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name <name>

ボリューム種別名を設定します。

--description <description>

ボリューム種別の説明を設定します。

--property <key=value>

このボリューム種別に属性を設定します(複数の属性を設定する場合はオプションを繰り返し使用します)

--project <project>

プロジェクト(名前または ID)へのボリューム種別アクセスを設定します(管理者のみ)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--encryption-provider <provider>

このボリューム種別の暗号化プロバイダー形式(「luks」または「plain」など)を設定します(このオプションは、ボリュームの暗号化種別を初めて設定する際に必要です)。「--encryption-cipher」、「--encryption- key-size」、および「--encryption-control-location」などの他の暗号化オプションの使用を検討してください。

--encryption-cipher <cipher>

このボリューム種別の暗号化アルゴリズムまたはモードを設定します(例:「aes-xts-plain64」)。(管理者のみ)

--encryption-key-size <key-size>

このボリューム種別の暗号化キーのサイズを設定します(例:「128」または「256」)。(管理者のみ)

--encryption-control-location <control-location>

暗号化が実施される想定サービス("front-end" または "back-end")を設定します(管理者のみ)。(ボリュームの暗号化種別を初めて設定する際のこのオプションのデフォルト値は、"front-end"です。「--encryption-cipher」、「--encryption-key-size」、および「-- encryption-provider」などの他の暗号化オプションの使用を検討してください。)

88.39. volume type show

ボリューム種別の詳細を表示します。

使用方法

openstack volume type show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--encryption-type]
                                  <volume-type>

表88.150 位置引数

概要

<volume-type>

表示するボリューム種別(名前または ID)

表88.151 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--encryption-type

このボリューム種別の暗号化情報を表示します(管理者のみ)。

表88.152 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表88.153 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表88.154 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表88.155 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

88.40. volume type unset

ボリューム種別の属性の設定を解除します。

使用方法

openstack volume type unset [-h] [--property <key>]
                                   [--project <project>]
                                   [--project-domain <project-domain>]
                                   [--encryption-type]
                                   <volume-type>

表88.156 位置引数

概要

<volume-type>

変更するボリューム種別(名前または ID)

表88.157 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key>

このボリューム種別から属性を削除します(複数の属性を削除する場合はオプションを繰り返し使用します)

--project <project>

プロジェクト(名前または ID)へのボリューム種別アクセスを削除します(管理者のみ)。

--project-domain <project-domain>

プロジェクトが所属するドメイン(名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。

--encryption-type

このボリューム種別の暗号化種別を削除します(管理者のみ)。

88.41. volume unset

ボリューム属性の設定を解除します。

使用方法

openstack volume unset [-h] [--property <key>] [--image-property <key>]
                              <volume>

表88.158 位置引数

概要

<volume>

変更するボリューム(名前または ID)

表88.159 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--property <key>

ボリュームから属性を削除します(複数の属性を削除する場合はオプションを繰り返し使用します)

--image-property <key>

ボリュームからイメージ属性を削除します(複数のイメージ属性を削除する場合はオプションを繰り返し使用します)

第89章 workbook

本章では、workbook コマンドに含まれるコマンドについて説明します。

89.1. workbook create

新規のワークブックを作成します。

使用方法

openstack workbook create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--public]
                                 [--namespace [NAMESPACE]]
                                 definition

表89.1 位置引数

概要

定義

ワークブックの定義ファイル

表89.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--public

このフラグを使用した場合には、ワークブックには「パブリック」のマークが付けられます。

--namespace [NAMESPACE]

ワークブックを作成する名前空間

表89.3 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表89.4 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表89.5 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表89.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

89.2. workbook definition show

ワークブックの定義を表示します。

使用方法

openstack workbook definition show [-h] name

表89.7 位置引数

概要

name

ワークブック名

表89.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

89.3. workbook delete

ワークブックを削除します。

使用方法

openstack workbook delete [-h] [--namespace [NAMESPACE]]
                                 workbook [workbook ...]

表89.9 位置引数

概要

workbook

ワークブックの名前。

表89.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--namespace [NAMESPACE]

ワークブックを削除する名前空間

89.4. workbook list

すべてのワークブックを一覧表示します。

使用方法

openstack workbook list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN] [--marker [MARKER]]
                               [--limit [LIMIT]] [--sort_keys [SORT_KEYS]]
                               [--sort_dirs [SORT_DIRS]] [--filter FILTERS]

表89.11 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

表89.12 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表89.13 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表89.14 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表89.15 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

89.5. workbook show

特定のワークブックを表示します。

使用方法

openstack workbook show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--namespace [NAMESPACE]]
                               workbook

表89.16 位置引数

概要

workbook

ワークブック名

表89.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--namespace [NAMESPACE]

ワークブックを取得する名前空間

表89.18 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表89.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表89.20 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表89.21 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

89.6. workbook update

ワークブックを更新します。

使用方法

openstack workbook update [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--namespace [NAMESPACE]]
                                 [--public]
                                 definition

表89.22 位置引数

概要

定義

ワークブックの定義ファイル

表89.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--namespace [NAMESPACE]

ワークブックを更新する名前空間

--public

このフラグを使用した場合には、ワークブックには「パブリック」のマークが付けられます。

表89.24 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表89.25 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表89.26 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表89.27 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

89.7. workbook validate

ワークブックを検証します。

使用方法

openstack workbook validate [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   definition

表89.28 位置引数

概要

定義

ワークブックの定義ファイル

表89.29 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表89.30 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表89.31 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表89.32 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表89.33 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第90章 workflow

本章では、workflow コマンドに含まれるコマンドについて説明します。

90.1. workflow create

新規ワークフローを作成します。

使用方法

openstack workflow create [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN]
                                 [--marker [MARKER]] [--limit [LIMIT]]
                                 [--sort_keys [SORT_KEYS]]
                                 [--sort_dirs [SORT_DIRS]] [--filter FILTERS]
                                 [--namespace [NAMESPACE]] [--public]
                                 definition

表90.1 位置引数

概要

定義

ワークフローの定義ファイル。

表90.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

--namespace [NAMESPACE]

ワークフローを作成する名前空間

--public

このフラグを使用した場合には、ワークフローには「パブリック」のマークが付けられます。

表90.3 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表90.4 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表90.5 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表90.6 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

90.2. workflow definition show

ワークフローの定義を表示します。

使用方法

openstack workflow definition show [-h] [--namespace [NAMESPACE]]
                                          identifier

表90.7 位置引数

概要

identifier

ワークフローの ID または名前。

表90.8 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--namespace [NAMESPACE]

ワークフローを取得する名前空間

90.3. workflow delete

ワークフローを削除します。

使用方法

openstack workflow delete [-h] [--namespace [NAMESPACE]]
                                 workflow [workflow ...]

表90.9 位置引数

概要

workflow

ワークフローの名前または ID。

表90.10 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--namespace [NAMESPACE]

ワークフローを削除する名前空間

90.4. workflow engine service list

全サービスを一覧表示します。

使用方法

openstack workflow engine service list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              [--marker [MARKER]]
                                              [--limit [LIMIT]]
                                              [--sort_keys [SORT_KEYS]]
                                              [--sort_dirs [SORT_DIRS]]
                                              [--filter FILTERS]

表90.11 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

表90.12 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表90.13 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表90.14 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表90.15 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

90.5. workflow env create

新規環境を作成します。

使用方法

openstack workflow env create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     file

表90.16 位置引数

概要

file

json または yaml の環境設定ファイル

表90.17 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表90.18 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表90.19 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表90.20 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表90.21 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

90.6. workflow env delete

環境を削除します。

使用方法

openstack workflow env delete [-h] environment [environment ...]

表90.22 位置引数

概要

environment

環境の名前

表90.23 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

90.7. workflow env list

すべての環境を一覧表示します。

使用方法

openstack workflow env list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--marker [MARKER]] [--limit [LIMIT]]
                                   [--sort_keys [SORT_KEYS]]
                                   [--sort_dirs [SORT_DIRS]]
                                   [--filter FILTERS]

表90.24 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

表90.25 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表90.26 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表90.27 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表90.28 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

90.8. workflow env show

特定の環境を表示します。

使用方法

openstack workflow env show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty] [--export]
                                   environment

表90.29 位置引数

概要

environment

環境名

表90.30 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--export

インポートに適した環境をエクスポートします。

表90.31 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表90.32 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表90.33 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表90.34 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

90.9. workflow env update

環境を更新します。

使用方法

openstack workflow env update [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     file

表90.35 位置引数

概要

file

json または yaml の環境設定ファイル

表90.36 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表90.37 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表90.38 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表90.39 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表90.40 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

90.10. workflow execution create

新規実行を作成します。

使用方法

openstack workflow execution create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--namespace [NAMESPACE]]
                                           [-d DESCRIPTION]
                                           [-s [SOURCE_EXECUTION_ID]]
                                           [workflow_identifier]
                                           [workflow_input] [params]

表90.41 位置引数

概要

workflow_identifier

ワークフローの ID または名前。ワークフロー名は、Mitaka 以降は非推奨になります。

workflow_input

ワークフロー入力

params

ワークフローの追加パラメーター

表90.42 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--namespace [NAMESPACE]

ワークフローの名前空間。

-d DESCRIPTION、--description DESCRIPTION

実行の説明

-s [SOURCE_EXECUTION_ID]

ワークフローの実行 ID。これにより、オペレーターは以前に正常に実行されたワークフローに基づいて新しいワークフロー実行を作成できます。例:mistral execution-create -s 123e4567-e89b-12d3-a456-426655440000

表90.43 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表90.44 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表90.45 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表90.46 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

90.11. workflow execution delete

実行を削除します。

使用方法

openstack workflow execution delete [-h] [--force]
                                           execution [execution ...]

表90.47 位置引数

概要

execution

実行識別子の ID。

表90.48 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--force

実行を強制的に削除します。実行中の実行に使用すると、エラーが連続して発生する可能性があります。

90.12. workflow execution input show

実行の入力データを表示します。

使用方法

openstack workflow execution input show [-h] id

表90.49 位置引数

概要

id

実行 ID

表90.50 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

90.13. workflow execution list

すべての実行を一覧表示します。

使用方法

openstack workflow execution list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]
                                         [--marker [MARKER]] [--limit [LIMIT]]
                                         [--sort_keys [SORT_KEYS]]
                                         [--sort_dirs [SORT_DIRS]]
                                         [--filter FILTERS] [--oldest]
                                         [--task [TASK]]

表90.51 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

--oldest

最新のエントリーからではなく、最も古いエントリーから開始する実行を表示します。

--task [TASK]

ワークフロー実行一覧に関連付けられた親タスク実行 ID。

表90.52 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表90.53 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表90.54 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表90.55 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

90.14. workflow execution output show

実行の出力データを表示します。

使用方法

openstack workflow execution output show [-h] id

表90.56 位置引数

概要

id

実行 ID

表90.57 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

90.15. workflow execution published show

ワークフローのグローバルに公開されている変数を表示します。

使用方法

openstack workflow execution published show [-h] id

表90.58 位置引数

概要

id

ワークフロー id

表90.59 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

90.16. workflow execution report show

実行のレポートを出力します。

使用方法

openstack workflow execution report show [-h] [--errors-only]
                                                [--no-errors-only]
                                                [--max-depth [MAX_DEPTH]]
                                                id

表90.60 位置引数

概要

id

実行 ID

表90.61 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--errors-only

エラーパスのみが含まれます。

--no-errors-only

エラーパス以外も含まれます。

--max-depth [MAX_DEPTH]

ワークフロー実行ツリーの最大深さ。0 の場合、ルートワークフローの実行とそのタスクのみが含まれます。

90.17. workflow execution show

特定の実行を表示します。

使用方法

openstack workflow execution show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         execution

表90.62 位置引数

概要

execution

実行の識別子

表90.63 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表90.64 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表90.65 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表90.66 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表90.67 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

90.18. workflow execution update

実行を更新します。

使用方法

openstack workflow execution update [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}]
                                           [-e ENV] [-d DESCRIPTION]
                                           id

表90.68 位置引数

概要

id

実行の識別子

表90.69 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}、--state {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}

実行の状態

-e ENV、--env ENV

環境変数

-d DESCRIPTION、--description DESCRIPTION

実行の説明

表90.70 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表90.71 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表90.72 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表90.73 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

90.19. workflow list

すべてのワークフローを一覧表示します。

使用方法

openstack workflow list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN] [--marker [MARKER]]
                               [--limit [LIMIT]] [--sort_keys [SORT_KEYS]]
                               [--sort_dirs [SORT_DIRS]] [--filter FILTERS]

表90.74 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

表90.75 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表90.76 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表90.77 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表90.78 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

90.20. workflow show

特定のワークフローを表示します。

使用方法

openstack workflow show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--namespace [NAMESPACE]]
                               workflow

表90.79 位置引数

概要

workflow

ワークフローの ID または名前。

表90.80 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--namespace [NAMESPACE]

ワークフローを取得する名前空間

表90.81 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表90.82 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表90.83 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表90.84 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

90.21. workflow update

ワークフローを更新します。

使用方法

openstack workflow update [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN]
                                 [--marker [MARKER]] [--limit [LIMIT]]
                                 [--sort_keys [SORT_KEYS]]
                                 [--sort_dirs [SORT_DIRS]] [--filter FILTERS]
                                 [--id ID] [--namespace [NAMESPACE]]
                                 [--public]
                                 definition

表90.85 位置引数

概要

定義

ワークフローの定義

表90.86 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--marker [MARKER]

前のページで最後に実行した UUID。「マーカー」の後の実行を一覧表示します。

--limit [LIMIT]

単一の結果で返すエントリーの最大数。

--sort_keys [SORT_KEYS]

結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

フィルター。繰り返し使用できます。

--id ID

ワークフローの ID

--namespace [NAMESPACE]

ワークフローの名前空間

--public

このフラグを使用した場合には、ワークフローには「パブリック」のマークが付けられます。

表90.87 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表90.88 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表90.89 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表90.90 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

90.22. workflow validate

ワークフローを検証します。

使用方法

openstack workflow validate [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   definition

表90.91 位置引数

概要

定義

ワークフローの定義ファイル

表90.92 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

表90.93 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表90.94 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表90.95 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表90.96 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

第91章 zone

本章では、zone コマンドに含まれるコマンドについて説明します。

91.1. zone abandon

ゾーンを破棄します。

使用方法

openstack zone abandon [-h] [--all-projects] [--edit-managed]
                              [--sudo-project-id SUDO_PROJECT_ID]
                              id

表91.1 位置引数

概要

id

ゾーンの id

表91.2 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

91.2. zone axfr

ゾーンの自動ゾーン転送を行います。

使用方法

openstack zone axfr [-h] [--all-projects] [--edit-managed]
                           [--sudo-project-id SUDO_PROJECT_ID]
                           id

表91.3 位置引数

概要

id

ゾーンの id

表91.4 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

91.3. zone blacklist create

新規ブラックリストを作成します。

使用方法

openstack zone blacklist create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] --pattern PATTERN
                                       [--description DESCRIPTION]
                                       [--all-projects] [--edit-managed]
                                       [--sudo-project-id SUDO_PROJECT_ID]

表91.5 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--pattern PATTERN

ブラックリストのパターン

--description DESCRIPTION

説明

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.6 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.7 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.8 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.9 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.4. zone blacklist delete

ブラックリストを削除します。

使用方法

openstack zone blacklist delete [-h] [--all-projects] [--edit-managed]
                                       [--sudo-project-id SUDO_PROJECT_ID]
                                       id

表91.10 位置引数

概要

id

ブラックリストの id

表91.11 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

91.5. zone blacklist list

ブラックリストを一覧表示します。

使用方法

openstack zone blacklist list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--all-projects] [--edit-managed]
                                     [--sudo-project-id SUDO_PROJECT_ID]

表91.12 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.13 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表91.14 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表91.15 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.16 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.6. zone blacklist set

ブラックリストの属性を設定します。

使用方法

openstack zone blacklist set [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--pattern PATTERN]
                                    [--description DESCRIPTION | --no-description]
                                    [--all-projects] [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    id

表91.17 位置引数

概要

id

ブラックリストの id

表91.18 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--pattern PATTERN

ブラックリストのパターン

--description DESCRIPTION

説明

--no-description—​all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.19 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.20 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.21 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.22 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.7. zone blacklist show

ブラックリストの詳細を表示します。

使用方法

openstack zone blacklist show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--all-projects] [--edit-managed]
                                     [--sudo-project-id SUDO_PROJECT_ID]
                                     id

表91.23 位置引数

概要

id

ブラックリストの id

表91.24 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.25 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.26 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.27 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.28 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.8. zone create

新しいゾーンを作成します。

使用方法

openstack zone create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--email EMAIL] [--type TYPE]
                             [--ttl TTL] [--description DESCRIPTION]
                             [--masters MASTERS [MASTERS ...]]
                             [--attributes ATTRIBUTES [ATTRIBUTES ...]]
                             [--all-projects] [--edit-managed]
                             [--sudo-project-id SUDO_PROJECT_ID]
                             name

表91.29 位置引数

概要

name

ゾーン名

表91.30 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--email EMAIL

ゾーンのメール

--type TYPE

ゾーンの種別

--ttl TTL

存続期間(秒)

--description DESCRIPTION

説明

--masters MASTERS [MASTERS …​]

ゾーンのマスター

--attributes ATTRIBUTES [ATTRIBUTES …​]

ゾーンの属性

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.31 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.32 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.33 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.34 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.9. zone delete

ゾーンを削除します。

使用方法

openstack zone delete [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--all-projects] [--edit-managed]
                             [--sudo-project-id SUDO_PROJECT_ID]
                             id

表91.35 位置引数

概要

id

ゾーンの id

表91.36 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.37 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.38 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.39 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.40 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.10. zone export create

ゾーンをエクスポートします。

使用方法

openstack zone export create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--all-projects]
                                    [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_id

表91.41 位置引数

概要

zone_id

ゾーンの id

表91.42 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.43 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.44 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.45 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.46 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.11. zone export delete

ゾーンのエクスポートを削除します。

使用方法

openstack zone export delete [-h] [--all-projects] [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_export_id

表91.47 位置引数

概要

zone_export_id

ゾーンエクスポート ID

表91.48 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

91.12. zone export list

ゾーンのエクスポートを一覧表示します。

使用方法

openstack zone export list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]

表91.49 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.50 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表91.51 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表91.52 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.53 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.13. zone export show

ゾーンのエクスポートを表示します。

使用方法

openstack zone export show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_export_id

表91.54 位置引数

概要

zone_export_id

ゾーンエクスポート ID

表91.55 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.56 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.57 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.58 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.59 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.14. zone export showfile

ゾーンエクスポートのゾーンファイルを表示します。

使用方法

openstack zone export showfile [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--all-projects]
                                      [--edit-managed]
                                      [--sudo-project-id SUDO_PROJECT_ID]
                                      zone_export_id

表91.60 位置引数

概要

zone_export_id

ゾーンエクスポート ID

表91.61 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.62 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.63 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.64 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.65 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.15. zone import create

ファイルシステムのファイルからゾーンをインポートします。

使用方法

openstack zone import create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--all-projects]
                                    [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_file_path

表91.66 位置引数

概要

zone_file_path

ゾーンファイルへのパス

表91.67 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.68 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.69 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.70 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.71 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.16. zone import delete

ゾーンのインポートを削除します。

使用方法

openstack zone import delete [-h] [--all-projects] [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_import_id

表91.72 位置引数

概要

zone_import_id

ゾーンインポート id

表91.73 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

91.17. zone import list

ゾーンのインポートを一覧表示します。

使用方法

openstack zone import list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]

表91.74 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.75 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表91.76 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表91.77 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.78 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.18. zone import show

ゾーンのインポートを表示します。

使用方法

openstack zone import show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_import_id

表91.79 位置引数

概要

zone_import_id

ゾーンインポート id

表91.80 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.81 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.82 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.83 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.84 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.19. zone list

ゾーンの一覧を表示します。

使用方法

openstack zone list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           [--name NAME] [--email EMAIL] [--type TYPE]
                           [--ttl TTL] [--description DESCRIPTION]
                           [--status STATUS] [--all-projects] [--edit-managed]
                           [--sudo-project-id SUDO_PROJECT_ID]

表91.85 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--name NAME

ゾーン名

--email EMAIL

ゾーンのメール

--type TYPE

ゾーンの種別

--ttl TTL

存続期間(秒)

--description DESCRIPTION

説明

--status STATUS

ゾーンのステータス

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.86 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表91.87 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表91.88 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.89 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.20. zone set

ゾーンの属性を設定します。

使用方法

openstack zone set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                          [--noindent] [--prefix PREFIX]
                          [--max-width <integer>] [--fit-width]
                          [--print-empty] [--email EMAIL] [--ttl TTL]
                          [--description DESCRIPTION | --no-description]
                          [--masters MASTERS [MASTERS ...]] [--all-projects]
                          [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
                          id

表91.90 位置引数

概要

id

ゾーンの id

表91.91 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--email EMAIL

ゾーンのメール

--ttl TTL

存続期間(秒)

--description DESCRIPTION

説明

--no-description—​masters MASTERS [MASTERS …​]

ゾーンのマスター

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.92 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.93 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.94 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.95 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.21. zone show

ゾーンの詳細を表示します。

使用方法

openstack zone show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--all-projects] [--edit-managed]
                           [--sudo-project-id SUDO_PROJECT_ID]
                           id

表91.96 位置引数

概要

id

ゾーンの id

表91.97 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.98 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.99 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.100 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.101 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.22. zone transfer accept list

ゾーン転送の受理を一覧表示します。

使用方法

openstack zone transfer accept list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           [--all-projects] [--edit-managed]
                                           [--sudo-project-id SUDO_PROJECT_ID]

表91.102 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.103 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表91.104 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表91.105 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.106 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.23. zone transfer accept request

ゾーン転送リクエストを許可します。

使用方法

openstack zone transfer accept request [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              --transfer-id TRANSFER_ID --key
                                              KEY [--all-projects]
                                              [--edit-managed]
                                              [--sudo-project-id SUDO_PROJECT_ID]

表91.107 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--transfer-id TRANSFER_ID

転送 id

--key KEY

転送キー

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.108 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.109 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.110 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.111 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.24. zone transfer accept show

ゾーン転送の受理を表示します。

使用方法

openstack zone transfer accept show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--all-projects] [--edit-managed]
                                           [--sudo-project-id SUDO_PROJECT_ID]
                                           id

表91.112 位置引数

概要

id

ゾーン転送受理 ID

表91.113 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.114 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.115 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.116 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.117 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.25. zone transfer request create

新しいゾーン転送リクエストを作成します。

使用方法

openstack zone transfer request create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--target-project-id TARGET_PROJECT_ID]
                                              [--description DESCRIPTION]
                                              [--all-projects]
                                              [--edit-managed]
                                              [--sudo-project-id SUDO_PROJECT_ID]
                                              zone_id

表91.118 位置引数

概要

zone_id

転送するゾーン ID。

表91.119 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--target-project-id TARGET_PROJECT_ID

転送先のターゲットプロジェクト ID。

--description DESCRIPTION

説明

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.120 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.121 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.122 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.123 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.26. zone transfer request delete

ゾーン転送リクエストを削除します。

使用方法

openstack zone transfer request delete [-h] [--all-projects]
                                              [--edit-managed]
                                              [--sudo-project-id SUDO_PROJECT_ID]
                                              id

表91.124 位置引数

概要

id

ゾーン転送リクエスト ID

表91.125 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

91.27. zone transfer request list

ゾーン転送リクエストの一覧を表示します。

使用方法

openstack zone transfer request list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]
                                            [--all-projects] [--edit-managed]
                                            [--sudo-project-id SUDO_PROJECT_ID]

表91.126 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.127 出力形式の設定

概要

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

--sort-column SORT_COLUMN

データを並べ替えるコラムを指定します(最初に指定した列には優先順位があり、存在しない列は無視されます)。

表91.128 CSV 書式設定

概要

--quote {all,minimal,none,nonnumeric}

引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。

表91.129 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.130 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.28. zone transfer request set

ゾーン転送リクエストを設定します。

使用方法

openstack zone transfer request set [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--description DESCRIPTION | --no-description]
                                           [--all-projects] [--edit-managed]
                                           [--sudo-project-id SUDO_PROJECT_ID]
                                           id

表91.131 位置引数

概要

id

ゾーン転送リクエスト ID

表91.132 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--description DESCRIPTION

説明

--no-description—​all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.133 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.134 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.135 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.136 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。

91.29. zone transfer request show

ゾーン転送リクエストの詳細を表示します。

使用方法

openstack zone transfer request show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--all-projects] [--edit-managed]
                                            [--sudo-project-id SUDO_PROJECT_ID]
                                            id

表91.137 位置引数

概要

id

ゾーン転送リクエスト ID

表91.138 その他の引数 (オプション):

概要

-h, --help

ヘルプメッセージを表示して終了します。

--all-projects

すべてのプロジェクトの結果を表示します。デフォルト:false

--edit-managed

管理対象のリソースを編集します。デフォルト:false

--sudo-project-id SUDO_PROJECT_ID

このコマンドの権限を借用するプロジェクト ID。デフォルト:None

表91.139 出力形式の設定

概要

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表91.140 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表91.141 Shell フォーマッター

概要

--prefix PREFIX

すべての変数名にプレフィックスを追加します。

表91.142 表の書式設定

概要

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

--print-empty

表示するデータがない場合は空のテーブルを出力します。