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

Red Hat OpenStack Platform 17.1

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

OpenStack Documentation Team

概要

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

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

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

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

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

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

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

  1. Multi-page HTML 形式でドキュメントを表示します。
  2. ドキュメントの右上隅に Feedback ボタンが表示されていることを確認してください。
  3. コメントするテキスト部分をハイライト表示します。
  4. Add Feedback をクリックします。
  5. Add Feedback フィールドにコメントを入力します。
  6. オプション: ドキュメントチームが問題の詳細を確認する際に使用できるメールアドレスを記入してください。
  7. Submit をクリックします。

第1章 OpenStack クライアント

openstack クライアントは、一般的な OpenStack コマンドラインインターフェイス (CLI) です。本章では、openstack バージョン 5.5.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-metrics-api-version <metrics-api-version>]
                 [--os-dns-api-version <dns-api-version>]
                 [--os-key-manager-api-version <key-manager-api-version>]
                 [--os-orchestration-api-version <orchestration-api-version>]
                 [--os-loadbalancer-api-version <loadbalancer-api-version>]
                 [--os-data-processing-api-version <data-processing-api-version>]
                 [--os-data-processing-url OS_DATA_PROCESSING_URL]
                 [--os-workflow-api-version <workflow-api-version>]
                 [--os-database-api-version <database-api-version>]
                 [--os-share-api-version <shared-file-system-api-version>]
                 [--os-tripleoclient-api-version <tripleoclient-api-version>]
                 [--os-queues-api-version <queues-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-alarming-api-version <alarming-api-version>]
                 [--os-auth-type <auth-type>] [--os-endpoint <auth-endpoint>]
                 [--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-user-id <auth-user-id>] [--os-username <auth-username>]
                 [--os-user-domain-id <auth-user-domain-id>]
                 [--os-user-domain-name <auth-user-domain-name>]
                 [--os-password <auth-password>] [--os-token <auth-token>]
                 [--os-user <auth-user>]
                 [--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-auth-methods <auth-auth-methods>]
                 [--os-roles <auth-roles>]
                 [--os-aodh-endpoint <auth-aodh-endpoint>]
                 [--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-passcode <auth-passcode>]
                 [--os-redirect-uri <auth-redirect-uri>]
                 [--os-code <auth-code>]
                 [--os-application-credential-secret <auth-application-credential-secret>]
                 [--os-application-credential-id <auth-application-credential-id>]
                 [--os-application-credential-name <auth-application-credential-name>]
                 [--os-consumer-key <auth-consumer-key>]
                 [--os-consumer-secret <auth-consumer-secret>]
                 [--os-access-key <auth-access-key>]
                 [--os-access-secret <auth-access-secret>]
                 [--os-access-token <auth-access-token>]

表1.1 コマンド引数

概要

--version

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

-v、--verbose

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

-q、--quiet

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

--log-file LOG_FILE

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

-h、--help

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

--debug

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

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

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

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

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

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

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

--os-cert <certificate-file>

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

--os-key <key-file>

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

--verify

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

--insecure

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

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

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

--os-interface <interface>

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

--os-service-provider <service_provider>

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

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

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

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

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

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

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

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

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

--timing

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

--os-beta-command

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

--os-profile hmac-key

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

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

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

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

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

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

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

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

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

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

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

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

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

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

メトリック api バージョン、デフォルト=1(env: OS_METRICS_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-orchestration-api-version <orchestration-api-version>

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

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

Osc プラグイン api バージョン、デフォルト=2.0(env: OS_LOADBALANCER_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-workflow-api-version <workflow-api-version>

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

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

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

--os-share-api-version <shared-file-system-api-version>

共有ファイルシステム API バージョン、デフォルト=2.63version はクライアントとサーバーの両方でサポートされます。(Env: OS_SHARE_API_VERSION)

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

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

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

キュー API バージョン、デフォルト=2(env: OS_QUEUES_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-alarming-api-version <alarming-api-version>

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

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

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

--os-endpoint <auth-endpoint>

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

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

With password: authentication url with v3password: Authentication URL With v3token: Authentication URL With v2password: Authentication URL With v3tokenlessauth: Authentication URL With v3oidcpassword: Authentication URL With v3multifactor: Authentication URL With v3adfspassword: Authentication URL With v3totp: Authentication URL With v3oidcauthcode: Authentication URL With v3applicationcredential: Authentication URL With v2token: Authentication URL With v3oauth1: Authentication URL With v3oidcclientcredentials: Authentication URL With token: Authentication URL With v3oidcaccesstoken: Authentication URL With v1password: Authentication URL With v3samlpassword: Authentication URL (Env: OS_AUTH_URL)

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

With password: scope for system operations with v3password: Scope for system operations With v3token: Scope for system operations With v3oidcpassword: Scope for system operations With v3multifactor: Scope for system operations With v3adfspassword: Scope for system operations With v3totp: Scope for system operations With v3oidcauthcode: Scope for system operations With v3applicationcredential: Scope for system operations With v3oidcclientcredentials: Scope for system operations With token: Scope for system operations With v3oidcaccesstoken: Scope for system operations With v3samlpassword: Scope for system operations (Env: OS_SYSTEM_SCOPE)

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

With password: domain id to scope to with v3password: Domain ID to scope to With v3token: Domain ID to scope to With v3tokenlessauth: Domain ID to scope to With v3oidcpassword: Domain ID to scope to With v3multifactor: Domain ID to scope to With v3adfspassword: Domain ID to scope to With v3totp: Domain ID to scope to With v3oidcauthcode: Domain ID to scope to With v3applicationcredential: Domain ID to scope to With v3oidcclientcredentials: Domain ID to scope to With token: Domain ID to scope to With v3oidcaccesstoken: Domain ID to scope to With v3samlpassword: Domain ID to scope to (Env: OS_DOMAIN_ID)

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

With password: domain name to scope to with v3password: Domain name to scope to With v3token: Domain name to scope to With v3tokenlessauth: Domain name to scope to With v3oidcpassword: Domain name to scope to With v3multifactor: Domain name to scope to With v3adfspassword: Domain name to scope to With v3totp: Domain name to scope to With v3oidcauthcode: Domain name to scope to With v3applicationcredential: Domain name to scope to With v3oidcclientcredentials: Domain name to scope to With token: Domain name to scope to With v3oidcaccesstoken: Domain name to scope to With v3samlpassword: Domain name to scope to (Env: OS_DOMAIN_NAME)

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

With password: project id to scope to with v3password: Project ID to scope to With v3token: Project ID to scope to With noauth: Project ID With v3tokenlessauth: Project ID to scope to With v3oidcpassword: Project ID to scope to With v3multifactor: Project ID to scope to With aodh-noauth: Project ID With v3adfspassword: Project ID to scope to With v3totp: Project ID to scope to With v3oidcauthcode: Project ID to scope to With v3applicationcredential: Project ID to scope to With v3oidcclientcredentials: Project ID to scope to With gnocchi-noauth: Project ID With token: Project ID to scope to With v3oidcaccesstoken: Project ID to scope to With v3samlpassword: Project ID to scope to (Env: OS_PROJECT_ID)

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

With password: project name to scope to with v3password: Project name to scope to With v3token: Project name to scope to With v3tokenlessauth: Project name to scope to With v3oidcpassword: Project name to scope to With v3multifactor: Project name to scope to With v3adfspassword: Project name to scope to With v3totp: Project name to scope to With v3oidcauthcode: Project name to scope to With v3applicationcredential: Project name to scope to With v3oidcclientcredentials: Project name to scope to With token: Project name to scope to With v3oidcaccesstoken: Project name to scope to With v1password: Swift account to use With v3samlpassword: Project name to scope to (Env: OS_PROJECT_NAME)

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

With password: domain id containing project with v3password: Domain ID containing project With v3token: Domain ID containing project With v3tokenlessauth: Domain ID containing project With v3oidcpassword: Domain ID containing project With v3multifactor: Domain ID containing project With v3adfspassword: Domain ID containing project With v3totp: Domain ID containing project With v3oidcauthcode: Domain ID containing project With v3applicationcredential: Domain ID containing project With v3oidcclientcredentials: Domain ID containing project With token: Domain ID containing project With v3oidcaccesstoken: Domain ID containing project With v3samlpassword: Domain ID containing project (Env: OS_PROJECT_DOMAIN_ID)

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

With password: domain name containing project with v3password: Domain name containing project With v3token: Domain name containing project With v3tokenlessauth: Domain name containing project With v3oidcpassword: Domain name containing project With v3multifactor: Domain name containing project With v3adfspassword: Domain name containing project With v3totp: Domain name containing project With v3oidcauthcode: Domain name containing project With v3applicationcredential: Domain name containing project With v3oidcclientcredentials: Domain name containing project With token: Domain name containing project With v3oidcaccesstoken: Domain name containing project With v3samlpassword: Domain name containing project (Env: OS_PROJECT_DOMAIN_NAME)

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

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

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

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

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

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

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

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

--os-username <auth-username>

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

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

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

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

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

--os-password <auth-password>

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

--os-token <auth-token>

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

--os-user <auth-user>

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

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

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

--os-protocol <auth-protocol>

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

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

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

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

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

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

v3oidcpassword: 認可サーバーから要求される openid connect 範囲。OpenID 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 プロバイダートークンエンドポイント。検出ドキュメントが渡された場合には、このオプションの指定内容が、検出ドキュメントでサーバーが提供するエンドポイントよりも優先される点に注意してください。v3oidcauthcode: OpenID Connect プロバイダートークンエンドポイント。検出ドキュメントが渡された場合には、このオプションの指定内容が、検出ドキュメントでサーバーが提供するエンドポイントよりも優先される点に注意してください。V3oidcclientcredentials: OpenID Connect プロバイダートークンエンドポイント。検出ドキュメントが渡された場合には、このオプションの指定内容が、検出ドキュメントでサーバーが提供するエンドポイントよりも優先される点に注意してください。(Env: OS_ACCESS_TOKEN_ENDPOINT)

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

v3oidcpassword: openid connect 検出ドキュメント 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 承認サーバー Introspection トークンタイプ。これはトークンイントロスペクションの処理時に使用するトークンのタイプを決定するために使用されます。有効な値は、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-auth-methods <auth-auth-methods>

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

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

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

--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-application-credential-secret <auth-application-credential-secret>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

第2章 access

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

2.1. access rule delete

アクセスルールを削除します。

使用方法

openstack access rule delete [-h] <access-rule> [<access-rule> ...]

表2.1 位置引数

概要

<access-rule>

削除するアクセスルール (名前または ID)

表2.2 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

2.2. access rule list

アクセスルールを一覧表示します

使用方法

openstack access 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]
                                  [--sort-ascending | --sort-descending]
                                  [--user <user>]
                                  [--user-domain <user-domain>]

表2.3 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--user <user>

一覧表示するアクセスルールを持つユーザー (名前または ID)

--user-domain <user-domain>

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

表2.4 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

--sort-column SORT_COLUMN

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表2.5 CSV フォーマット設定オプション

概要

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

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

表2.6 JSON フォーマット設定オプション

概要

--noindent

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

表2.7 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

2.3. access rule show

access rule の詳細を表示します。

使用方法

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

表2.8 位置引数

概要

<access-rule>

表示する access-rule (名前または ID)

表2.9 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

表2.10 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

表2.11 JSON フォーマット設定オプション

概要

--noindent

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

表2.12 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表2.13 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

2.4. 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.14 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--consumer-key <consumer-key>

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

--consumer-secret <consumer-secret>

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

--request-key <request-key>

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

--request-secret <request-secret>

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

--verifier <verifier>

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

表2.15 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

表2.16 JSON フォーマット設定オプション

概要

--noindent

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

表2.17 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表2.18 テーブルフォーマット設定オプション

概要

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

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]
                         [--sort-ascending | --sort-descending]
                         URI

表3.3 位置引数

概要

URI

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

表3.4 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

表3.5 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

--sort-column SORT_COLUMN

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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]
                            [--sort-ascending | --sort-descending]
                            [--user [USERS]]
                            [--project-access | --no-project-access]
                            [--operation-type {read}]
                            URI

表3.9 位置引数

概要

URI

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

表3.10 コマンド引数

概要

-h、--help

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

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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]
                              [--sort-ascending | --sort-descending]
                              [--user [USERS]]
                              [--project-access | --no-project-access]
                              [--operation-type {read}]
                              URI

表3.15 位置引数

概要

URI

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

表3.16 コマンド引数

概要

-h、--help

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

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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]
                                 [--sort-ascending | --sort-descending]
                                 [--user [USERS]]
                                 [--project-access | --no-project-access]
                                 [--operation-type {read}]
                                 URI

表3.21 位置引数

概要

URI

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

表3.22 コマンド引数

概要

-h、--help

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

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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]
                                          [--sort-ascending | --sort-descending]
                                          [--marker [MARKER]]
                                          [--limit [LIMIT]]
                                          [--sort_keys [SORT_KEYS]]
                                          [--sort_dirs [SORT_DIRS]]
                                          [--filter FILTERS] [--public]
                                          [--namespace [NAMESPACE]]
                                          definition

表4.1 位置引数

概要

定義

アクション定義ファイル

表4.2 コマンド引数

概要

-h、--help

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

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

--namespace [NAMESPACE]

アクションを作成する namespace。

表4.3 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

--sort-column SORT_COLUMN

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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]
                                                   [--namespace [NAMESPACE]]
                                                   name

表4.7 位置引数

概要

name

アクション名

表4.8 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--namespace [NAMESPACE]

アクションの namespace。

4.3. action definition delete

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

使用方法

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

表4.9 位置引数

概要

action

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

表4.10 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--namespace [NAMESPACE]

アクションの namespace。

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]
                                        [--sort-ascending | --sort-descending]
                                        [--marker [MARKER]] [--limit [LIMIT]]
                                        [--sort_keys [SORT_KEYS]]
                                        [--sort_dirs [SORT_DIRS]]
                                        [--filter FILTERS]
                                        [--namespace [NAMESPACE]]

表4.11 コマンド引数

概要

-h、--help

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]

アクションの namespace。

表4.12 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

--sort-column SORT_COLUMN

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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]
                                        [--namespace [NAMESPACE]]
                                        action

表4.16 位置引数

概要

action

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

表4.17 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--namespace [NAMESPACE]

アクションを作成する namespace。

表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 シェルフォーマット設定オプション

概要

--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]
                                          [--sort-ascending | --sort-descending]
                                          [--marker [MARKER]]
                                          [--limit [LIMIT]]
                                          [--sort_keys [SORT_KEYS]]
                                          [--sort_dirs [SORT_DIRS]]
                                          [--filter FILTERS] [--id ID]
                                          [--public] [--namespace [NAMESPACE]]
                                          definition

表4.22 位置引数

概要

定義

アクション定義ファイル

表4.23 コマンド引数

概要

-h、--help

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

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

--namespace [NAMESPACE]

アクションの namespace。

表4.24 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

--sort-column SORT_COLUMN

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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

help メッセージを表示して終了します

4.8. action execution input show

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

使用方法

openstack action execution input show [-h] id

表4.30 位置引数

概要

id

アクション実行 ID。

表4.31 コマンド引数

概要

-h、--help

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]
                                       [--sort-ascending | --sort-descending]
                                       [--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

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

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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

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] [--namespace [NAMESPACE]]
                                      name [input]

表4.40 位置引数

概要

name

実行するアクション名。

入力 (input)

アクション入力。

表4.41 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

-s, --save-result

結果を db に保存します。

--run-sync

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

-t TARGET, --target TARGET

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

--namespace [NAMESPACE]

アクションの namespace。

表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 シェルフォーマット設定オプション

概要

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

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 シェルフォーマット設定オプション

概要

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

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 シェルフォーマット設定オプション

概要

--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 group create

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

使用方法

openstack address group create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--description <description>]
                                      [--address <ip-address>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      <name>

表5.1 位置引数

概要

<name>

新しいアドレスグループ名

表5.2 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--description <description>

新しいアドレスグループの説明

--address <ip-address>

IP アドレスまたは cidr (複数のアドレスを設定する場合はオプションを繰り返し使用します)

--project <project>

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

--project-domain <project-domain>

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

表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 シェルフォーマット設定オプション

概要

--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 group delete

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

使用方法

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

表5.7 位置引数

概要

<address-group>

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

表5.8 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

5.3. address group list

address group を表示します。

使用方法

openstack address 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]
                                    [--sort-ascending | --sort-descending]
                                    [--name <name>] [--project <project>]
                                    [--project-domain <project-domain>]

表5.9 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--name <name>

出力で指定された名前の address groups のみを表示します

--project <project>

プロジェクトに従って address groups を表示します (名前または ID)

--project-domain <project-domain>

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

表5.10 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

--sort-column SORT_COLUMN

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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 group set

address group のプロパティーを設定します

使用方法

openstack address group set [-h] [--name <name>]
                                   [--description <description>]
                                   [--address <ip-address>]
                                   <address-group>

表5.14 位置引数

概要

<address-group>

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

表5.15 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--name <name>

アドレスグループ名を設定します

--description <description>

アドレスグループの説明を設定します

--address <ip-address>

IP アドレスまたは cidr (複数のアドレスを設定する場合はオプションを繰り返し使用します)

5.5. address group show

アドレスグループの詳細を表示します

使用方法

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

表5.16 位置引数

概要

<address-group>

表示する address group (名前または ID)

表5.17 コマンド引数

概要

-h、--help

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 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表5.21 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

5.6. address group unset

アドレスグループのプロパティーの設定を解除します

使用方法

openstack address group unset [-h] [--address <ip-address>]
                                     <address-group>

表5.22 位置引数

概要

<address-group>

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

表5.23 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--address <ip-address>

IP アドレスまたは cidr (複数のアドレスの設定を解除する場合はオプションを繰り返し使用します)

5.7. 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.24 位置引数

概要

<name>

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

表5.25 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--ip-version {4,6}

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

--project <project>

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

--project-domain <project-domain>

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

--share

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

--no-share

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

表5.26 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

表5.27 JSON フォーマット設定オプション

概要

--noindent

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

表5.28 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表5.29 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

5.8. address scope delete

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

使用方法

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

表5.30 位置引数

概要

<address-scope>

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

表5.31 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

5.9. 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]
                                    [--sort-ascending | --sort-descending]
                                    [--name <name>]
                                    [--ip-version <ip-version>]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--share | --no-share]

表5.32 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--name <name>

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

--ip-version <ip-version>

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

--project <project>

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

--project-domain <project-domain>

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

--share

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

--no-share

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

表5.33 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

--sort-column SORT_COLUMN

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表5.34 CSV フォーマット設定オプション

概要

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

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

表5.35 JSON フォーマット設定オプション

概要

--noindent

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

表5.36 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

5.10. address scope set

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

使用方法

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

表5.37 位置引数

概要

<address-scope>

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

表5.38 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--name <name>

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

--share

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

--no-share

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

5.11. 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.39 位置引数

概要

<address-scope>

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

表5.40 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

表5.41 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

表5.42 JSON フォーマット設定オプション

概要

--noindent

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

表5.43 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表5.44 テーブルフォーマット設定オプション

概要

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

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 シェルフォーマット設定オプション

概要

--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 cache image

アグリゲートのイメージキャッシングをリクエストします

使用方法

openstack aggregate cache image [-h] <aggregate> <image> [<image> ...]

表6.7 位置引数

概要

<aggregate>

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

<image>

アグリゲートのキャッシュをリクエストするイメージ ID (名前または ID)。複数回指定できる場合があります。

表6.8 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

6.3. 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.9 位置引数

概要

<name>

新しいアグリゲート名

表6.10 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--zone <availability-zone>

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

--property <key=value>

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

表6.11 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

表6.12 JSON フォーマット設定オプション

概要

--noindent

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

表6.13 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表6.14 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

6.4. aggregate delete

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

使用方法

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

表6.15 位置引数

概要

<aggregate>

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

表6.16 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

6.5. 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]
                                [--sort-ascending | --sort-descending]
                                [--long]

表6.17 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--long

出力の追加フィールドをリスト表示します。

表6.18 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

--sort-column SORT_COLUMN

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表6.19 CSV フォーマット設定オプション

概要

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

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

表6.20 JSON フォーマット設定オプション

概要

--noindent

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

表6.21 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

6.6. 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.22 位置引数

概要

<aggregate>

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

<host>

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

表6.23 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

表6.24 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

表6.25 JSON フォーマット設定オプション

概要

--noindent

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

表6.26 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表6.27 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

6.7. aggregate set

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

使用方法

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

表6.28 位置引数

概要

<aggregate>

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

表6.29 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--name <name>

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

--zone <availability-zone>

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

--property <key=value>

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

--no-property

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

6.8. 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.30 位置引数

概要

<aggregate>

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

表6.31 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

表6.32 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

表6.33 JSON フォーマット設定オプション

概要

--noindent

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

表6.34 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表6.35 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

6.9. aggregate unset

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

使用方法

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

表6.36 位置引数

概要

<aggregate>

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

表6.37 コマンド引数

概要

-h、--help

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>] [-m <METER NAME>]
                              [--period <PERIOD>] [--statistic <STATISTIC>]
                              [--granularity <GRANULARITY>]
                              [--aggregation-method <AGGR_METHOD>]
                              [--metric <METRIC>]
                              [--resource-type <RESOURCE_TYPE>]
                              [--resource-id <RESOURCE_ID>]
                              [--composite-rule <COMPOSITE_RULE>]
                              [--stack-id <STACK_NAME_OR_ID>]
                              [--pool-id <LOADBALANCER_POOL_NAME_OR_ID>]
                              [--autoscaling-group-id <AUTOSCALING_GROUP_NAME_OR_ID>]

表7.1 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--name <NAME>

アラームの名前

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

アラームのタイプは、event、composite、threshold、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold、loadbalancer_member_health のいずれかになります。

--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 シェルフォーマット設定オプション

概要

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

タイプが threshold または event のアラームの場合、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 しきい値アラーム

概要

-m <METER NAME>, --meter-name <METER NAME>

評価対象の Meter

--period <PERIOD>

評価する各期間の長さ (秒単位)。

--statistic <STATISTIC>

評価する統計で、[maxminavgsumcount] のいずれかになります

表7.9 common gnocchi alarm rules

概要

--granularity <GRANULARITY>

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

--aggregation-method <AGGR_METHOD>

しきい値と比較する aggregation_method

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

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

表7.10 gnocchi resource threshold alarm

概要

--resource-type <RESOURCE_TYPE>

リソースのタイプ。

--resource-id <RESOURCE_ID>

リソースの ID。

表7.11 composite alarm

概要

--composite-rule <COMPOSITE_RULE>

Json 形式の複合しきい値ルール。形式として、"and" や "or" で threshold/gnocchi ルールを組み合わせた、ネスト化ディクショナリーを指定できます。たとえば、形式は {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]} のようになります。RULEx は基本的な threshold ルールにすることができますが、{"threshold": 0.8,"meter_name":"cpu_util","type":"threshold"} のように "type" フィールドを含む必要があります。

表7.12 loadbalancer member health alarm

概要

--stack-id <STACK_NAME_OR_ID>

ロードバランサープールおよびメンバーが含まれる、ルート/トップレベル heat スタックの名前または ID。ロードバランサープールに正常でないメンバーが検出されると、ルート Stack に対して更新がトリガーされます。

--pool-id <LOADBALANCER_POOL_NAME_OR_ID>

各メンバーの正常性が評価されるロードバランサープールの名前または ID。

--autoscaling-group-id <AUTOSCALING_GROUP_NAME_OR_ID>

ロードバランサーメンバーが含まれる heat 自動スケーリンググループの ID。ルートスタックで更新がトリガーされる前に、正常ではないメンバーにはその旨マークが付けられます。

7.2. alarm delete

アラームを削除します。

使用方法

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

表7.13 位置引数

概要

<ALARM ID または NAME>

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

表7.14 コマンド引数

概要

-h、--help

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]
                                    [--sort-ascending | --sort-descending]
                                    [--limit <LIMIT>] [--marker <MARKER>]
                                    [--sort <SORT_KEY:SORT_DIR>]
                                    <alarm-id>

表7.20 位置引数

概要

<alarm-id>

アラームの ID

表7.21 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--limit <LIMIT>

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

--marker <MARKER>

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

--sort <SORT_KEY:SORT_DIR>

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

表7.22 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

--sort-column SORT_COLUMN

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表7.23 CSV フォーマット設定オプション

概要

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

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

表7.24 JSON フォーマット設定オプション

概要

--noindent

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

表7.25 テーブルフォーマット設定オプション

概要

--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]
                            [--sort-ascending | --sort-descending]
                            [--query QUERY | --filter <KEY1=VALUE1;KEY2=VALUE2...>]
                            [--limit <LIMIT>] [--marker <MARKER>]
                            [--sort <SORT_KEY:SORT_DIR>]

表7.26 コマンド引数

概要

-h、--help

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.27 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

--sort-column SORT_COLUMN

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表7.28 CSV フォーマット設定オプション

概要

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

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

表7.29 JSON フォーマット設定オプション

概要

--noindent

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

表7.30 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.6. alarm quota set

単一のオブジェクトに関するデータを表示するためのコマンドベースクラス。

使用方法

openstack alarm quota set [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--alarm ALARM]
                                 project

表7.31 位置引数

概要

project

Project ID です。

表7.32 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--alarm ALARM

alarm quota の新しい値。値が -1 の場合は無制限を意味します。

表7.33 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

表7.34 JSON フォーマット設定オプション

概要

--noindent

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

表7.35 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表7.36 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.7. alarm quota show

プロジェクトのクォータを表示します。

使用方法

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

表7.37 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--project PROJECT

プロジェクト ID。指定されていない場合は、現在のプロジェクトのクォータを取得します。

表7.38 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

表7.39 JSON フォーマット設定オプション

概要

--noindent

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

表7.40 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表7.41 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.8. 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.42 位置引数

概要

<ALARM ID または NAME>

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

表7.43 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--name <NAME>

アラームの名前

表7.44 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

表7.45 JSON フォーマット設定オプション

概要

--noindent

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

表7.46 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表7.47 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.9. 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.48 位置引数

概要

<ALARM ID または NAME>

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

表7.49 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--name <NAME>

アラームの名前

表7.50 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

表7.51 JSON フォーマット設定オプション

概要

--noindent

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

表7.52 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表7.53 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.10. 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.54 位置引数

概要

<ALARM ID または NAME>

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

表7.55 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--name <NAME>

アラームの名前

--state <STATE>

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

表7.56 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

表7.57 JSON フォーマット設定オプション

概要

--noindent

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

表7.58 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表7.59 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.11. 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>] [-m <METER NAME>]
                              [--period <PERIOD>] [--statistic <STATISTIC>]
                              [--granularity <GRANULARITY>]
                              [--aggregation-method <AGGR_METHOD>]
                              [--metric <METRIC>]
                              [--resource-type <RESOURCE_TYPE>]
                              [--resource-id <RESOURCE_ID>]
                              [--composite-rule <COMPOSITE_RULE>]
                              [--stack-id <STACK_NAME_OR_ID>]
                              [--pool-id <LOADBALANCER_POOL_NAME_OR_ID>]
                              [--autoscaling-group-id <AUTOSCALING_GROUP_NAME_OR_ID>]
                              [<ALARM ID or NAME>]

表7.60 位置引数

概要

<ALARM ID または NAME>

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

表7.61 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--name <NAME>

アラームの名前

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

アラームのタイプは、event、composite、threshold、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold、loadbalancer_member_health のいずれかになります。

--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.62 出力フォーマット設定オプション

概要

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

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

-c COLUMN, --column COLUMN

追加する列を指定します。複数の列を表示するには、繰り返すことができます。

表7.63 JSON フォーマット設定オプション

概要

--noindent

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

表7.64 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表7.65 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

表7.66 common alarm rules

概要

--query <QUERY>

タイプが threshold または event のアラームの場合、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.67 event alarm

概要

--event-type <EVENT_TYPE>

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

表7.68 しきい値アラーム

概要

-m <METER NAME>, --meter-name <METER NAME>

評価対象の Meter

--period <PERIOD>

評価する各期間の長さ (秒単位)。

--statistic <STATISTIC>

評価する統計で、[maxminavgsumcount] のいずれかになります

表7.69 common gnocchi alarm rules

概要

--granularity <GRANULARITY>

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

--aggregation-method <AGGR_METHOD>

しきい値と比較する aggregation_method

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

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

表7.70 gnocchi resource threshold alarm

概要

--resource-type <RESOURCE_TYPE>

リソースのタイプ。

--resource-id <RESOURCE_ID>

リソースの ID。

表7.71 composite alarm

概要

--composite-rule <COMPOSITE_RULE>

Json 形式の複合しきい値ルール。形式として、"and" や "or" で threshold/gnocchi ルールを組み合わせた、ネスト化ディクショナリーを指定できます。たとえば、形式は {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]} のようになります。RULEx は基本的な threshold ルールにすることができますが、{"threshold": 0.8,"meter_name":"cpu_util","type":"threshold"} のように "type" フィールドを含む必要があります。

表7.72 loadbalancer member health alarm

概要

--stack-id <STACK_NAME_OR_ID>

ロードバランサープールおよびメンバーが含まれる、ルート/トップレベル heat スタックの名前または ID。ロードバランサープールに正常でないメンバーが検出されると、ルート Stack に対して更新がトリガーされます。

--pool-id <LOADBALANCER_POOL_NAME_OR_ID>

各メンバーの正常性が評価されるロードバランサープールの名前または ID。

--autoscaling-group-id <AUTOSCALING_GROUP_NAME_OR_ID>

ロードバランサーメンバーが含まれる heat 自動スケーリンググループの ID。ルートスタックで更新がトリガーされる前に、正常ではないメンバーにはその旨マークが付けられます。

第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

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 シェルフォーマット設定オプション

概要

--prefix PREFIX

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

表8.5 テーブルフォーマット設定オプション

概要

--max-width <integer>

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

--fit-width

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

--print-empty

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

第9章 application

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

9.1. application credential create

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

使用方法

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

表9.1 位置引数

概要

<name>

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

表9.2 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--secret <secret>

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

--role <role>

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

--expiration <expiration>

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

--description <description>

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

--unrestricted

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

--restricted

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

--access-rules <access-rules>

JSON 形式のアクセスルールのリストを含む文字列またはファイルパス。それぞれにリクエストメソッド、パス、サービスが含まれます。例: [{"method": "GET", "path": "/v2.1/servers", "service": "compute"}]

表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 シェルフォーマット設定オプション

概要

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

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]
                                             [--sort-ascending | --sort-descending]
                                             [--user <user>]
                                             [--user-domain <user-domain>]

表9.9 コマンド引数

概要

-h、--help

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

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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

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 シェルフォーマット設定オプション

概要

--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]
                                        [--sort-ascending | --sort-descending]
                                        [--compute] [--network] [--volume]
                                        [--long]

表10.1 コマンド引数

概要

-h、--help

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

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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]
                                             [--owner OWNER]
                                             [--extra <key=value>]
                                             [--wait [<time-out>]]
                                             [--node NODE]

表11.1 コマンド引数

概要

-h、--help

help メッセージを表示して終了します

--resource-class RESOURCE_CLASS

要求するリソースクラス。

--trait TRAITS

要求する特性。複数回指定できます。

--candidate-node CANDIDATE_NODES

この割り当て候補ノード。複数回指定できます。1 つ以上の指定した場合には、指定した候補ノードのみが割り当ての対象として考慮されます。

--name NAME

割り当ての一意名。

--uuid UUID

割り当ての UUID

--owner OWNER

割り当ての所有者。

--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 シェルフォーマット設定オプション

概要

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

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]
                                           [--sort-ascending | --sort-descending]
                                           [--limit <limit>]
                                           [--marker <allocation>]
                                           [--sort <key>[:<direction>]]
                                           [--node <node>]
                                           [--resource-class <resource_class>]
                                           [--state <state>] [--owner <owner>]
                                           [--long | --fields <field> [<field> ...]]

表11.8 コマンド引数

概要

-h、--help

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>

この状態の割り当てのみをリスト表示します。

--owner <owner>

この所有者の割り当てのみを一覧表示します。

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

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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

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

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 シェルフォーマット設定オプション

概要

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

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

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 シェルフォーマット設定オプション

概要

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

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]
                                        [--sort-ascending | --sort-descending]
                                        [--fields <field> [<field> ...]]
                                        [--limit <limit>] [--long]
                                        [--marker <chassis>]
                                        [--sort <key>[:<direction>]]

表11.30 コマンド引数

概要

-h、--help

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

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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

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

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 シェルフォーマット設定オプション

概要

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

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]
                                          [--sort-ascending | --sort-descending]
                                          [--limit <limit>]
                                          [--marker <conductor>]
                                          [--sort <key>[:<direction>]]
                                          [--long | --fields <field> [<field> ...]]

表11.45 コマンド引数

概要

-h、--help

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

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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

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 シェルフォーマット設定オプション

概要

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

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

help メッセージを表示して終了します

--uuid <uuid>

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

--extra <key=value>

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

--steps <steps>

デプロイ手順。デプロイ手順を含む yaml ファイルへのパス、またはデプロイ手順が標準入力から読み取られる -、または 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 シェルフォーマット設定オプション

概要

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

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]
                                                [--sort-ascending | --sort-descending]
                                                [--limit <limit>]
                                                [--marker <template>]
                                                [--sort <key>[:<direction>]]
                                                [--long | --fields <field> [<field> ...]]

表11.66 コマンド引数

概要

-h、--help

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

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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

help メッセージを表示して終了します

--name <name>

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

--steps <steps>

デプロイ手順。デプロイ手順を含む yaml ファイルへのパス、またはデプロイ手順が標準入力から読み取られる -、または 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

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 シェルフォーマット設定オプション

概要

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

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]
                                       [--sort-ascending | --sort-descending]
                                       [--type <type>] [--long]

表11.81 コマンド引数

概要

-h、--help

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

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

--sort-ascending

列を昇順で並べ替えます。

--sort-descending

列を降順で並べ替えます。

表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

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 シェルフォーマット設定オプション

概要

--prefix PREFIX

<