コマンドラインインターフェイスリファレンス
Red Hat OpenStack Platform のコマンドラインクライアント
OpenStack Documentation Team
rhos-docs@redhat.com
概要
多様性を受け入れるオープンソースの強化
Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、Red Hat CTO である Chris Wright のメッセージ をご覧ください。
Red Hat ドキュメントへのフィードバック (英語のみ)
Red Hat ドキュメントに対するご意見をお聞かせください。ドキュメントの改善点があればお知らせください。
ドキュメントへのダイレクトフィードバック (DDF) 機能の使用 (英語版のみ)
特定の文章、段落、またはコードブロックに対して直接コメントを送付するには、DDF の Add Feedback 機能を使用してください。なお、この機能は英語版のドキュメントでのみご利用いただけます。
- Multi-page HTML 形式でドキュメントを表示します。
- ドキュメントの右上隅に Feedback ボタンが表示されていることを確認してください。
- コメントするテキスト部分をハイライト表示します。
- Add Feedback をクリックします。
- Add Feedback フィールドにコメントを入力します。
- オプション: ドキュメントチームが問題の詳細を確認する際に使用できるメールアドレスを記入してください。
- 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-queues-api-version <queues-api-version>] [--os-database-api-version <database-api-version>] [--os-tripleoclient-api-version <tripleoclient-api-version>] [--os-data-processing-api-version <data-processing-api-version>] [--os-data-processing-url OS_DATA_PROCESSING_URL] [--os-loadbalancer-api-version <loadbalancer-api-version>] [--os-workflow-api-version <workflow-api-version>] [--os-container-infra-api-version <container-infra-api-version>] [--os-baremetal-api-version <baremetal-api-version>] [--inspector-api-version INSPECTOR_API_VERSION] [--inspector-url INSPECTOR_URL] [--os-orchestration-api-version <orchestration-api-version>] [--os-dns-api-version <dns-api-version>] [--os-key-manager-api-version <key-manager-api-version>] [--os-metrics-api-version <metrics-api-version>] [--os-alarming-api-version <alarming-api-version>] [--os-auth-type <auth-type>] [--os-auth-url <auth-auth-url>] [--os-trust-id <auth-trust-id>] [--os-username <auth-username>] [--os-user-id <auth-user-id>] [--os-password <auth-password>] [--os-project-id <auth-project-id>] [--os-roles <auth-roles>] [--os-aodh-endpoint <auth-aodh-endpoint>] [--os-system-scope <auth-system-scope>] [--os-domain-id <auth-domain-id>] [--os-domain-name <auth-domain-name>] [--os-project-name <auth-project-name>] [--os-project-domain-id <auth-project-domain-id>] [--os-project-domain-name <auth-project-domain-name>] [--os-identity-provider <auth-identity-provider>] [--os-protocol <auth-protocol>] [--os-access-token <auth-access-token>] [--os-default-domain-id <auth-default-domain-id>] [--os-default-domain-name <auth-default-domain-name>] [--os-token <auth-token>] [--os-identity-provider-url <auth-identity-provider-url>] [--os-service-provider-endpoint <auth-service-provider-endpoint>] [--os-service-provider-entity-id <auth-service-provider-entity-id>] [--os-user-domain-id <auth-user-domain-id>] [--os-user-domain-name <auth-user-domain-name>] [--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-passcode <auth-passcode>] [--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-redirect-uri <auth-redirect-uri>] [--os-code <auth-code>] [--os-endpoint <auth-endpoint>] [--os-auth-methods <auth-auth-methods>] [--os-user <auth-user>] [--os-consumer-key <auth-consumer-key>] [--os-consumer-secret <auth-consumer-secret>] [--os-access-key <auth-access-key>] [--os-access-secret <auth-access-secret>]
表1.1 コマンド引数
値 | 概要 |
---|---|
--version | プログラムのバージョン番号を表示して終了します。 |
-v、--verbose | 出力の詳細レベルが上がります。繰り返し指定できます。 |
-q、--quiet | 警告およびエラー以外の出力を減らします。 |
--log-file LOG_FILE | 出力をログに記録するファイルを指定します。デフォルトでは無効です。 |
-h、--help | ヘルプメッセージを表示して終了します。 |
--debug | エラーのトレースバックを表示します。 |
--os-cloud <cloud-config-name> | Clouds.yaml のクラウド名 (env: os_cloud) |
--os-region-name <auth-region-name> | 認証リージョン名 (env: os_region_name) |
--os-cacert <ca-bundle-file> | CA 証明書バンドルファイル (env: os_cacert) |
--os-cert <certificate-file> | クライアント証明書バンドルファイル (env: os_cert) |
--os-key <key-file> | クライアント証明書キーファイル (env: os_key) |
--verify | サーバー証明書を検証します (デフォルト) |
--insecure | サーバー証明書の検証を無効にします。 |
--os-default-domain <auth-domain> | デフォルトのドメイン ID、デフォルト=default (env: OS_DEFAULT_DOMAIN)。 |
--os-interface <interface> | インターフェイスタイプを選択します。有効なインターフェイスタイプ:[admin, public, internal]。 デフォルト=public (Env: OS_INTERFACE) |
--os-service-provider <service_provider> | Keystone-to-keystone フェデレーションを使用して、サービスプロバイダーで認証を行い、コマンドを実行します。リモートプロジェクトオプションも指定する必要があります。 |
--os-remote-project-name <remote_project_name> | Keystone-to-Keystone フェデレーションを使用する場合の、サービスプロバイダーに対して認証する際のプロジェクト名。 |
--os-remote-project-id <remote_project_id> | Keystone-to-Keystone フェデレーションを使用する場合の、サービスプロバイダーに対して認証する際のプロジェクト ID。 |
--os-remote-project-domain-name <remote_project_domain_name> | Keystone-to-Keystone フェデレーションを使用する場合の、サービスプロバイダーに対して認証する際のプロジェクトのドメイン名。 |
--os-remote-project-domain-id <remote_project_domain_id> | Keystone-to-Keystone フェデレーションを使用する場合の、サービスプロバイダーに対して認証する際のプロジェクトのドメイン ID。 |
--timing | API 呼び出しのタイミング情報を出力します。 |
--os-beta-command | 変更の可能性のあるベータコマンドを有効にします。 |
--os-profile hmac-key | プロファイリングコンテキストデータを暗号化するための HMAC キー |
--os-compute-api-version <compute-api-version> | Compute api バージョン、デフォルト=2.1(env: OS_COMPUTE_API_VERSION) |
--os-identity-api-version <identity-api-version> | api バージョンを特定します。デフォルト=3(env: OS_IDMYBACKUPDIR_API_VERSION) |
--os-image-api-version <image-api-version> | イメージ api バージョン、デフォルト=2(env: OS_IMAGE_API_VERSION) |
--os-network-api-version <network-api-version> | ネットワーク api バージョン、デフォルト=2.0(env: OS_NETWORK_API_VERSION) |
--os-object-api-version <object-api-version> | オブジェクト api バージョン、デフォルト=1(env: OS_MYBACKUPDIR_API_VERSION) |
--os-volume-api-version <volume-api-version> | ボリューム api バージョン、デフォルト=3(env: OS_VOLUME_API_VERSION) |
--os-queues-api-version <queues-api-version> | キュー API バージョン、デフォルト=2(env: OS_QUEUES_API_VERSION) |
--os-database-api-version <database-api-version> | データベース api バージョン、デフォルト=1(env: OS_DATABASE_API_VERSION) |
--os-tripleoclient-api-version <tripleoclient-api-version> | TripleO クライアント api バージョン、デフォルト=1(env: OS_TRIPLEOCLIENT_API_VERSION) |
--os-data-processing-api-version <data-processing-api-version> | データ処理の api バージョン、デフォルト=1.1(env: OS_DATA_MYBACKUPDIRING_API_VERSION) |
--os-data-processing-url OS_DATA_PROCESSING_URL | データ処理の api url (env: OS_DATA_MYBACKUPDIRING_API_URL) |
--os-loadbalancer-api-version <loadbalancer-api-version> | Osc プラグイン api バージョン、デフォルト=2.0(env: OS_LOADBALANCER_API_VERSION) |
--os-workflow-api-version <workflow-api-version> | ワークフロー api バージョン、デフォルト=2(env: OS_WORKFLOW_API_VERSION) |
--os-container-infra-api-version <container-infra-api-version> | Container-infra api バージョン、デフォルト=1(env: OS_CONTAINER_INFRA_API_VERSION) |
--os-baremetal-api-version <baremetal-api-version> | ベアメタル api バージョン、デフォルト="latest"(クライアントとサーバーの両方でサポートされる最新バージョン)(Env: OS_BAREMETAL_API_VERSION) |
--inspector-api-version INSPECTOR_API_VERSION | インスペクター api バージョン。バージョン 1 だけがサポート対象です (env: INMYBACKUPDIRTOR_VERSION)。 |
--inspector-url INSPECTOR_URL | インスペクター url。デフォルトは localhost です (env: INMYBACKUPDIRTOR_URL)。 |
--os-orchestration-api-version <orchestration-api-version> | オーケストレーション api バージョン、デフォルト=1(env: OS_ORCHESTRATION_API_VERSION) |
--os-dns-api-version <dns-api-version> | DNS api バージョン、デフォルト=2(env: os_dns_api_version) |
--os-key-manager-api-version <key-manager-api-version> | Barbican api バージョン、デフォルト=1(env: OS_KEY_MANAGER_API_VERSION) |
--os-metrics-api-version <metrics-api-version> | メトリック api バージョン、デフォルト=1(env: OS_METRICS_API_VERSION) |
--os-alarming-api-version <alarming-api-version> | キュー api バージョン、デフォルト=2(env: OS_ALARMING_API_VERSION) |
--os-auth-type <auth-type> | 認証タイプを選択します。利用可能なタイプ:v2password、aodh-noauth、v3oidcaccesstoken、token、v3adfspassword、v3token、v3applicationcredential、v3totp、v3oidcauthcode、noauth、v3multifactor、password、v3password、v3oidcclientcredentials、gnocchi-noauth、 v3oidcpassword, v2token, gnocchi-basic, v3tokenlessauth, v1password, v3samlpassword, none, v3oauth1, admin_token.デフォルト:--os-username/--os-token をもとに選択されます (Env: OS_AUTH_TYPE)。 |
--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-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-username <auth-username> | v3password: ユーザー名。v3totp: ユーザー名。password: ユーザー名。 v3applicationcredential: ユーザー名。 v1password: ログインするユーザー名。v3MYBACKUPDIRpassword: ユーザー名。 v2password: ログインするユーザー名 v3oidcpassword: ユーザー名。 v3adfspassword: ユーザー名 (Env: OS_USERNAME) |
--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-password <auth-password> | v3password: ユーザーのパスワード。password: ユーザーのパスワード。v1password: ユーザーのパスワード。v3MYBACKUPDIRpassword: パスワード。v2password: 使用するパスワード。v3oidcpassword: パスワード。 v3adfspassword: パスワード。(Env: OS_PASSWORD) |
--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-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-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-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-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-access-token <auth-access-token> | v3oidcaccesstoken: oauth 2.0 アクセストークン (env: OS_ACCESS_TOKEN) |
--os-default-domain-id <auth-default-domain-id> | トークン:v3 および v2 パラメーターで使用するオプションのドメイン ID。これは v3 のユーザーとプロジェクトドメインの両方に使用され、v2 認証では無視されます。パスワード: v3 および v2 パラメーターで使用するオプションのドメイン ID。これは v3 のユーザーとプロジェクトドメインの両方に使用され、v2 認証では無視されます。(Env: OS_DEFAULT_DOMAIN_ID) |
--os-default-domain-name <auth-default-domain-name> | トークン:v3 api および v2 パラメーターで使用するオプションのドメイン名。これは v3 のユーザーとプロジェクトドメインの両方に使用され、v2 認証では無視されます。パスワード: v3 api および v2 パラメーターと使用するオプションのドメイン名。これは v3 のユーザーとプロジェクトドメインの両方に使用され、v2 認証では無視されます。(Env: OS_DEFAULT_DOMAIN_NAME) |
--os-token <auth-token> | v3token: 認証に使用するトークン。v2token: トークン。 token: 認証に使用するトークン。admin_token: 常に使用されるトークン (Env: OS_TOKEN) |
--os-identity-provider-url <auth-identity-provider-url> | v3adfspassword: SAML 認証要求の送信先となる認証プロバイダーの URL。v3samlpassword: SAML2 認証要求の送信先となる認証プロバイダーの URL。(Env: OS_IDMYBACKUPDIR_INTERFACE_URL) |
--os-service-provider-endpoint <auth-service-provider-endpoint> | V3adfspassword: サービスプロバイダーのエンドポイント (env: OS_SERVICE_PROVIDER_ENDPOINT) の使用 |
--os-service-provider-entity-id <auth-service-provider-entity-id> | v3adfspassword: サービスプロバイダーの SAML エンティティー id(Env: OS_SERVICE_MYBACKUPDIR_MYBACKUPDIR_ID) |
--os-user-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-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-passcode <auth-passcode> | v3totp: ユーザーの totp パスコード (env: os_passcode) |
--os-client-id <auth-client-id> | v3oidcauthcode: oauth 2.0 クライアント ID。 v3oidcclientcredentials: OAuth 2.0 クライアント ID。v3oidcpassword: OAuth 2.0 クライアント ID。(Env: OS_CLIENT_ID) |
--os-client-secret <auth-client-secret> | v3oidcauthcode: oauth 2.0 クライアントシークレット。 v3oidcclientcredentials: OAuth 2.0 クライアントシークレット。v3oidcpassword: OAuth 2.0 クライアントシークレット。(Env: OS_CLIENT_SECRET) |
--os-openid-scope <auth-openid-scope> | v3oidcauthcode: 認可サーバーからリクエストされた openid 接続スコープ。OpenID Connect 仕様には、openid を常に指定する必要があります。v3oidcclientcredentials: OpenID Connect 範囲が認可サーバーから要求されます。OpenID Connect 仕様には、openid を常に指定する必要があります。v3oidcpassword: 認可サーバーから要求される OpenID Connect 範囲。OpenID Connect 仕様には、openid を常に指定する必要があります。(Env: OS_OPENID_SCOPE) |
--os-access-token-endpoint <auth-access-token-endpoint> | V3oidcauthcode: openid connect プロバイダーの トークンエンドポイント。検出ドキュメントが渡された場合には、このオプションの指定内容が、検出ドキュメントでサーバーが提供するエンドポイントよりも優先される点に注意してください。V3oidcclientcredentials: OpenID Connect プロバイダートークンエンドポイント。検出ドキュメントが渡された場合には、このオプションの指定内容が、検出ドキュメントでサーバーが提供するエンドポイントよりも優先される点に注意してください。V3oidcpassword: OpenID Connect プロバイダートークンエンドポイント。検出ドキュメントが渡された場合には、このオプションの指定内容が、検出ドキュメントでサーバーが提供するエンドポイントよりも優先される点に注意してください。(Env: OS_ACCESS_TOKEN_ENDPOINT) |
--os-discovery-endpoint <auth-discovery-endpoint> | V3oidcauthcode: openid connect 検出 ドキュメント URL。検出ドキュメントを使用して、アクセストークンエンドポイントおよび認証エンドポイントの値を取得します。この URL は、https://idp.example.org/.well-known/openid-configuration のようになります。v3oidcclientcredentials: OpenID Connect 検出ドキュメントの URL。検出ドキュメントを使用して、アクセストークンエンドポイントおよび認証エンドポイントの値を取得します。この URL は https://idp.example.org/.well- known/openid-configuration のようになるはずです。v3oidcpassword: OpenID Connect 検出ドキュメント URL。検出ドキュメントを使用して、アクセストークンエンドポイントおよび認証エンドポイントの値を取得します。この URL は https://idp.example.org/.well- known/openid-configuration のようになるはずです (Env: OS_DISCOVERY_ENDPOINT)。 |
--os-access-token-type <auth-access-token-type> | V3oidcauthcode: oauth 2.0 承認サーバー Introspection トークンタイプ。これはトークンイントロスペクションの処理時に使用するトークンの種類を決定するために使用されます。有効な値は、access_token または id_token です。v3oidcclientcredentials: OAuth 2.0 認証サーバーイントロスペクションのトークンタイプで、トークンイントロスペクションの処理時に使用するトークンのタイプを決定するために使用されます。有効な値は、access_token または id_token です。v3oidcpassword: OAuth 2.0 認証サーバーイントロスペクションのトークンタイプで、トークンイントロスペクションの処理時に使用するトークンのタイプを決定するために使用されます。有効な値は、access_token または id_token です (Env: OS_ACCESS_TOKEN_TYPE)。 |
--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-endpoint <auth-endpoint> | admin_token: 常に使用されるエンドポイント。none: 常に使用されるエンドポイント。gnocchi-basic: Gnocchi エンドポイント。noauth: Cinder エンドポイント。gnocchi-noauth: Gnocchi エンドポイント。(Env: OS_ENDPOINT) |
--os-auth-methods <auth-auth-methods> | V3multifactor: 認証する方法。(Env: OS_AUTH_METHODS) |
--os-user <auth-user> | gnocchi-basic: ユーザー (env: os_user) |
--os-consumer-key <auth-consumer-key> | With v3oauth1: oauth コンシューマー id/キー (env: OS_CONSUMER_KEY) |
--os-consumer-secret <auth-consumer-secret> | V3oauth1: oauth コンシューマーシークレット (env: OS_CONSUMER_SECRET) |
--os-access-key <auth-access-key> | v3oauth1: oauth アクセスキー (env: os_access_key) |
--os-access-secret <auth-access-secret> | V3oauth1: oauth アクセスシークレット (env: OS_ACCESS_SECRET) |
第2章 access
本章では、access
コマンドに含まれるコマンドについて説明します。
2.1. access token create
アクセストークンを作成します。
使用方法
openstack access token create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --consumer-key <consumer-key> --consumer-secret <consumer-secret> --request-key <request-key> --request-secret <request-secret> --verifier <verifier>
表2.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--consumer-key <consumer-key> | コンシューマーキー (必須) |
--consumer-secret <consumer-secret> | コンシューマーシークレット (必須) |
--request-key <request-key> | アクセストークンを交換するための要求トークン (必須) |
--request-secret <request-secret> | <request-key> に関連付けられたシークレット (必須) |
--verifier <verifier> | <request-key> に関連付けられた検証機能 (必須) |
表2.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表2.3 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表2.4 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表2.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第3章 acl
本章では、acl
コマンドに含まれるコマンドについて説明します。
3.1. acl delete
Href で特定されたシークレットまたはコンテナーの ACL を削除します。
使用方法
openstack acl delete [-h] URI
表3.1 位置引数
値 | 概要 |
---|---|
URI | シークレットまたはコンテナーの URI 参照。 |
表3.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
3.2. acl get
Href を指定して、シークレットまたはコンテナーの ACL を取得します。
使用方法
openstack acl get [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] URI
表3.3 位置引数
値 | 概要 |
---|---|
URI | シークレットまたはコンテナーの URI 参照。 |
表3.4 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表3.5 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表3.6 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表3.7 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表3.8 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
3.3. acl submit
Href で特定されたシークレットまたはコンテナーに ACL を送信します。
使用方法
openstack acl submit [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--user [USERS]] [--project-access | --no-project-access] [--operation-type {read}] URI
表3.9 位置引数
値 | 概要 |
---|---|
URI | シークレットまたはコンテナーの URI 参照。 |
表3.10 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--user [USERS], -u [USERS] | ACL の keystone ユーザー ID。 |
--project-access | プロジェクトアクセスの動作を有効にするフラグ。 |
--no-project-access | プロジェクトアクセスの動作を無効にするフラグ。 |
--operation-type {read}, -o {read} | 設定される Barbican 操作の acl のタイプ。 |
表3.11 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表3.12 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表3.13 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表3.14 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
3.4. acl user add
Href で特定されたシークレットまたはコンテナーに ACL ユーザーを追加します。
使用方法
openstack acl user add [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--user [USERS]] [--project-access | --no-project-access] [--operation-type {read}] URI
表3.15 位置引数
値 | 概要 |
---|---|
URI | シークレットまたはコンテナーの URI 参照。 |
表3.16 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--user [USERS], -u [USERS] | ACL の keystone ユーザー ID。 |
--project-access | プロジェクトアクセスの動作を有効にするフラグ。 |
--no-project-access | プロジェクトアクセスの動作を無効にするフラグ。 |
--operation-type {read}, -o {read} | 設定される Barbican 操作の acl のタイプ。 |
表3.17 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表3.18 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表3.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表3.20 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
3.5. acl user remove
Href で特定されたシークレットまたはコンテナーから ACL ユーザーを削除します。
使用方法
openstack acl user remove [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--user [USERS]] [--project-access | --no-project-access] [--operation-type {read}] URI
表3.21 位置引数
値 | 概要 |
---|---|
URI | シークレットまたはコンテナーの URI 参照。 |
表3.22 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--user [USERS], -u [USERS] | ACL の keystone ユーザー ID。 |
--project-access | プロジェクトアクセスの動作を有効にするフラグ。 |
--no-project-access | プロジェクトアクセスの動作を無効にするフラグ。 |
--operation-type {read}, -o {read} | 設定される Barbican 操作の acl のタイプ。 |
表3.23 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表3.24 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表3.25 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表3.26 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第4章 action
本章では、action
コマンドに含まれるコマンドについて説明します。
4.1. action definition create
新しいアクションを作成します。
使用方法
openstack action definition create [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS] [--public] definition
表4.1 位置引数
値 | 概要 |
---|---|
定義 | アクション定義ファイル |
表4.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--marker [MARKER] | 前のページで最後に実行した UUID。マーカーの後の実行をリスト表示します。 |
--limit [LIMIT] | 単一の結果で返すエントリーの最大数。 |
--sort_keys [SORT_KEYS] | 結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description |
--sort_dirs [SORT_DIRS] | 並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc |
--filter FILTERS | フィルター。繰り返し使用できます。 |
--public | このフラグを使用した場合には、アクションにはパブリックのマークが付けられます。 |
表4.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表4.4 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表4.5 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表4.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
4.2. action definition definition show
アクション定義を表示します。
使用方法
openstack action definition definition show [-h] name
表4.7 位置引数
値 | 概要 |
---|---|
name | アクション名 |
表4.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
4.3. action definition delete
アクションを削除します。
使用方法
openstack action definition delete [-h] action [action ...]
表4.9 位置引数
値 | 概要 |
---|---|
action | アクションの名前または ID。 |
表4.10 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
4.4. action definition list
すべてのアクションをリスト表示します。
使用方法
openstack action definition list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS]
表4.11 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--marker [MARKER] | 前のページで最後に実行した UUID。マーカーの後の実行をリスト表示します。 |
--limit [LIMIT] | 単一の結果で返すエントリーの最大数。 |
--sort_keys [SORT_KEYS] | 結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description |
--sort_dirs [SORT_DIRS] | 並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc |
--filter FILTERS | フィルター。繰り返し使用できます。 |
表4.12 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表4.13 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表4.14 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表4.15 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
4.5. action definition show
特定のアクションを表示します。
使用方法
openstack action definition show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] action
表4.16 位置引数
値 | 概要 |
---|---|
action | アクション (名前または ID) |
表4.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表4.18 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表4.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表4.20 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表4.21 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
4.6. action definition update
アクションを更新します。
使用方法
openstack action definition update [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS] [--id ID] [--public] definition
表4.22 位置引数
値 | 概要 |
---|---|
定義 | アクション定義ファイル |
表4.23 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--marker [MARKER] | 前のページで最後に実行した UUID。マーカーの後の実行をリスト表示します。 |
--limit [LIMIT] | 単一の結果で返すエントリーの最大数。 |
--sort_keys [SORT_KEYS] | 結果をソートするソートキーのコンマ区切りリスト。デフォルト:created_at。例:mistral execution-list --sort_keys=id,description |
--sort_dirs [SORT_DIRS] | 並べ替え方向のコンマ区切りリスト。デフォルト:ascExample: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc |
--filter FILTERS | フィルター。繰り返し使用できます。 |
--id ID | アクション ID。 |
--public | このフラグを使用した場合には、アクションにはパブリックのマークが付けられます。 |
表4.24 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表4.25 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表4.26 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表4.27 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
4.7. action execution delete
アクション実行を削除します。
使用方法
openstack action execution delete [-h] action_execution [action_execution ...]
表4.28 位置引数
値 | 概要 |
---|---|
action_execution | アクション実行識別子の ID。 |
表4.29 コマンド引数
値 | 概要 |
---|---|
-h、--help | 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] [--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 | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表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] name [input]
表4.40 位置引数
値 | 概要 |
---|---|
name | 実行するアクション名。 |
入力 (input) | アクション入力。 |
表4.41 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-s, --save-result | 結果を db に保存します。 |
--run-sync | アクションを同期的に実行します。 |
-t TARGET, --target TARGET | アクションは <target> エグゼキューターで実行されます。 |
表4.42 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表4.43 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表4.44 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--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 scope create
新しいアドレススコープを作成します。
使用方法
openstack address scope create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--ip-version {4,6}] [--project <project>] [--project-domain <project-domain>] [--share | --no-share] <name>
表5.1 位置引数
値 | 概要 |
---|---|
<name> | 新しいアドレススコープ名 |
表5.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--ip-version {4,6} | IP バージョン (デフォルトは 4) |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--share | プロジェクト間でアドレススコープを共有します。 |
--no-share | プロジェクト間でアドレススコープを共有しません (デフォルト) |
表5.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表5.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表5.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表5.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
5.2. address scope delete
アドレススコープを削除します。
使用方法
openstack address scope delete [-h] <address-scope> [<address-scope> ...]
表5.7 位置引数
値 | 概要 |
---|---|
<address-scope> | 削除するアドレススコープ (名前または ID) |
表5.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
5.3. address scope list
アドレススコープをリスト表示します。
使用方法
openstack address scope list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name <name>] [--ip-version <ip-version>] [--project <project>] [--project-domain <project-domain>] [--share | --no-share]
表5.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 出力に、指定された名前のアドレススコープのみをリスト表示します。 |
--ip-version <ip-version> | 指定した IP バージョンネットワークのアドレススコープをリスト表示します (4 または 6)。 |
--project <project> | プロジェクト (名前または ID) に合わせてアドレススコープをリスト表示します。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--share | プロジェクト間で共有されているアドレススコープをリスト表示します。 |
--no-share | プロジェクト間で共有されていないアドレススコープをリスト表示します。 |
表5.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表5.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表5.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表5.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
5.4. address scope set
アドレススコープのプロパティーを設定します。
使用方法
openstack address scope set [-h] [--name <name>] [--share | --no-share] <address-scope>
表5.14 位置引数
値 | 概要 |
---|---|
<address-scope> | 変更するアドレススコープ (名前または ID) |
表5.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | アドレススコープ名を設定します。 |
--share | プロジェクト間でアドレススコープを共有します。 |
--no-share | プロジェクト間でアドレススコープを共有しません。 |
5.5. address scope show
アドレススコープの詳細を表示します。
使用方法
openstack address scope show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <address-scope>
表5.16 位置引数
値 | 概要 |
---|---|
<address-scope> | 表示するアドレススコープ (名前または ID) |
表5.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | 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 | 表示するデータがない場合は空のテーブルを出力します。 |
第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 create
新規アグリゲートを作成します。
使用方法
openstack aggregate create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--zone <availability-zone>] [--property <key=value>] <name>
表6.7 位置引数
値 | 概要 |
---|---|
<name> | 新しいアグリゲート名 |
表6.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--zone <availability-zone> | アベイラビリティーゾーン名 |
--property <key=value> | このアグリゲートに追加するプロパティー (複数のプロパティーを設定する場合は repeat オプション) |
表6.9 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表6.10 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表6.11 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表6.12 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
6.3. aggregate delete
既存のアグリゲートを削除します。
使用方法
openstack aggregate delete [-h] <aggregate> [<aggregate> ...]
表6.13 位置引数
値 | 概要 |
---|---|
<aggregate> | 削除するアグリゲート (名前または ID) |
表6.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
6.4. aggregate list
すべてのアグリゲートをリスト表示します。
使用方法
openstack aggregate list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
表6.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
表6.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表6.17 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表6.18 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表6.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
6.5. aggregate remove host
アグリゲートからホストを削除します。
使用方法
openstack aggregate remove host [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <aggregate> <host>
表6.20 位置引数
値 | 概要 |
---|---|
<aggregate> | アグリゲート (名前または ID) |
<host> | <aggregate> から削除するホスト |
表6.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表6.22 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表6.23 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表6.24 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表6.25 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
6.6. aggregate set
アグリゲートプロパティーを設定します。
使用方法
openstack aggregate set [-h] [--name <name>] [--zone <availability-zone>] [--property <key=value>] [--no-property] <aggregate>
表6.26 位置引数
値 | 概要 |
---|---|
<aggregate> | 変更するアグリゲート (名前または ID) |
表6.27 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | アグリゲート名を設定します。 |
--zone <availability-zone> | アベイラビリティーゾーン名を設定します。 |
--property <key=value> | <aggregate> に設定するプロパティー (複数のプロパティーを設定する場合はオプションを繰り返し使用します) |
--no-property | <aggregate> からすべてのプロパティーを削除します (--property と --no-property の両方を指定して現在のプロパティーを上書きします)。 |
6.7. aggregate show
アグリゲートの詳細を表示します。
使用方法
openstack aggregate show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <aggregate>
表6.28 位置引数
値 | 概要 |
---|---|
<aggregate> | 表示へのアグリゲート (名前または ID) |
表6.29 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表6.30 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表6.31 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表6.32 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表6.33 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
6.8. aggregate unset
アグリゲートプロパティーの設定を解除します。
使用方法
openstack aggregate unset [-h] [--property <key>] <aggregate>
表6.34 位置引数
値 | 概要 |
---|---|
<aggregate> | 変更するアグリゲート (名前または ID) |
表6.35 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--property <key> | アグリゲートから削除するプロパティー (複数のプロパティーを設定する場合はオプションを繰り返し使用します) |
第7章 alarm
本章では、alarm
コマンドに含まれるコマンドについて説明します。
7.1. alarm create
アラームの作成
使用方法
openstack alarm create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --name <NAME> -t <TYPE> [--project-id <PROJECT_ID>] [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--query <QUERY>] [--comparison-operator <OPERATOR>] [--evaluation-periods <EVAL_PERIODS>] [--threshold <THRESHOLD>] [--event-type <EVENT_TYPE>] [--granularity <GRANULARITY>] [--aggregation-method <AGGR_METHOD>] [--metric <METRIC>] [--resource-type <RESOURCE_TYPE>] [--resource-id <RESOURCE_ID>] [--composite-rule <COMPOSITE_RULE>]
表7.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <NAME> | アラームの名前 |
-t <TYPE>, --type <TYPE> | アラームのタイプ:event、composite、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold のいずれかです。 |
--project-id <PROJECT_ID> | アラームに関連付けるプロジェクト (管理ユーザーだけが設定可能) |
--user-id <USER_ID> | アラームに関連付けるユーザー (管理ユーザーだけが設定可能) |
--description <DESCRIPTION> | アラームのフリーテキストの説明 |
--state <STATE> | アラームの状態。以下のいずれか:[ok, alarm, insufficient data] |
--severity <SEVERITY> | アラームの重大度。以下のいずれか [low, moderate,critical] |
--enabled {True|False} | アラーム評価が有効な場合は true。 |
--alarm-action <Webhook URL> | 状態が alarm に切り替わったときに呼び出す URL。複数回使用できます。 |
--ok-action <Webhook URL> | 状態が ok に切り替わったときに呼び出す URL。複数回使用できます。 |
--insufficient-data-action <Webhook URL> | 状態が insufficient data に切り替わったときに呼び出す URL。複数回の使用が可能です。 |
--time-constraint <Time Constraint> | 評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]] です。 |
--repeat-actions {True|False} | アラームがターゲット状態にある時にアクションを繰り返し通知する場合は True |
表7.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表7.3 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表7.4 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表7.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
表7.6 common alarm rules
値 | 概要 |
---|---|
--query <QUERY> | アラームのイベントタイプ: key[op]data_type::value; list。data_type はオプションですが、指定する場合には、文字列、整数、浮動またはブール型にする必要があります。gnocchi_aggregation_by_resources_threshold タイプのアラーム: {"and": [{"=": {"ended_at": null}}, …]} のように、複雑なクエリー json 文字列を指定する必要があります。 |
--comparison-operator <OPERATOR> | 比較するオペレーター:[lt,le,eq,ne,ge,gt] のいずれか。 |
--evaluation-periods <EVAL_PERIODS> | 評価する期間の数 |
--threshold <THRESHOLD> | 評価するしきい値。 |
表7.7 event alarm
値 | 概要 |
---|---|
--event-type <EVENT_TYPE> | 評価対象のイベントタイプ |
表7.8 common gnocchi alarm rules
値 | 概要 |
---|---|
--granularity <GRANULARITY> | クエリーを行う時間範囲 (秒単位)。 |
--aggregation-method <AGGR_METHOD> | しきい値と比較する aggregation_method |
--metric <METRIC>, --metrics <METRIC> | アラームタイプに応じたメトリック ID または名前 |
表7.9 gnocchi resource threshold alarm
値 | 概要 |
---|---|
--resource-type <RESOURCE_TYPE> | リソースのタイプ。 |
--resource-id <RESOURCE_ID> | リソースの ID。 |
表7.10 composite alarm
値 | 概要 |
---|---|
--composite-rule <COMPOSITE_RULE> | Json 形式の複合しきい値ルール。形式として、"and"や"or" で gnocchi ルールを組み合わせた、ネスト化ディクショナリーを指定できます。形式例: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}。 |
7.2. alarm delete
アラームを削除します。
使用方法
openstack alarm delete [-h] [--name <NAME>] [<ALARM ID or NAME>]
表7.11 位置引数
値 | 概要 |
---|---|
<ALARM ID または NAME> | アラームの ID または名前。 |
表7.12 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <NAME> | アラームの名前 |
7.3. alarm-history search
クエリーに基づいてすべてのアラームの履歴を表示します。
使用方法
openstack alarm-history search [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--query QUERY]
表7.13 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--query QUERY | aodh がサポートする立地クエリー。例: project_id!=my-id user_id=foo or user_id=bar |
表7.14 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表7.15 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表7.16 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表7.17 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
7.4. alarm-history show
アラームの履歴を表示します。
使用方法
openstack alarm-history show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT_KEY:SORT_DIR>] <alarm-id>
表7.18 位置引数
値 | 概要 |
---|---|
<alarm-id> | アラームの ID |
表7.19 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit <LIMIT> | 返すリソースの数 (デフォルトはサーバーのデフォルトです)。 |
--marker <MARKER> | 前のリストの最後のアイテム。この値の後に来る結果を返します。サポート対象のマーカーは event_id です。 |
--sort <SORT_KEY:SORT_DIR> | リソース属性をソートします (例:timestamp:desc)。 |
表7.20 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表7.21 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表7.22 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表7.23 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
7.5. alarm list
アラームをリスト表示します。
使用方法
openstack alarm list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--query QUERY | --filter <KEY1=VALUE1;KEY2=VALUE2...>] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT_KEY:SORT_DIR>]
表7.24 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--query QUERY | aodh がサポートする立地クエリー。例: project_id!=my-id user_id=foo or user_id=bar |
--filter <KEY1=VALUE1;KEY2=VALUE2…> | 返されたアラームに適用するパラメーターをフィルタリングします。 |
--limit <LIMIT> | 返すリソースの数 (デフォルトはサーバーのデフォルトです)。 |
--marker <MARKER> | 前のリストの最後のアイテム。この値の後に来る結果を返します。サポート対象のマーカーは alarm_id です。 |
--sort <SORT_KEY:SORT_DIR> | リソース属性をソートします (例:name:asc)。 |
表7.25 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表7.26 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表7.27 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表7.28 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
7.6. alarm show
アラームを表示します。
使用方法
openstack alarm show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <NAME>] [<ALARM ID or NAME>]
表7.29 位置引数
値 | 概要 |
---|---|
<ALARM ID または NAME> | アラームの ID または名前。 |
表7.30 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <NAME> | アラームの名前 |
表7.31 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表7.32 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表7.33 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表7.34 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
7.7. alarm state get
アラームの状態を取得します。
使用方法
openstack alarm state get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <NAME>] [<ALARM ID or NAME>]
表7.35 位置引数
値 | 概要 |
---|---|
<ALARM ID または NAME> | アラームの ID または名前。 |
表7.36 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <NAME> | アラームの名前 |
表7.37 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表7.38 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表7.39 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表7.40 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
7.8. alarm state set
アラームの状態を設定します。
使用方法
openstack alarm state set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <NAME>] --state <STATE> [<ALARM ID or NAME>]
表7.41 位置引数
値 | 概要 |
---|---|
<ALARM ID または NAME> | アラームの ID または名前。 |
表7.42 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <NAME> | アラームの名前 |
--state <STATE> | アラームの状態。以下のいずれか:[ok, alarm, insufficient data] |
表7.43 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表7.44 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表7.45 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表7.46 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
7.9. alarm update
アラームを更新します。
使用方法
openstack alarm update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <NAME>] [-t <TYPE>] [--project-id <PROJECT_ID>] [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--query <QUERY>] [--comparison-operator <OPERATOR>] [--evaluation-periods <EVAL_PERIODS>] [--threshold <THRESHOLD>] [--event-type <EVENT_TYPE>] [--granularity <GRANULARITY>] [--aggregation-method <AGGR_METHOD>] [--metric <METRIC>] [--resource-type <RESOURCE_TYPE>] [--resource-id <RESOURCE_ID>] [--composite-rule <COMPOSITE_RULE>] [<ALARM ID or NAME>]
表7.47 位置引数
値 | 概要 |
---|---|
<ALARM ID または NAME> | アラームの ID または名前。 |
表7.48 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <NAME> | アラームの名前 |
-t <TYPE>, --type <TYPE> | アラームのタイプ:event、composite、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold のいずれかです。 |
--project-id <PROJECT_ID> | アラームに関連付けるプロジェクト (管理ユーザーだけが設定可能) |
--user-id <USER_ID> | アラームに関連付けるユーザー (管理ユーザーだけが設定可能) |
--description <DESCRIPTION> | アラームのフリーテキストの説明 |
--state <STATE> | アラームの状態。以下のいずれか:[ok, alarm, insufficient data] |
--severity <SEVERITY> | アラームの重大度。以下のいずれか [low, moderate,critical] |
--enabled {True|False} | アラーム評価が有効な場合は true。 |
--alarm-action <Webhook URL> | 状態が alarm に切り替わったときに呼び出す URL。複数回使用できます。 |
--ok-action <Webhook URL> | 状態が ok に切り替わったときに呼び出す URL。複数回使用できます。 |
--insufficient-data-action <Webhook URL> | 状態が insufficient data に切り替わったときに呼び出す URL。複数回の使用が可能です。 |
--time-constraint <Time Constraint> | 評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]] です。 |
--repeat-actions {True|False} | アラームがターゲット状態にある時にアクションを繰り返し通知する場合は True |
表7.49 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表7.50 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表7.51 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表7.52 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
表7.53 common alarm rules
値 | 概要 |
---|---|
--query <QUERY> | アラームのイベントタイプ: key[op]data_type::value; list。data_type はオプションですが、指定する場合には、文字列、整数、浮動またはブール型にする必要があります。gnocchi_aggregation_by_resources_threshold タイプのアラーム: {"and": [{"=": {"ended_at": null}}, …]} のように、複雑なクエリー json 文字列を指定する必要があります。 |
--comparison-operator <OPERATOR> | 比較するオペレーター:[lt,le,eq,ne,ge,gt] のいずれか。 |
--evaluation-periods <EVAL_PERIODS> | 評価する期間の数 |
--threshold <THRESHOLD> | 評価するしきい値。 |
表7.54 event alarm
値 | 概要 |
---|---|
--event-type <EVENT_TYPE> | 評価対象のイベントタイプ |
表7.55 common gnocchi alarm rules
値 | 概要 |
---|---|
--granularity <GRANULARITY> | クエリーを行う時間範囲 (秒単位)。 |
--aggregation-method <AGGR_METHOD> | しきい値と比較する aggregation_method |
--metric <METRIC>, --metrics <METRIC> | アラームタイプに応じたメトリック ID または名前 |
表7.56 gnocchi resource threshold alarm
値 | 概要 |
---|---|
--resource-type <RESOURCE_TYPE> | リソースのタイプ。 |
--resource-id <RESOURCE_ID> | リソースの ID。 |
表7.57 composite alarm
値 | 概要 |
---|---|
--composite-rule <COMPOSITE_RULE> | Json 形式の複合しきい値ルール。形式として、"and"や"or" で gnocchi ルールを組み合わせた、ネスト化ディクショナリーを指定できます。形式例: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}。 |
第8章 アラーム
本章では、alarming
コマンドに含まれるコマンドについて説明します。
8.1. alarming capabilities list
アラームサービスの機能をリスト表示します。
使用方法
openstack alarming capabilities list [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
表8.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | 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] <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 | アプリケーション認証情報が他のアプリケーション認証情報および信頼を作成したり、削除したりできないようにします (これはデフォルトの動作です)。 |
表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] [--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 | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表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] [--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 | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表10.3 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表10.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表10.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第11章 baremetal
本章では、baremetal
コマンドに含まれるコマンドについて説明します。
11.1. baremetal allocation create
新規ベアメタルの割り当てを作成します。
使用方法
openstack baremetal allocation create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--resource-class RESOURCE_CLASS] [--trait TRAITS] [--candidate-node CANDIDATE_NODES] [--name NAME] [--uuid UUID] [--extra <key=value>] [--wait [<time-out>]] [--node NODE]
表11.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resource-class RESOURCE_CLASS | 要求するリソースクラス。 |
--trait TRAITS | 要求する特性。複数回指定できます。 |
--candidate-node CANDIDATE_NODES | この割り当て候補ノード。複数回指定できます。1 つ以上の指定した場合には、指定した候補ノードのみが割り当ての対象として考慮されます。 |
--name NAME | 割り当ての一意名。 |
--uuid UUID | 割り当ての UUID |
--extra <key=value> | 任意のキー/値のメタデータを記録します。複数回指定できます。 |
--wait [<time-out>] | 新しい割り当てがアクティブになるまで待機します。--wait を使用する場合に割り当て失敗するとエラーが返されます。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
--node NODE | すでにデプロイされている指定ノードからこの割り当てに対応します。通常の割り当てプロセスを回避します。 |
表11.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.3 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.4 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--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] [--limit <limit>] [--marker <allocation>] [--sort <key>[:<direction>]] [--node <node>] [--resource-class <resource_class>] [--state <state>] [--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> | この状態の割り当てのみをリスト表示します。 |
--long | 割り当ての詳細情報を表示します。 |
--fields <field> [<field> …] | 1 つ以上の割り当てフィールド。これらのフィールドのみがサーバーから取得されます。-- long が指定されている場合は使用できません。 |
表11.9 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.10 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.11 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.12 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.4. baremetal allocation set
ベアメタル割り当てプロパティーを設定します。
使用方法
openstack baremetal allocation set [-h] [--name <name>] [--extra <key=value>] <allocation>
表11.13 位置引数
値 | 概要 |
---|---|
<allocation> | 割り当ての名前または UUID |
表11.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | 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] [--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 | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表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] [--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 | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表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> | Json 形式のデプロイ手順。デプロイ手順が含まれるファイルへのパス、- (デプロイ手順が標準入力から読み取る)、または文字列になります。値は deploy-step ディクショナリーのリストである必要があります。各ディクショナリーには、interface、step、args および 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] [--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 | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表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> | Json 形式のデプロイ手順。デプロイ手順が含まれるファイルへのパス、- (デプロイ手順が標準入力から読み取る)、または文字列になります。値は deploy-step ディクショナリーのリストである必要があります。各ディクショナリーには、interface、step、args および 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] [--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 | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表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 | すべての変数名に接頭辞を追加します。 |
表11.91 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.24. baremetal driver passthru list
ドライバーで利用可能なベンダーパススルー方法をリスト表示します。
使用方法
openstack baremetal driver passthru list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <driver>
表11.92 位置引数
値 | 概要 |
---|---|
<driver> | ドライバーの名前。 |
表11.93 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.94 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.95 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.96 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.97 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.25. baremetal driver property list
ドライバープロパティーをリスト表示します。
使用方法
openstack baremetal driver property list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <driver>
表11.98 位置引数
値 | 概要 |
---|---|
<driver> | ドライバーの名前。 |
表11.99 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.100 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.101 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.102 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.103 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.26. baremetal driver raid property list
ドライバーの RAID 論理ネットワークプロパティーをリスト表示します。
使用方法
openstack baremetal driver raid property list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <driver>
表11.104 位置引数
値 | 概要 |
---|---|
<driver> | ドライバーの名前。 |
表11.105 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.106 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.107 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.108 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.109 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.27. baremetal driver show
ドライバーに関する情報を表示します。
使用方法
openstack baremetal driver show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <driver>
表11.110 位置引数
値 | 概要 |
---|---|
<driver> | ドライバーの名前。 |
表11.111 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.112 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.113 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.114 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.115 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.28. baremetal introspection abort
ノードのイントロスペクションの実行を中止します。
使用方法
openstack baremetal introspection abort [-h] node
表11.116 位置引数
値 | 概要 |
---|---|
node | ベアメタルノードの uuid または名前 |
表11.117 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.29. baremetal introspection data save
未加工のイントロスペクションデータを保存または表示します。
使用方法
openstack baremetal introspection data save [-h] [--file <filename>] node
表11.118 位置引数
値 | 概要 |
---|---|
node | ベアメタルノードの uuid または名前 |
表11.119 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--file <filename> | ダウンロードするイントロスペクションデータのファイル名 (デフォルト:stdout) |
11.30. baremetal introspection interface list
接続されたスイッチポート情報を含むインターフェイスデータをリスト表示します。
使用方法
openstack baremetal introspection interface list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--vlan VLAN] [--long | --fields <field> [<field> ...]] node_ident
表11.120 位置引数
値 | 概要 |
---|---|
node_ident | ベアメタルノードの uuid または名前 |
表11.121 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--vlan VLAN | この vlan ID 用に設定されたインターフェイスのみをリスト表示します。繰り返し使用できます。 |
--long | インターフェイスに関する詳細情報を表示します。 |
--fields <field> [<field> …] | 1 つ以上のフィールドを表示します。-- long が指定されている場合は使用できません。 |
表11.122 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.123 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.124 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.125 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.31. baremetal introspection interface show
接続されたスイッチポート情報が含まれるインターフェイスデータを表示します。
使用方法
openstack baremetal introspection interface show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--fields <field> [<field> ...]] node_ident interface
表11.126 位置引数
値 | 概要 |
---|---|
node_ident | ベアメタルノードの uuid または名前 |
interface | インターフェイス名 |
表11.127 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--fields <field> [<field> …] | 1 つ以上のフィールドを表示します。 |
表11.128 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.129 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.130 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.131 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.32. baremetal introspection list
イントロスペクションのステータスをリスト表示します。
使用方法
openstack baremetal introspection list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker MARKER] [--limit LIMIT]
表11.132 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--marker MARKER | 前のページにある最後の項目の UUID |
--limit LIMIT | 返す項目数 |
表11.133 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.134 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.135 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.136 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.33. baremetal introspection reprocess
保存されたイントロスペクションデータを再処理します。
使用方法
openstack baremetal introspection reprocess [-h] node
表11.137 位置引数
値 | 概要 |
---|---|
node | ベアメタルノードの uuid または名前 |
表11.138 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.34. baremetal introspection rule delete
イントロスペクションルールを削除します。
使用方法
openstack baremetal introspection rule delete [-h] uuid
表11.139 位置引数
値 | 概要 |
---|---|
uuid | ルールの uuid |
表11.140 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.35. baremetal introspection rule import
JSON/YAML ファイルから 1 つまたは複数のイントロスペクションルールをインポートします。
使用方法
openstack baremetal introspection rule import [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] file
表11.141 位置引数
値 | 概要 |
---|---|
file | インポートする JSON または yaml ファイル。1 つまたは複数のルールを含めることができます。 |
表11.142 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.143 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.144 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.145 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.146 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.36. baremetal introspection rule list
全イントロスペクションルールをリスト表示します。
使用方法
openstack baremetal introspection rule list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表11.147 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.148 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.149 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.150 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.151 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.37. baremetal introspection rule purge
すべてのイントロスペクションルールを破棄します。
使用方法
openstack baremetal introspection rule purge [-h]
表11.152 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.38. baremetal introspection rule show
イントロスペクションルールを表示します。
使用方法
openstack baremetal introspection rule show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] uuid
表11.153 位置引数
値 | 概要 |
---|---|
uuid | ルールの uuid |
表11.154 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.155 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.156 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.157 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.158 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.39. baremetal introspection start
イントロスペクションを開始します。
使用方法
openstack baremetal introspection start [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--wait] [--check-errors] node [node ...]
表11.159 位置引数
値 | 概要 |
---|---|
node | ベアメタルノードの uuid または名前 |
表11.160 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait | イントロスペクションが完了するまで待機します。結果は最後に表示されます。 |
--check-errors | イントロスペクション中にエラーが発生しているかどうかを確認します。エラーが発生した場合は、エラーのみが表示されます。--wait と併用しないと使用できません。 |
表11.161 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.162 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.163 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.164 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.40. baremetal introspection status
イントロスペクションのステータスを取得します。
使用方法
openstack baremetal introspection status [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] node
表11.165 位置引数
値 | 概要 |
---|---|
node | ベアメタルノードの uuid または名前 |
表11.166 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.167 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.168 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.169 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.170 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.41. baremetal node abort
ベアメタルノードのプロビジョニング状態を abort に設定します。
使用方法
openstack baremetal node abort [-h] <node>
表11.171 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.172 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.42. baremetal node add trait
ノードに特性を追加します。
使用方法
openstack baremetal node add trait [-h] <node> <trait> [<trait> ...]
表11.173 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
<trait> | 追加する特性 |
表11.174 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.43. baremetal node adopt
ベアメタルノードのプロビジョニング状態を adopt に設定します。
使用方法
openstack baremetal node adopt [-h] [--wait [<time-out>]] <node>
表11.175 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.176 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait [<time-out>] | ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
11.44. baremetal node bios setting list
ノードの BIOS 設定をリスト表示します。
使用方法
openstack baremetal node bios setting list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <node>
表11.177 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表11.178 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.179 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.180 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.181 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.182 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.45. baremetal node bios setting show
ノードの特定の BIOS 設定を表示します。
使用方法
openstack baremetal node bios setting show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <node> <setting name>
表11.183 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
<setting name> | 表示する名前の設定 |
表11.184 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.185 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.186 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.187 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.188 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.46. baremetal node boot device set
ノードのブートデバイスを設定します。
使用方法
openstack baremetal node boot device set [-h] [--persistent] <node> <device>
表11.189 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
<device> | Bios、cdrom、disk、pxe、safe、wanboot のいずれか |
表11.190 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--persistent | 今後の起動時にすべての変更を永続化します。 |
11.47. baremetal node boot device show
ノードのブートデバイス情報を表示します。
使用方法
openstack baremetal node boot device show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--supported] <node>
表11.191 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表11.192 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--supported | サポート対象のブートデバイスを表示します。 |
表11.193 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.194 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.195 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.196 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.48. baremetal node clean
ベアメタルノードのプロビジョニング状態を clean に設定します。
使用方法
openstack baremetal node clean [-h] [--wait [<time-out>]] --clean-steps <clean-steps> <node>
表11.197 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.198 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait [<time-out>] | ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
--clean-steps <clean-steps> | Json 形式の消去手順。消去手順が含まれるファイルへのパス、- (消去手順が標準入力から読み取る)、または文字列になります。値は clean-step ディクショナリーのリストである必要があります。各ディクショナリーには、キーの interface および step、任意のキーの args が必要です。 |
11.49. baremetal node console disable
ノードのコンソールアクセスを無効化します。
使用方法
openstack baremetal node console disable [-h] <node>
表11.199 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表11.200 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.50. baremetal node console enable
ノードのコンソールアクセスを有効化します。
使用方法
openstack baremetal node console enable [-h] <node>
表11.201 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表11.202 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.51. baremetal node console show
ノードのコンソール情報を表示します。
使用方法
openstack baremetal node console show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <node>
表11.203 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表11.204 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.205 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.206 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.207 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.208 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.52. baremetal node create
新規ノードを baremetal サービスに登録します。
使用方法
openstack baremetal node create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--chassis-uuid <chassis>] --driver <driver> [--driver-info <key=value>] [--property <key=value>] [--extra <key=value>] [--uuid <uuid>] [--name <name>] [--bios-interface <bios_interface>] [--boot-interface <boot_interface>] [--console-interface <console_interface>] [--deploy-interface <deploy_interface>] [--inspect-interface <inspect_interface>] [--management-interface <management_interface>] [--network-interface <network_interface>] [--power-interface <power_interface>] [--raid-interface <raid_interface>] [--rescue-interface <rescue_interface>] [--storage-interface <storage_interface>] [--vendor-interface <vendor_interface>] [--resource-class <resource_class>] [--conductor-group <conductor_group>] [--automated-clean] [--owner <owner>] [--description <description>]
表11.209 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--chassis-uuid <chassis> | このノードが属するシャーシの UUID。 |
--driver <driver> | ノードの制御に使用されるドライバー [必須]。 |
--driver-info <key=value> | アウトバウンド管理認証情報など、ドライバーが使用するキー/値のペア。複数回指定できます。 |
--property <key=value> | ノードの物理的な特性を記述するキー/値のペア。これは Nova にエクスポートされ、スケジューラーが使用します。複数回指定できます。 |
--extra <key=value> | 任意のキー/値のメタデータを記録します。複数回指定できます。 |
--uuid <uuid> | ノードの一意の UUID。 |
--name <name> | ノードの一意名。 |
--bios-interface <bios_interface> | ノードのドライバーで使用される BIOS インターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--boot-interface <boot_interface> | ノードのドライバーで使用される起動インターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--console-interface <console_interface> | ノードのドライバーで使用されるコンソールインターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--deploy-interface <deploy_interface> | ノードのドライバーで使用されるデプロイインターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--inspect-interface <inspect_interface> | ノードのドライバーで使用されるインスペクトインターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--management-interface <management_interface> | ノードのドライバーで使用される管理インターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--network-interface <network_interface> | クリーニング/プロビジョニングネットワークへのノードの切り替えに使用するネットワークインターフェイス |
--power-interface <power_interface> | ノードのドライバーで使用される電源インターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--raid-interface <raid_interface> | ノードのドライバーで使用される RAID インターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--rescue-interface <rescue_interface> | ノードのドライバーで使用されるレスキューインターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--storage-interface <storage_interface> | ノードのドライバーが使用するストレージインターフェイス。 |
--vendor-interface <vendor_interface> | ノードのドライバーで使用されるベンダーインターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--resource-class <resource_class> | ノードを nova フレーバーにマッピングするためのリソースクラス |
--conductor-group <conductor_group> | ノードが所属するコンダクターグループ |
--automated-clean | ノードの自動クリーニングを有効化します。 |
--owner <owner> | ノードの所有者。 |
--description <description> | ノードの説明。 |
表11.210 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.211 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.212 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.213 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.53. baremetal node delete
ベアメタルノードの登録を解除します。
使用方法
openstack baremetal node delete [-h] <node> [<node> ...]
表11.214 位置引数
値 | 概要 |
---|---|
<node> | 削除するノード (名前または uuid) |
表11.215 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.54. baremetal node deploy
ベアメタルノードのプロビジョニングの状態を deploy に設定します。
使用方法
openstack baremetal node deploy [-h] [--wait [<time-out>]] [--config-drive <config-drive>] <node>
表11.216 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.217 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait [<time-out>] | ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
--config-drive <config-drive> |
Gzipped, base64 でエンコードされたコンフィグドライブの文字列、またはコンフィグドライブファイルへのパス、コンフィグドライブファイルが含まれるパス、コンフィグドライブのビルド元の JSON オブジェクト。ディレクトリーの場合には、コンフィグドライブはそのディレクトリーで生成されます。JSON オブジェクトに、オプションのキー |
11.55. baremetal node inject nmi
NMI をベアメタルノードに注入します。
使用方法
openstack baremetal node inject nmi [-h] <node>
表11.218 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.219 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.56. baremetal node inspect
ベアメタルノードのプロビジョニング状態を inspect に設定します。
使用方法
openstack baremetal node inspect [-h] [--wait [<time-out>]] <node>
表11.220 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.221 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait [<time-out>] | ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
11.57. baremetal node list
ベアメタルノードをリスト表示します。
使用方法
openstack baremetal node list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--limit <limit>] [--marker <node>] [--sort <key>[:<direction>]] [--maintenance | --no-maintenance] [--fault <fault>] [--associated | --unassociated] [--provision-state <provision state>] [--driver <driver>] [--resource-class <resource class>] [--conductor-group <conductor_group>] [--conductor <conductor>] [--chassis <chassis UUID>] [--owner <owner>] [--description-contains <description_contains>] [--long | --fields <field> [<field> ...]]
表11.222 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit <limit> | 要求ごとに返すノードの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。 |
--marker <node> | ノードの uuid(例: 以前の要求リストにある最後のノード)。UUID の後にノードのリストを返します。 |
--sort <key>[:<direction>] | 指定したノードフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。 |
--maintenance | メンテナンスモードのノードだけにリストを制限します。 |
--no-maintenance | メンテナンスモード以外のノードだけにリストを制限します。 |
--fault <fault> | 指定した障害でが発生しているノードをリスト表示します。 |
--associated | インスタンスに関連付けられているノードのみをリスト表示します。 |
--unassociated | インスタンスに関連付けられていないノードのみをリスト表示します。 |
--provision-state <provision state> | 指定したプロビジョニング状態のノードをリスト表示します。 |
--driver <driver> | ドライバーが <driver> のノードのみにリストを制限します。 |
--resource-class <resource class> | リソースクラスが <resource class> のノードのみにリストを制限します。 |
--conductor-group <conductor_group> | コンダクターグループが <conductor group> のノードのみにリストを制限します。 |
--conductor <conductor> | コンダクターが <conductor> のノードのみにリストを制限します。 |
--chassis <chassis UUID> | このシャーシのノードのみにリストを制限します。 |
--owner <owner> | 所有者が <owner> のノードのみにリストを制限します。 |
--description-contains <description_contains> | 説明に <description_contains> が含まれるノードのみにリストを制限します。 |
--long | ノードの詳細情報を表示します。 |
--fields <field> [<field> …] | 1 つ以上のノードフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。 |
表11.223 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.224 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.225 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.226 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.58. baremetal node maintenance set
ベアメタルノードをメンテナンスモードに設定します。
使用方法
openstack baremetal node maintenance set [-h] [--reason <reason>] <node>
表11.227 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.228 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--reason <reason> | メンテナンスモードを設定する理由。 |
11.59. baremetal node maintenance unset
メンテナンスモードのベアメタルノードの設定を解除します。
使用方法
openstack baremetal node maintenance unset [-h] <node>
表11.229 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.230 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.60. baremetal node manage
ベアメタルノードのプロビジョニングの状態を manage に設定します。
使用方法
openstack baremetal node manage [-h] [--wait [<time-out>]] <node>
表11.231 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.232 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait [<time-out>] | ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
11.61. baremetal node passthru call
ノードのベンダーパススルーメソッドを呼び出します。
使用方法
openstack baremetal node passthru call [-h] [--arg <key=value>] [--http-method <http-method>] <node> <method>
表11.233 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
<method> | 実行するベンダーパススルーメソッド |
表11.234 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--arg <key=value> | Passthru メソッドに渡す引数 (複数の引数を指定する場合は、オプションを繰り返し使用します)。 |
--http-method <http-method> | パススルー要求で使用する http メソッド。DELETE、GET、PATCH、POST、PUT のいずれか。デフォルトは POST です。 |
11.62. baremetal node passthru list
ノードのベンダーパススルー方法をリスト表示します。
使用方法
openstack baremetal node passthru list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <node>
表11.235 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表11.236 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.237 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.238 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.239 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.240 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.63. baremetal node power off
ノードの電源をオフにします。
使用方法
openstack baremetal node power off [-h] [--power-timeout <power-timeout>] [--soft] <node>
表11.241 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.242 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--power-timeout <power-timeout> | エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間 (秒単位、正の整数)。 |
--soft | 正常な電源オフを要求します。 |
11.64. baremetal node power on
ノードの電源をオンにします。
使用方法
openstack baremetal node power on [-h] [--power-timeout <power-timeout>] <node>
表11.243 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.244 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--power-timeout <power-timeout> | エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間 (秒単位、正の整数)。 |
11.65. baremetal node provide
ベアメタルノードのプロビジョニングの状態を provide に設定します。
使用方法
openstack baremetal node provide [-h] [--wait [<time-out>]] <node>
表11.245 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.246 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait [<time-out>] | ノードが必要な状態 (available) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
11.66. baremetal node reboot
ベアメタルノードを再起動します。
使用方法
openstack baremetal node reboot [-h] [--soft] [--power-timeout <power-timeout>] <node>
表11.247 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.248 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--soft | 正常な再起動を要求します。 |
--power-timeout <power-timeout> | エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間 (秒単位、正の整数)。 |
11.67. baremetal node rebuild
ベアメタルノードのプロビジョニングの状態を rebuild に設定します。
使用方法
openstack baremetal node rebuild [-h] [--wait [<time-out>]] [--config-drive <config-drive>] <node>
表11.249 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.250 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait [<time-out>] | ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
--config-drive <config-drive> |
Gzipped, base64 でエンコードされたコンフィグドライブの文字列、またはコンフィグドライブファイルへのパス、コンフィグドライブファイルが含まれるパス、コンフィグドライブのビルド元の JSON オブジェクト。ディレクトリーの場合には、コンフィグドライブはそのディレクトリーで生成されます。JSON オブジェクトに、オプションのキー |
11.68. baremetal node remove trait
ノードから特性を削除します。
使用方法
openstack baremetal node remove trait [-h] [--all] <node> [<trait> [<trait> ...]]
表11.251 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
<trait> | 削除する特性 |
表11.252 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all | すべての特性を削除します。 |
11.69. baremetal node rescue
ベアメタルノードのプロビジョニングの状態を rescue に設定します。
使用方法
openstack baremetal node rescue [-h] [--wait [<time-out>]] --rescue-password <rescue-password> <node>
表11.253 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.254 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait [<time-out>] | ノードが必要な状態 (rescue) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
--rescue-password <rescue-password> | Rescue ramdisk へのログインに使用するパスワード。値は空でない文字列である必要があります。 |
11.70. baremetal node set
ベアメタルのプロパティーを設定します。
使用方法
openstack baremetal node set [-h] [--instance-uuid <uuid>] [--name <name>] [--chassis-uuid <chassis UUID>] [--driver <driver>] [--bios-interface <bios_interface> | --reset-bios-interface] [--boot-interface <boot_interface> | --reset-boot-interface] [--console-interface <console_interface> | --reset-console-interface] [--deploy-interface <deploy_interface> | --reset-deploy-interface] [--inspect-interface <inspect_interface> | --reset-inspect-interface] [--management-interface <management_interface> | --reset-management-interface] [--network-interface <network_interface> | --reset-network-interface] [--power-interface <power_interface> | --reset-power-interface] [--raid-interface <raid_interface> | --reset-raid-interface] [--rescue-interface <rescue_interface> | --reset-rescue-interface] [--storage-interface <storage_interface> | --reset-storage-interface] [--vendor-interface <vendor_interface> | --reset-vendor-interface] [--reset-interfaces] [--resource-class <resource_class>] [--conductor-group <conductor_group>] [--automated-clean] [--protected] [--protected-reason <protected_reason>] [--target-raid-config <target_raid_config>] [--property <key=value>] [--extra <key=value>] [--driver-info <key=value>] [--instance-info <key=value>] [--owner <owner>] [--description <description>] <node>
表11.255 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.256 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--instance-uuid <uuid> | ノードのインスタンスの uuid を <uuid> に設定します。 |
--name <name> | ノードの名前。 |
--chassis-uuid <chassis UUID> | ノードのシャーシを設定します。 |
--driver <driver> | ノードのドライバーを設定します。 |
--bios-interface <bios_interface> | ノードの bios インターフェイスを設定します。 |
--reset-bios-interface | BIOS インターフェイスをハードウェアタイプのデフォルトにリセットします。 |
--boot-interface <boot_interface> | ノードの起動インターフェイスを設定します。 |
--reset-boot-interface | 起動インターフェイスをハードウェアタイプのデフォルトにリセットします。 |
--console-interface <console_interface> | ノードのコンソールインターフェイスを設定します。 |
--reset-console-interface | コンソールインターフェイスをハードウェアタイプのデフォルトにリセットします。 |
--deploy-interface <deploy_interface> | ノードのデプロイインターフェイスを設定します。 |
--reset-deploy-interface | デプロイインターフェイスをハードウェアタイプのデフォルトにリセットします。 |
--inspect-interface <inspect_interface> | ノードの検査インターフェイスを設定します。 |
--reset-inspect-interface | 検査インターフェイスをハードウェアタイプのデフォルトにリセットします。 |
--management-interface <management_interface> | ノードの管理インターフェイスを設定します。 |
--reset-management-interface | 管理インターフェイスをハードウェアタイプのデフォルトにリセットします。 |
--network-interface <network_interface> | ノードのネットワークインターフェイスを設定します。 |
--reset-network-interface | ネットワークインターフェイスをハードウェアタイプのデフォルトにリセットします。 |
--power-interface <power_interface> | ノードの電源インターフェイスを設定します。 |
--reset-power-interface | 電源インターフェイスをハードウェアタイプのデフォルトにリセットします。 |
--raid-interface <raid_interface> | ノードの RAID インターフェイスを設定します。 |
--reset-raid-interface | RAID インターフェイスをハードウェアタイプのデフォルトにリセットします。 |
--rescue-interface <rescue_interface> | ノードのレスキューインターフェイスを設定します。 |
--reset-rescue-interface | レスキューインターフェイスをハードウェアタイプのデフォルトにリセットします。 |
--storage-interface <storage_interface> | ノードのストレージインターフェイスを設定します。 |
--reset-storage-interface | ストレージインターフェイスのハードウェアタイプのデフォルトにリセットします。 |
--vendor-interface <vendor_interface> | ノードのベンダーインターフェイスを設定します。 |
--reset-vendor-interface | ベンダーインターフェイスをハードウェアタイプのデフォルトにリセットします。 |
--reset-interfaces | 明示的に指定されていないすべてのインターフェイスをデフォルトの実装にリセットします。--driver と併用する場合のみ有効です。 |
--resource-class <resource_class> | ノードのリソースクラスを設定します。 |
--conductor-group <conductor_group> | ノードのコンダクターグループを設定します。 |
--automated-clean | ノードの自動クリーニングを有効化します。 |
--protected | ノードを保護するとマークします。 |
--protected-reason <protected_reason> | ノードを保護するとマークする理由を設定します。 |
--target-raid-config <target_raid_config> | ノードのターゲット RAID 設定 (json) を設定します。これには、以下のいずれかを使用できます。1. RAID 設定の JSON データを含むファイル、2. 標準入力からコンテンツを読み取る "-"、3、有効な JSON 文字列。 |
--property <key=value> | このベアメタルノードに設定するプロパティー (複数のプロパティーを設定する場合はオプションを繰り返し使用します) |
--extra <key=value> | このベアメタルノードに設定する追加項目 (複数のプロパティーを設定する場合はオプションを繰り返し使用します) |
--driver-info <key=value> | このベアメタルノードに設定するドライバー情報 (複数のドライバー情報を設定する場合はオプションを繰り返し使用します) |
--instance-info <key=value> | このベアメタルノードに設定するインスタンス情報 (複数のインスタンス情報を設定する場合はオプションを繰り返し使用します) |
--owner <owner> | ノードの所有者を設定します。 |
--description <description> | ノードの説明を設定します。 |
11.71. baremetal node show
ベアメタルノードの詳細を表示します。
使用方法
openstack baremetal node show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--instance] [--fields <field> [<field> ...]] <node>
表11.257 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または uuid(または --instance が指定されている場合のインスタンスの uuid) |
表11.258 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--instance | <node> はインスタンスの uuid です。 |
--fields <field> [<field> …] | 1 つ以上のノードフィールド。これらのフィールドのみがサーバーから取得されます。 |
表11.259 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.260 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.261 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.262 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.72. baremetal node trait list
ノードの特性をリスト表示します。
使用方法
openstack baremetal node trait list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <node>
表11.263 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表11.264 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.265 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.266 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.267 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.268 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.73. baremetal node undeploy
ベアメタルノードのプロビジョニングの状態を deleted に設定します。
使用方法
openstack baremetal node undeploy [-h] [--wait [<time-out>]] <node>
表11.269 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.270 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait [<time-out>] | ノードが必要な状態 (available) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
11.74. baremetal node unrescue
ベアメタルノードのプロビジョニング状態を unrescue に設定します。
使用方法
openstack baremetal node unrescue [-h] [--wait [<time-out>]] <node>
表11.271 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.272 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait [<time-out>] | ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
11.75. baremetal node unset
ベアメタルプロパティーの設定を解除します。
使用方法
openstack baremetal node unset [-h] [--instance-uuid] [--name] [--resource-class] [--target-raid-config] [--property <key>] [--extra <key>] [--driver-info <key>] [--instance-info <key>] [--chassis-uuid] [--bios-interface] [--boot-interface] [--console-interface] [--deploy-interface] [--inspect-interface] [--management-interface] [--network-interface] [--power-interface] [--raid-interface] [--rescue-interface] [--storage-interface] [--vendor-interface] [--conductor-group] [--automated-clean] [--protected] [--protected-reason] [--owner] [--description] <node>
表11.273 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表11.274 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--instance-uuid | このベアメタルノードでのインスタンスの uuid の設定を解除します。 |
--name | ノードの名前の設定を解除します。 |
--resource-class | ノードのリソースクラスの設定を解除します。 |
--target-raid-config | ノードのターゲット RAID 設定の設定を解除します。 |
--property <key> | このベアメタルノードで設定を解除するプロパティー (複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します) |
--extra <key> | このベアメタルノードの設定を追加で解除する項目 (複数のプロパティーを設定する場合はオプションを繰り返し使用します) |
--driver-info <key> | このベアメタルノードでの設定を解除するドライバー情報 (複数のドライバー情報の設定を解除する場合はオプションを繰り返し使用します) |
--instance-info <key> | このベアメタルノードでの設定を解除するインスタンス情報 (複数のインスタンス情報の設定を解除する場合はオプションを繰り返し使用します) |
--chassis-uuid | このベアメタルノードでのシャーシ UUID の設定を解除します。 |
--bios-interface | このベアメタルノードでの bios インターフェイスの設定を解除します。 |
--boot-interface | このベアメタルノードでのブートインターフェイスの設定を解除します。 |
--console-interface | このベアメタルノードでのコンソールインターフェイスの設定を解除します。 |
--deploy-interface | このベアメタルノードでのデプロイインターフェイスの設定を解除します。 |
--inspect-interface | このベアメタルノードでの検査インターフェイスの設定を解除します。 |
--management-interface | このベアメタルノードでの管理インターフェイスの設定を解除します。 |
--network-interface | このベアメタルノードでのネットワークインターフェイスの設定を解除します。 |
--power-interface | このベアメタルノードの電源インターフェイスの設定を解除します。 |
--raid-interface | このベアメタルノードでの RAID インターフェイスの設定を解除します。 |
--rescue-interface | このベアメタルノードでのレスキューインターフェイスの設定を解除します。 |
--storage-interface | このベアメタルノードでのストレージインターフェイスの設定を解除します。 |
--vendor-interface | このベアメタルノードでのベンダーインターフェイスの設定を解除します。 |
--conductor-group | このベアメタルノードのコンダクターグループの設定を解除します (デフォルトのグループが使用されます)。 |
--automated-clean | このベアメタルノードでの自動クリーニングの設定を解除します (設定からの値が使用されます)。 |
--protected | ノード上の保護フラグの設定を解除します。 |
--protected-reason | 保護理由の設定を解除します (保護が解除されると自動的にこの設定も解除されます。) |
--owner | ノードの所有者フィールドの設定を解除します。 |
--description | ノードの説明フィールドの設定を解除します。 |
11.76. baremetal node validate
ノードのドライバーインターフェイスを検証します。
使用方法
openstack baremetal node validate [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <node>
表11.275 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表11.276 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.277 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.278 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.279 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.280 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.77. baremetal node vif attach
VIF を指定ノードに接続します。
使用方法
openstack baremetal node vif attach [-h] [--vif-info <key=value>] <node> <vif-id>
表11.281 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
<vif-id> | ノードに割り当てる vif の名前または UUID。 |
表11.282 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
--vif-info <key=value> | 任意のキー/値のメタデータを記録します。複数回指定できます。必須の id パラメーターはキーとして指定できません。 |
11.78. baremetal node vif detach
指定のノードから VIF を切断します。
使用方法
openstack baremetal node vif detach [-h] <node> <vif-id>
表11.283 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
<vif-id> | ノードから切り離す vif の名前または UUID。 |
表11.284 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.79. baremetal node vif list
ノードに接続された VIF を表示します。
使用方法
openstack baremetal node vif list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <node>
表11.285 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表11.286 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表11.287 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.288 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.289 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.290 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.80. baremetal port create
新規ポートの作成
使用方法
openstack baremetal port create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --node <uuid> [--uuid <uuid>] [--extra <key=value>] [--local-link-connection <key=value>] [-l <key=value>] [--pxe-enabled <boolean>] [--port-group <uuid>] [--physical-network <physical network>] [--is-smartnic] <address>
表11.291 位置引数
値 | 概要 |
---|---|
<address> | このポートの MAC アドレス。 |
表11.292 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--node <uuid> | このポートが属するノードの UUID。 |
--uuid <uuid> | ポートの UUID |
--extra <key=value> | 任意のキー/値のメタデータを記録します。引数は複数回指定できます。 |
--local-link-connection <key=value> | ローカルリンク接続情報を記述するキー/値のメタデータ。有効なキーは switch_info、switch_id、port_id、および hostname です。switch_id と port_id キーは必須です。スマート NIC ポートの場合に、必要なキーは port_id と hostname です。引数は、複数回指定できます。 |
-l <key=value> | 非推奨です。代わりに --local-link-connection を使用してください。ローカルリンク接続情報を記述するキー/値のメタデータ。有効なキーは switch_info、switch_id、および port_id です。switch_id と port_id キーは必須です。複数回指定できます。 |
--pxe-enabled <boolean> | このノードの PXE の起動時にこのポートを使用するかどうかを指定します。 |
--port-group <uuid> | このポートが属するポートグループの UUID。 |
--physical-network <physical network> | このポートを接続する物理ネットワークの名前。 |
--is-smartnic | このポートがスマート NIC ポートであるかどうかを指定します。 |
表11.293 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.294 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.295 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.296 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.81. baremetal port delete
ポートを削除します。
使用方法
openstack baremetal port delete [-h] <port> [<port> ...]
表11.297 位置引数
値 | 概要 |
---|---|
<port> | 削除するポートの UUID |
表11.298 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.82. baremetal port group create
新規ベアメタルポートグループを作成します。
使用方法
openstack baremetal port group create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --node <uuid> [--address <mac-address>] [--name NAME] [--uuid UUID] [--extra <key=value>] [--mode MODE] [--property <key=value>] [--support-standalone-ports | --unsupport-standalone-ports]
表11.299 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--node <uuid> | このポートグループが属するノードの UUID。 |
--address <mac-address> | このポートグループの MAC アドレス。 |
--name NAME | ポートグループの名前。 |
--uuid UUID | ポートグループの UUID |
--extra <key=value> | 任意のキー/値のメタデータを記録します。複数回指定できます。 |
--mode MODE | ポートグループのモード。使用できる値は https://www.kernel.org/doc/Documentation/networking/bo nding.txt を参照してください。 |
--property <key=value> | このポートグループの設定に関連するキー/値プロパティー。複数回指定できます。 |
--support-standalone-ports | このポートグループのメンバーであるポートはスタンドアロンのポートとして使用できます (デフォルト)。 |
--unsupport-standalone-ports | このポートグループのメンバーであるポートは、スタンドアロンのポートとしては使用できません。 |
表11.300 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.301 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.302 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.303 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.83. baremetal port group delete
ベアメタルポートグループの登録を解除します。
使用方法
openstack baremetal port group delete [-h] <port group> [<port group> ...]
表11.304 位置引数
値 | 概要 |
---|---|
<port group> | 削除するポートグループ (名前または UUID)。 |
表11.305 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.84. baremetal port group list
ベアメタルポートグループをリスト表示します。
使用方法
openstack baremetal port group list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--limit <limit>] [--marker <port group>] [--sort <key>[:<direction>]] [--address <mac-address>] [--node <node>] [--long | --fields <field> [<field> ...]]
表11.306 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit <limit> | 要求ごとに返すポートグループの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。 |
--marker <port group> | ポートグループの uuid (以前の要求リストにある最後のポートグループなど)。この UUID の後にポートグループのリストを返します。 |
--sort <key>[:<direction>] | 指定したポートグループのフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。 |
--address <mac-address> | この mac アドレスのポートグループに関する情報のみを表示します。 |
--node <node> | このノードのポートグループ (名前または UUID) のみをリスト表示します。 |
--long | ポートグループの詳細情報を表示します。 |
--fields <field> [<field> …] | 1 つ以上のポートグループフィールド。これらのフィールドのみがサーバーから取得されます。-- long が指定されている場合は使用できません。 |
表11.307 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.308 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.309 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.310 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.85. baremetal port group set
ベアメタルポートグループプロパティーを設定します。
使用方法
openstack baremetal port group set [-h] [--node <uuid>] [--address <mac-address>] [--name <name>] [--extra <key=value>] [--mode MODE] [--property <key=value>] [--support-standalone-ports | --unsupport-standalone-ports] <port group>
表11.311 位置引数
値 | 概要 |
---|---|
<port group> | ポートグループの名前または UUID。 |
表11.312 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--node <uuid> | このポートグループが属するノードの uuid を更新します。 |
--address <mac-address> | このポートグループの MAC アドレス。 |
--name <name> | ポートグループの名前。 |
--extra <key=value> | このベアメタルポートグループに設定する追加項目 (複数の項目を設定する場合はオプションを繰り返し使用します) |
--mode MODE | ポートグループのモード。使用できる値は https://www.kernel.org/doc/Documentation/networking/bo nding.txt を参照してください。 |
--property <key=value> | このポートグループの設定に関連するキー/値プロパティー (複数のプロパティーを設定する場合は、オプションを繰り返し使用します)。 |
--support-standalone-ports | このポートグループのメンバーであるポートは、スタンドアロンのポートとして使用できます。 |
--unsupport-standalone-ports | このポートグループのメンバーであるポートは、スタンドアロンのポートとしては使用できません。 |
11.86. baremetal port group show
ベアメタルポートグループの詳細を表示します。
使用方法
openstack baremetal port group show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--address] [--fields <field> [<field> ...]] <id>
表11.313 位置引数
値 | 概要 |
---|---|
<id> | ポートグループの UUID または名前 (または --address が指定されている場合は mac アドレス)。 |
表11.314 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--address | <id> は、ポートグループの mac アドレス (uuid または name ではなく) です。 |
--fields <field> [<field> …] | 1 つ以上のポートグループフィールド。これらのフィールドのみがサーバーから取得されます。 |
表11.315 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.316 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.317 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.318 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.87. baremetal port group unset
ベアメタルポートグループプロパティーの設定を解除します。
使用方法
openstack baremetal port group unset [-h] [--name] [--address] [--extra <key>] [--property <key>] <port group>
表11.319 位置引数
値 | 概要 |
---|---|
<port group> | ポートグループの名前または UUID。 |
表11.320 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name | ポートグループの名前の設定を解除します。 |
--address | ポートグループのアドレスを解除します。 |
--extra <key> | このベアメタルポートグループで追加で設定を解除する項目 (複数の項目の設定を解除する場合はオプションを繰り返し使用します) |
--property <key> | このベアメタルポートグループで設定を解除するプロパティー (複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します) |
11.88. baremetal port list
ベアメタルポートをリスト表示します。
使用方法
openstack baremetal port list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--address <mac-address>] [--node <node>] [--port-group <port group>] [--limit <limit>] [--marker <port>] [--sort <key>[:<direction>]] [--long | --fields <field> [<field> ...]]
表11.321 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--address <mac-address> | この mac アドレスのポートに関する情報のみを表示します。 |
--node <node> | このノードのポート (名前または UUID) のみをリスト表示します。 |
--port-group <port group> | このポートグループのポートのみをリスト表示します (名前または UUID)。 |
--limit <limit> | 要求ごとに返すポートの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。 |
--marker <port> | ポート uuid(以前の要求リストにある最後のポートなど)。この UUID の後にポートのリストを返します。 |
--sort <key>[:<direction>] | 指定したポートフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。 |
--long | ポートの詳細情報を表示します。 |
--fields <field> [<field> …] | 1 つ以上のポートフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。 |
表11.322 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.323 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.324 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.325 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.89. baremetal port set
ベアメタルポートのプロパティーを設定します。
使用方法
openstack baremetal port set [-h] [--node <uuid>] [--address <address>] [--extra <key=value>] [--port-group <uuid>] [--local-link-connection <key=value>] [--pxe-enabled | --pxe-disabled] [--physical-network <physical network>] [--is-smartnic] <port>
表11.326 位置引数
値 | 概要 |
---|---|
<port> | ポートの UUID |
表11.327 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--node <uuid> | このポートが属するノードの uuid を設定します。 |
--address <address> | このポートの mac アドレスを設定します。 |
--extra <key=value> | このベアメタルポートグループに設定する追加項目 (複数の項目を設定する場合はオプションを繰り返し使用します) |
--port-group <uuid> | このポートが属するポートグループの uuid を設定します。 |
--local-link-connection <key=value> | ローカルリンク接続情報を記述するキー/値のメタデータ。有効なキーは switch_info、switch_id、port_id、および hostname です。switch_id と port_id キーは必須です。スマート NIC ポートの場合に、必要なキーは port_id と hostname です。引数は、複数回指定できます。 |
--pxe-enabled | このノードの PXE の起動時にこのポートを使用するかどうかを指定します。 |
--pxe-disabled | このノードの PXE の起動時にこのポートを使用しないように指定します。 |
--physical-network <physical network> | このポートを接続する物理ネットワークの名前を設定します。 |
--is-smartnic | ポートをスマート NIC ポートに設定します。 |
11.90. baremetal port show
ベアメタルポートの詳細を表示します。
使用方法
openstack baremetal port show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--address] [--fields <field> [<field> ...]] <id>
表11.328 位置引数
値 | 概要 |
---|---|
<id> | ポートの UUID(--address が指定されている場合は mac アドレス)。 |
表11.329 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--address | <id> はポートの (uuid ではなく)mac アドレスです。 |
--fields <field> [<field> …] | 1 つ以上のポートフィールド。これらのフィールドのみがサーバーから取得されます。 |
表11.330 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.331 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.332 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.333 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.91. baremetal port unset
ベアメタルポートのプロパティーの設定を解除します。
使用方法
openstack baremetal port unset [-h] [--extra <key>] [--port-group] [--physical-network] [--is-smartnic] <port>
表11.334 位置引数
値 | 概要 |
---|---|
<port> | ポートの UUID |
表11.335 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--extra <key> | このベアメタルポートの設定を追加で解除する項目 (複数のプロパティーを設定する場合はオプションを繰り返し使用します) |
--port-group | ポートグループからポートを削除します。 |
--physical-network | このベアメタルポートで物理ネットワークの設定を解除します。 |
--is-smartnic | ポートをスマート NIC ポートとして設定します。 |
11.92. baremetal volume connector create
新しいベアメタルのボリュームコネクターを作成します。
使用方法
openstack baremetal volume connector create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --node <uuid> --type <type> --connector-id <connector id> [--uuid <uuid>] [--extra <key=value>]
表11.336 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--node <uuid> | このボリュームコネクターが属するノードの UUID。 |
--type <type> | ボリュームコネクターの種類。iqn、ip、mac、wwnn、wwpn、port、portgroup。 |
--connector-id <connector id> | 指定のタイプのボリュームコネクター ID。たとえば、タイプが iqn の場合は、ノードの iSCSI イニシエーター IQN。 |
--uuid <uuid> | ボリュームコネクターの UUID。 |
--extra <key=value> | 任意のキー/値のメタデータを記録します。複数回指定できます。 |
表11.337 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.338 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.339 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.340 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.93. baremetal volume connector delete
ベアメタルボリュームコネクターの登録を解除します。
使用方法
openstack baremetal volume connector delete [-h] <volume connector> [<volume connector> ...]
表11.341 位置引数
値 | 概要 |
---|---|
<volume connector> | 削除するボリュームコネクターの UUID |
表11.342 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.94. baremetal volume connector list
ベアメタルボリュームコネクターをリスト表示します。
使用方法
openstack baremetal volume connector list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--node <node>] [--limit <limit>] [--marker <volume connector>] [--sort <key>[:<direction>]] [--long | --fields <field> [<field> ...]]
表11.343 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--node <node> | このノードのボリュームコネクター (名前または UUID) のみをリスト表示します。 |
--limit <limit> | 要求ごとに返すボリュームの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。 |
--marker <volume connector> | ボリュームコネクター UUID(以前の要求リストにある最後のボリュームコネクターなど)。この UUID の後にボリュームコネクターのリストを返します。 |
--sort <key>[:<direction>] | 指定したボリュームコネクターのフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。 |
--long | ボリュームコネクターの詳細情報を表示します。 |
--fields <field> [<field> …] | 1 つ以上のボリュームコネクターフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。 |
表11.344 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.345 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.346 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.347 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.95. baremetal volume connector set
ベアメタルボリュームコネクタープロパティーを設定します。
使用方法
openstack baremetal volume connector set [-h] [--node <uuid>] [--type <type>] [--connector-id <connector id>] [--extra <key=value>] <volume connector>
表11.348 位置引数
値 | 概要 |
---|---|
<volume connector> | ボリュームコネクターの UUID。 |
表11.349 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--node <uuid> | このボリュームコネクターが属するノードの UUID。 |
--type <type> | ボリュームコネクターの種類。iqn、ip、mac、wwnn、wwpn、port、portgroup。 |
--connector-id <connector id> | 指定したタイプのボリュームコネクターの ID。 |
--extra <key=value> | 任意のキー/値のメタデータを記録します。複数回指定できます。 |
11.96. baremetal volume connector show
ベアメタルボリュームコネクターの詳細を表示します。
使用方法
openstack baremetal volume connector show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--fields <field> [<field> ...]] <id>
表11.350 位置引数
値 | 概要 |
---|---|
<id> | ボリュームコネクターの UUID。 |
表11.351 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--fields <field> [<field> …] | 1 つ以上のボリュームコネクターフィールド。これらのフィールドのみがサーバーから取得されます。 |
表11.352 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.353 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.354 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.355 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.97. baremetal volume connector unset
ベアメタルボリュームコネクタープロパティーの設定を解除します。
使用方法
openstack baremetal volume connector unset [-h] [--extra <key>] <volume connector>
表11.356 位置引数
値 | 概要 |
---|---|
<volume connector> | ボリュームコネクターの UUID。 |
表11.357 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--extra <key> | 設定を解除する追加項目 (複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。) |
11.98. baremetal volume target create
新しいベアメタルのボリュームターゲットを作成します。
使用方法
openstack baremetal volume target create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --node <uuid> --type <volume type> [--property <key=value>] --boot-index <boot index> --volume-id <volume id> [--uuid <uuid>] [--extra <key=value>]
表11.358 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--node <uuid> | このボリュームターゲットが属するノードの UUID。 |
--type <volume type> | ボリュームターゲットのタイプ (例:iscsi、fibre_channel )。 |
--property <key=value> | このボリュームターゲットのタイプに関連するキー/値プロパティー。複数回指定できます。 |
--boot-index <boot index> | ボリュームターゲットのブートインデックス。 |
--volume-id <volume id> | このターゲットに関連付けられたボリュームの ID。 |
--uuid <uuid> | ボリュームターゲットの UUID |
--extra <key=value> | 任意のキー/値のメタデータを記録します。複数回指定できます。 |
表11.359 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.360 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.361 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.362 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.99. baremetal volume target delete
ベアメタルボリュームのターゲットの登録を解除します。
使用方法
openstack baremetal volume target delete [-h] <volume target> [<volume target> ...]
表11.363 位置引数
値 | 概要 |
---|---|
<volume target> | 削除するボリュームターゲットの UUID。 |
表11.364 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
11.100. baremetal volume target list
ベアメタルボリュームターゲットをリスト表示します。
使用方法
openstack baremetal volume target list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--node <node>] [--limit <limit>] [--marker <volume target>] [--sort <key>[:<direction>]] [--long | --fields <field> [<field> ...]]
表11.365 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--node <node> | このノードのボリュームターゲット (名前または UUID) のみをリスト表示します。 |
--limit <limit> | 要求ごとに返すボリュームターゲットの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。 |
--marker <volume target> | ボリュームターゲットの uuid(以前の要求リストにある最後のボリュームターゲットなど)。UUID の後にボリュームターゲットのリストを返します。 |
--sort <key>[:<direction>] | 指定したボリュームターゲットのフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。 |
--long | ボリュームターゲットの詳細情報を表示します。 |
--fields <field> [<field> …] | 1 つ以上のボリュームターゲットフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。 |
表11.366 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表11.367 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表11.368 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.369 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.101. baremetal volume target set
ベアメタルボリュームのターゲットプロパティーを設定します。
使用方法
openstack baremetal volume target set [-h] [--node <uuid>] [--type <volume type>] [--property <key=value>] [--boot-index <boot index>] [--volume-id <volume id>] [--extra <key=value>] <volume target>
表11.370 位置引数
値 | 概要 |
---|---|
<volume target> | ボリュームターゲットの UUID |
表11.371 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--node <uuid> | このボリュームターゲットが属するノードの UUID。 |
--type <volume type> | ボリュームターゲットのタイプ (例:iscsi、fibre_channel )。 |
--property <key=value> | このボリュームターゲットのタイプに関連するキー/値プロパティー。複数回指定できます。 |
--boot-index <boot index> | ボリュームターゲットのブートインデックス。 |
--volume-id <volume id> | このターゲットに関連付けられたボリュームの ID。 |
--extra <key=value> | 任意のキー/値のメタデータを記録します。複数回指定できます。 |
11.102. baremetal volume target show
ベアメタルボリュームのターゲットの詳細を表示します。
使用方法
openstack baremetal volume target show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--fields <field> [<field> ...]] <id>
表11.372 位置引数
値 | 概要 |
---|---|
<id> | ボリュームターゲットの UUID |
表11.373 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--fields <field> [<field> …] | 1 つ以上のボリュームターゲットフィールド。これらのフィールドのみがサーバーから取得されます。 |
表11.374 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表11.375 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表11.376 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表11.377 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
11.103. baremetal volume target unset
ベアメタルボリュームのターゲットプロパティーの設定を解除します。
使用方法
openstack baremetal volume target unset [-h] [--extra <key>] [--property <key>] <volume target>
表11.378 位置引数
値 | 概要 |
---|---|
<volume target> | ボリュームターゲットの UUID |
表11.379 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--extra <key> | 設定を解除する追加項目 (複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。) |
--property <key> | このベアメタルボリュームターゲットで設定を解除するプロパティー (複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します) |
第12章 ca
本章では、ca
コマンドに含まれるコマンドについて説明します。
12.1. ca get
URI を指定して CA を取得します。
使用方法
openstack ca get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] URI
表12.1 位置引数
値 | 概要 |
---|---|
URI | Ca の URI 参照。 |
表12.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表12.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表12.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表12.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表12.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
12.2. ca list
CA をリスト表示します。
使用方法
openstack ca list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--limit LIMIT] [--offset OFFSET] [--name NAME]
表12.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit LIMIT, -l LIMIT | ページごとに表示する項目数に制限を指定します (デフォルト:10、最大: 100)。 |
--offset OFFSET, -o OFFSET | ページのオフセットを指定します (デフォルト:0)。 |
--name NAME, -n NAME | Ca 名を指定します (デフォルト:none)。 |
表12.8 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表12.9 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表12.10 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表12.11 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第13章 catalog
本章では、catalog
コマンドに含まれるコマンドについて説明します。
13.1. catalog list
サービスカタログのサービスをリスト表示します。
使用方法
openstack catalog list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表13.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表13.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表13.3 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表13.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表13.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
13.2. catalog show
サービスカタログの詳細を表示します。
使用方法
openstack catalog show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <service>
表13.6 位置引数
値 | 概要 |
---|---|
<service> | 表示するサービス (タイプまたは名前) |
表13.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表13.8 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表13.9 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表13.10 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表13.11 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第14章 coe
本章では、coe
コマンドに含まれるコマンドについて説明します。
14.1. coe ca rotate
クラスターがアクセスを取り消すために CA 証明書をローテーションします。
使用方法
openstack coe ca rotate [-h] <cluster>
表14.1 位置引数
値 | 概要 |
---|---|
<cluster> | クラスターの ID または名前 |
表14.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
14.2. coe ca show
クラスターの CA 証明書の詳細を表示します。
使用方法
openstack coe ca show [-h] <cluster>
表14.3 位置引数
値 | 概要 |
---|---|
<cluster> | クラスターの ID または名前 |
表14.4 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
14.3. coe ca sign
クラスターの CA 証明書を生成します。
使用方法
openstack coe ca sign [-h] <cluster> <csr>
表14.5 位置引数
値 | 概要 |
---|---|
<cluster> | クラスターの ID または名前 |
<csr> | 署名を取得するために magnum に送信する csr ファイルのファイルパス。 |
表14.6 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
14.4. coe cluster config
クラスターの設定を取得します。
使用方法
openstack coe cluster config [-h] [--dir <dir>] [--force] [--output-certs] [--use-certificate] [--use-keystone] <cluster>
表14.7 位置引数
値 | 概要 |
---|---|
<cluster> | 更新するクラスターの名前または UUID |
表14.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--dir <dir> | 証明書と設定ファイルを保存するディレクトリー。 |
--force | ファイルが存在する場合には、ファイルを上書きします。 |
--output-certs | 別のファイルに証明書を出力します。 |
--use-certificate | 設定ファイルで証明書を使用します。 |
--use-keystone | 設定ファイルで keystone トークンを使用します。 |
14.5. coe cluster create
クラスターを作成します。
使用方法
openstack coe cluster create [-h] --cluster-template <cluster-template> [--discovery-url <discovery-url>] [--docker-volume-size <docker-volume-size>] [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>] [--keypair <keypair>] [--master-count <master-count>] [--node-count <node-count>] [--timeout <timeout>] [--master-flavor <master-flavor>] [--flavor <flavor>] [--fixed-network <fixed-network>] [--fixed-subnet <fixed-subnet>] [--floating-ip-enabled] [--floating-ip-disabled] <name>
表14.9 位置引数
値 | 概要 |
---|---|
<name> | 作成するクラスターの名前。 |
表14.10 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--cluster-template <cluster-template> | クラスターテンプレートの ID または名前 |
--discovery-url <discovery-url> | ノード検出用のカスタム配信 URL を指定します。 |
--docker-volume-size <docker-volume-size> | Docker ボリュームが使用するサイズ (gb 単位)。 |
--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…> | クラスターテンプレートに関連付ける key=valuepairs 形式の任意のラベル。複数回の使用が可能です。 |
--keypair <keypair> | 使用するキーペアの UUID または名前。 |
--master-count <master-count> | クラスターのマスターノードの数。 |
--node-count <node-count> | クラスターノードの数。 |
--timeout <timeout> | クラスター作成時間のタイムアウト。デフォルトは 60 分です。 |
--master-flavor <master-flavor> | クラスターのマスターノードを起動する時に使用する nova フレーバーの名前または UUID。 |
--flavor <flavor> | クラスターの起動時に使用する nova フレーバーの名前または UUID。 |
--fixed-network <fixed-network> | このクラスターテンプレートに接続するためのプライベート neutron ネットワーク名 |
--fixed-subnet <fixed-subnet> | クラスターに接続するためのプライベート neutron サブネット名。 |
--floating-ip-enabled | 作成したクラスターに Floating IP が必要であるかどうかを指定します。 |
--floating-ip-disabled | 新規クラスターでの Floating IP 作成を無効にします。 |
14.6. coe cluster delete
クラスターを削除します。
使用方法
openstack coe cluster delete [-h] <cluster> [<cluster> ...]
表14.11 位置引数
値 | 概要 |
---|---|
<cluster> | 削除するクラスターの ID または名前。 |
表14.12 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
14.7. coe cluster list
クラスターをリスト表示します。
使用方法
openstack coe cluster list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--limit <limit>] [--sort-key <sort-key>] [--sort-dir <sort-dir>]
表14.13 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit <limit> | 返すことのできるクラスターの最大数。 |
--sort-key <sort-key> | 結果を並べ替えるコラム |
--sort-dir <sort-dir> | ソートの方向。asc または desc。 |
表14.14 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表14.15 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表14.16 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表14.17 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
14.8. coe cluster resize
クラスターのサイズを調節します。
使用方法
openstack coe cluster resize [-h] [--nodes-to-remove <Server UUID>] [--nodegroup <nodegroup>] <cluster> node_count
表14.18 位置引数
値 | 概要 |
---|---|
<cluster> | 更新するクラスターの名前または UUID |
node_count | Cluser の必要なノード数。 |
表14.19 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--nodes-to-remove <Server UUID> | 削除するノードのサーバー ID。別のサーバー ID を追加するには繰り返し使用します。 |
--nodegroup <nodegroup> | 現在のクラスターのノードグループの名前または UUID。 |
14.9. coe cluster show
クラスターを表示します。
使用方法
openstack coe cluster show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <cluster>
表14.20 位置引数
値 | 概要 |
---|---|
<cluster> | 表示するクラスターの ID または名前。 |
表14.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表14.22 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表14.23 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表14.24 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表14.25 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
14.10. coe cluster template create
クラスターテンプレートを作成します。
使用方法
openstack coe cluster template create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --coe <coe> --image <image> --external-network <external-network> [--keypair <keypair>] [--fixed-network <fixed-network>] [--fixed-subnet <fixed-subnet>] [--network-driver <network-driver>] [--volume-driver <volume-driver>] [--dns-nameserver <dns-nameserver>] [--flavor <flavor>] [--master-flavor <master-flavor>] [--docker-volume-size <docker-volume-size>] [--docker-storage-driver <docker-storage-driver>] [--http-proxy <http-proxy>] [--https-proxy <https-proxy>] [--no-proxy <no-proxy>] [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>] [--tls-disabled] [--public] [--registry-enabled] [--server-type <server-type>] [--master-lb-enabled] [--floating-ip-enabled] [--floating-ip-disabled] [--hidden] [--visible] <name>
表14.26 位置引数
値 | 概要 |
---|---|
<name> | 作成するクラスターテンプレートの名前。 |
表14.27 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--coe <coe> | 使用するコンテナーオーケストレーションエンジンを指定します。 |
--image <image> | クラスター用にカスタマイズするベースイメージの名前または UUID。 |
--external-network <external-network> | このクラスターテンプレートに接続するための外部 neutron ネットワーク名または uuid。 |
--keypair <keypair> | クラスターノードに読み込む ssh キーペアの名前または UUID。 |
--fixed-network <fixed-network> | このクラスターモデルに接続するためのプライベート neutron ネットワーク名 |
--fixed-subnet <fixed-subnet> | クラスターに接続するためのプライベート neutron サブネット名。 |
--network-driver <network-driver> | コンテナーネットワークをインスタンス化するためのネットワークドライバー名。 |
--volume-driver <volume-driver> | コンテナーボリュームをインスタンス化するボリュームドライバー名。 |
--dns-nameserver <dns-nameserver> | このクラスターテンプレートに使用する dns ネームサーバー。 |
--flavor <flavor> | クラスターの起動時に使用する nova フレーバーの名前または UUID。 |
--master-flavor <master-flavor> | クラスターのマスターノードを起動する時に使用する nova フレーバーの名前または UUID。 |
--docker-volume-size <docker-volume-size> | Docker ボリュームで使用するサイズを GB 単位で指定します。 |
--docker-storage-driver <docker-storage-driver> | Docker ストレージドライバーを選択します。サポートされているドライバー:devicemapper、overlay。デフォルト:devicemapper |
--http-proxy <http-proxy> | クラスターのノードに使用する http_proxy アドレス。 |
--https-proxy <https-proxy> | クラスターのノードに使用する https_proxy アドレス。 |
--no-proxy <no-proxy> | クラスターのノードに使用する no_proxy アドレス。 |
--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…> | クラスターテンプレートに関連付ける key=value ペアの形式の任意のラベル。複数回の使用が可能です。 |
--tls-disabled | クラスターの tls を無効にします。 |
--public | クラスターテンプレートをパブリックにします。 |
--registry-enabled | クラスターでの docker レジストリーを有効化します。 |
--server-type <server-type> | Vm など、使用するサーバータイプを指定します。このリリースのデフォルトサーバータイプは vm です。 |
--master-lb-enabled | 作成したクラスターにマスターノードのロードバランサーがあるかどうかを指定します。 |
--floating-ip-enabled | 作成したクラスターに Floating IP が必要であるかどうかを指定します。 |
--floating-ip-disabled | 新規クラスターでの Floating IP 作成を無効にします。 |
--hidden | クラスターテンプレートを非表示に指定します。 |
--visible | クラスターテンプレートを表示するように指定します。 |
表14.28 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表14.29 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表14.30 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表14.31 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
14.11. coe cluster template delete
クラスターテンプレートを削除します。
使用方法
openstack coe cluster template delete [-h] <cluster-templates> [<cluster-templates> ...]
表14.32 位置引数
値 | 概要 |
---|---|
<cluster-templates> | 削除するクラスターテンプレートの ID または名前 |
表14.33 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
14.12. coe cluster template list
クラスターテンプレートをリスト表示します。
使用方法
openstack coe cluster template list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--limit <limit>] [--sort-key <sort-key>] [--sort-dir <sort-dir>] [--fields <fields>]
表14.34 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit <limit> | 返すことのできるクラスターテンプレートの最大数。 |
--sort-key <sort-key> | 結果を並べ替えるコラム |
--sort-dir <sort-dir> | ソートの方向。asc または desc。 |
--fields <fields> | 表示するフィールドのコンマ区切りリスト。uuid、name、coe、image_id、public、link、apiserver_port、server_type、tls_disabled、registry_enabled |
表14.35 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表14.36 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表14.37 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表14.38 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
14.13. coe cluster template show
クラスターテンプレートを表示します。
使用方法
openstack coe cluster template show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <cluster-template>
表14.39 位置引数
値 | 概要 |
---|---|
<cluster-template> | 表示するクラスターテンプレートの ID または名前。 |
表14.40 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表14.41 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表14.42 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表14.43 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表14.44 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
14.14. coe cluster template update
クラスターテンプレートを更新します。
使用方法
openstack coe cluster template update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <cluster-template> <op> <path=value> [<path=value> ...]
表14.45 位置引数
値 | 概要 |
---|---|
<cluster-template> | 更新するクラスターテンプレートの名前または UUID |
<op> | 操作:add、replace、または remove のいずれか |
<path=value> | 追加/置換または削除する属性 (削除時にパスのみが必要) |
表14.46 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表14.47 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表14.48 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表14.49 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表14.50 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
14.15. coe cluster update
クラスターを更新します。
使用方法
openstack coe cluster update [-h] [--rollback] <cluster> <op> <path=value> [<path=value> ...]
表14.51 位置引数
値 | 概要 |
---|---|
<cluster> | 更新するクラスターの名前または UUID |
<op> | 操作:add、replace、または remove のいずれか |
<path=value> | 追加/置換または削除する属性 (削除時にパスのみが必要) |
表14.52 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--rollback | 更新の失敗時のクラスターをロールバックします。 |
14.16. coe cluster upgrade
クラスターをアップグレードします。
使用方法
openstack coe cluster upgrade [-h] [--max-batch-size <max_batch_size>] [--nodegroup <nodegroup>] <cluster> cluster_template
表14.53 位置引数
値 | 概要 |
---|---|
<cluster> | 更新するクラスターの名前または UUID |
cluster_template | アップグレード先の新しいクラスターテンプレート ID 。 |
表14.54 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--max-batch-size <max_batch_size> | 各アップグレード時の最大バッチサイズ。 |
--nodegroup <nodegroup> | 現在のクラスターのノードグループの名前または UUID。 |
14.17. coe nodegroup create
ノードグループを作成します。
使用方法
openstack coe nodegroup create [-h] [--docker-volume-size <docker-volume-size>] [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>] [--node-count <node-count>] [--min-nodes <min-nodes>] [--max-nodes <max-nodes>] [--role <role>] [--image <image>] [--flavor <flavor>] <cluster> <name>
表14.55 位置引数
値 | 概要 |
---|---|
<cluster> | 作成するノードグループの名前。 |
<name> | 作成するノードグループの名前。 |
表14.56 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--docker-volume-size <docker-volume-size> | Docker ボリュームが使用するサイズ (gb 単位)。 |
--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…> | ノードグループに関連付ける key=valuepairs 形式の任意のラベル。複数回の使用が可能です。 |
--node-count <node-count> | ノードグループノード数。 |
--min-nodes <min-nodes> | ノードグループの最小のノード数。 |
--max-nodes <max-nodes> | ノードグループの最大数。 |
--role <role> | ノードグループのロール |
--image <image> | ノードグループ向けにカスタマイズするベースイメージの名前または UUID。 |
--flavor <flavor> | このノードグループでノードを起動する時に使用する nova フレーバーの名前または UUID。 |
14.18. coe nodegroup delete
ノードグループを削除します。
使用方法
openstack coe nodegroup delete [-h] <cluster> <nodegroup> [<nodegroup> ...]
表14.57 位置引数
値 | 概要 |
---|---|
<cluster> | ノードグループが所属するクラスターの ID または名前。 |
<nodegroup> | 削除するノードグループの ID または名前。 |
表14.58 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
14.19. coe nodegroup list
ノードグループをリスト表示します。
使用方法
openstack coe nodegroup list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--limit <limit>] [--sort-key <sort-key>] [--sort-dir <sort-dir>] [--role <role>] <cluster>
表14.59 位置引数
値 | 概要 |
---|---|
<cluster> | ノードグループが所属するクラスターの ID または名前。 |
表14.60 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit <limit> | 返すことのできるノードグループの最大数。 |
--sort-key <sort-key> | 結果を並べ替えるコラム |
--sort-dir <sort-dir> | ソートの方向。asc または desc。 |
--role <role> | このロールが割り当てられたクラスター内のノードグループをリスト表示します。 |
表14.61 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表14.62 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表14.63 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表14.64 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
14.20. coe nodegroup show
ノードグループを表示します。
使用方法
openstack coe nodegroup show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <cluster> <nodegroup>
表14.65 位置引数
値 | 概要 |
---|---|
<cluster> | ノードグループが所属するクラスターの ID または名前。 |
<nodegroup> | 表示するノードグループの ID または名前。 |
表14.66 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表14.67 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表14.68 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表14.69 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表14.70 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
14.21. coe nodegroup update
ノードグループを更新します。
使用方法
openstack coe nodegroup update [-h] <cluster> <nodegroup> <op> <path=value> [<path=value> ...]
表14.71 位置引数
値 | 概要 |
---|---|
<cluster> | ノードグループが所属するクラスターの ID または名前。 |
<nodegroup> | 更新するクラスターの名前または UUID |
<op> | 操作:add、replace、または remove のいずれか |
<path=value> | 追加/置換または削除する属性 (削除時にパスのみが必要) |
表14.72 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
14.22. coe quotas create
クォータを作成します。
使用方法
openstack coe quotas create [-h] --project-id <project-id> --resource <resource> [--hard-limit <hard-limit>]
表14.73 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project-id <project-id> | プロジェクト ID |
--resource <resource> | リソース名。 |
--hard-limit <hard-limit> | 最大リソース制限 (デフォルト:hard-limit=1) |
14.23. coe quotas delete
指定のリソースクォータを削除します。
使用方法
openstack coe quotas delete [-h] --project-id <project-id> --resource <resource>
表14.74 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project-id <project-id> | プロジェクト ID |
--resource <resource> | リソース名。 |
14.24. coe quotas list
利用可能なクォータリストを出力します。
使用方法
openstack coe quotas list [-h] [--marker <marker>] [--limit <limit>] [--sort-key <sort-key>] [--sort-dir <sort-dir>] [--all-tenants]
表14.75 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--marker <marker> | 直前のページにある最後のクォータ uuid。マーカーの後ろのクォータのリストを表示します。 |
--limit <limit> | 返すことのできるクォータの最大数。 |
--sort-key <sort-key> | 結果を並べ替えるコラム。 |
--sort-dir <sort-dir> | ソートの方向。asc または desc。 |
--all-tenants | すべてのテナントクォータのリストを表示するように指定するフラグ。 |
14.25. coe quotas show
指定のプロジェクトリソースのクォータの詳細を表示します。
使用方法
openstack coe quotas show [-h] --project-id <project-id> --resource <resource>
表14.76 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project-id <project-id> | プロジェクト ID |
--resource <resource> | リソース名。 |
14.26. coe quotas update
指定のプロジェクトリソースクォータの情報を更新します。
使用方法
openstack coe quotas update [-h] --project-id <project-id> --resource <resource> [--hard-limit <hard-limit>]
表14.77 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project-id <project-id> | プロジェクト ID |
--resource <resource> | リソース名。 |
--hard-limit <hard-limit> | 最大リソース制限 (デフォルト:hard-limit=1) |
14.27. coe service list
Magnum サービスのリストを出力します。
使用方法
openstack coe service list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表14.78 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表14.79 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表14.80 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表14.81 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表14.82 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
14.28. coe stats list
指定の project_id の統計を表示します。
使用方法
openstack coe stats list [-h] <project>
表14.83 位置引数
値 | 概要 |
---|---|
<project> | プロジェクト ID |
表14.84 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
第15章 command
本章では、command
コマンドに含まれるコマンドについて説明します。
15.1. コマンドリスト
グループ別に認識されているコマンドをリスト表示します。
使用方法
openstack command list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--group <group-keyword>]
表15.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--group <group-keyword> | コマンドグループでフィルターされたコマンドを表示します (例:identity、volume、compute、image、network、およびその他のキーワード)。 |
表15.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表15.3 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表15.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表15.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第16章 完了
この章では、complete
コマンドに含まれるコマンドについて説明します。
16.1. 完了
バッシュ補完コマンドを出力します。
使用方法
openstack complete [-h] [--name <command_name>] [--shell <shell>]
表16.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <command_name> | コマンド補完でサポートされるコマンド名 |
--shell <shell> | 使用するシェル。データのみの場合には none を使用します (デフォルト:bash)。 |
第17章 compute
本章では、compute
コマンドに含まれるコマンドについて説明します。
17.1. compute agent create
コンピュートエージェントを作成します。
使用方法
openstack compute agent create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <os> <architecture> <version> <url> <md5hash> <hypervisor>
表17.1 位置引数
値 | 概要 |
---|---|
<os> | OS のタイプ |
<architecture> | アーキテクチャーのタイプ |
<version> | バージョン |
<url> | Url |
<md5hash> | Md5 ハッシュ |
<hypervisor> | ハイパーバイザーの種別 |
表17.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表17.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表17.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表17.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表17.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
17.2. Compute agent delete
コンピュートエージェントを削除します。
使用方法
openstack compute agent delete [-h] <id> [<id> ...]
表17.7 位置引数
値 | 概要 |
---|---|
<id> | 削除するエージェントの ID |
表17.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
17.3. compute agent list
コンピュートエージェントをリスト表示します。
使用方法
openstack compute agent list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--hypervisor <hypervisor>]
表17.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--hypervisor <hypervisor> | ハイパーバイザーの種別 |
表17.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表17.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表17.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表17.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
17.4. compute agent set
コンピュートエージェントのプロパティーを設定します。
使用方法
openstack compute agent set [-h] [--agent-version <version>] [--url <url>] [--md5hash <md5hash>] <id>
表17.14 位置引数
値 | 概要 |
---|---|
<id> | エージェントの ID |
表17.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--agent-version <version> | エージェントのバージョン |
--url <url> | エージェントの URL |
--md5hash <md5hash> | エージェントの Md5 ハッシュ |
17.5. compute service delete
コンピュートサービスを削除します。
使用方法
openstack compute service delete [-h] <service> [<service> ...]
表17.16 位置引数
値 | 概要 |
---|---|
<service> | 削除する Compute サービス (id のみ)。''--os-compute- api-version'' で 2.53 以降を使用している場合、ID は UUID で、同じ 2.53+ マイクロバージョンを使用してコンピュートサービスをリスト表示して取得できます。 |
表17.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
17.6. compute service list
コンピュートサービスをリスト表示します。''--os-compute-api-version'' 2.53 以降を使用すると、ID は UUID 値として返されます。これは、マルチセルデプロイメントでサービスを一意に識別するために使用できます。
使用方法
openstack compute service list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--host <host>] [--service <service>] [--long]
表17.18 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--host <host> | 指定したホストでサービスをリスト表示します (名前のみ)。 |
--service <service> | 指定したサービスバイナリーのみをリスト表示します (名前のみ)。例: ''nova-compute'', ''nova-conductor'' など。 |
--long | 出力の追加フィールドをリスト表示します。 |
表17.19 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表17.20 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表17.21 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表17.22 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
17.7. compute service set
コンピュートサービス属性を設定します。
使用方法
openstack compute service set [-h] [--enable | --disable] [--disable-reason <reason>] [--up | --down] <host> <service>
表17.23 位置引数
値 | 概要 |
---|---|
<host> | ホスト名 |
<service> | サービス名 (バイナリー名)(例:''nova- compute'') |
表17.24 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--enable | サービスを有効化します。 |
--disable | サービスを無効化します。 |
--disable-reason <reason> | サービスを無効にする理由 (引用符で囲む)。--disable オプションと併用する必要があります。 |
--up | サービスを強制的に起動します。これには ''--os-compute-api- version'' 2.11 以降が必要です。 |
--down | サービスを強制的に終了します。これには ''--os-compute-api- version'' 2.11 以降が必要です。 |
第18章 configuration
本章では、configuration
コマンドに含まれるコマンドについて説明します。
18.1. configuration show
設定を詳細表示します。
使用方法
openstack configuration show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--mask | --unmask]
表18.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--mask | パスワードのマスクを試行します (デフォルト) |
--unmask | パスワードをクリアテキストで表示します。 |
表18.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表18.3 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表18.4 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表18.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第19章 一貫性
本章では、consistency
コマンドに含まれるコマンドについて説明します。
19.1. consistency group add volume
整合性グループにボリュームを追加します。
使用方法
openstack consistency group add volume [-h] <consistency-group> <volume> [<volume> ...]
表19.1 位置引数
値 | 概要 |
---|---|
<consistency-group> | <volume> を含む整合性グループ (名前または id) |
<volume> | <consistency-group> (名前または id) に追加するボリューム (複数のボリュームを追加する場合はオプションを繰り返し使用します) |
表19.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
19.2. consistency group create
新規整合性グループを作成します。
使用方法
openstack consistency group create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] (--volume-type <volume-type> | --consistency-group-source <consistency-group> | --consistency-group-snapshot <consistency-group-snapshot>) [--description <description>] [--availability-zone <availability-zone>] [<name>]
表19.3 位置引数
値 | 概要 |
---|---|
<name> | 新規整合性グループの名前 (デフォルトは none) |
表19.4 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--volume-type <volume-type> | この整合性グループのボリューム種別 (名前または ID) |
--consistency-group-source <consistency-group> | 既存の整合性グループ (名前または ID) |
--consistency-group-snapshot <consistency-group-snapshot> | 既存の整合性グループのスナップショット (名前または ID) |
--description <description> | この整合性グループの説明 |
--availability-zone <availability-zone> | この整合性グループのアベイラビリティーゾーン (ソースから整合性グループを作成する場合は利用できません) |
表19.5 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表19.6 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表19.7 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表19.8 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
19.3. consistency group delete
整合性グループを削除します。
使用方法
openstack consistency group delete [-h] [--force] <consistency-group> [<consistency-group> ...]
表19.9 位置引数
値 | 概要 |
---|---|
<consistency-group> | 削除する整合性グループ (名前または ID) |
表19.10 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--force | Error または available 以外の状態で削除を可能にします。 |
19.4. consistency group list
整合性グループをリスト表示します。
使用方法
openstack consistency group list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--all-projects] [--long]
表19.11 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの詳細を表示します。管理者のみ (デフォルトは False) |
--long | 出力の追加フィールドをリスト表示します。 |
表19.12 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表19.13 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表19.14 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表19.15 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
19.5. consistency group remove volume
整合性グループからボリュームを削除します。
使用方法
openstack consistency group remove volume [-h] <consistency-group> <volume> [<volume> ...]
表19.16 位置引数
値 | 概要 |
---|---|
<consistency-group> | <volume>(名前または ID) を含む整合性グループ |
<volume> | <consistency-group> (名前または id) から削除するボリューム (複数のボリュームを削除する場合はオプションを繰り返し使用します) |
表19.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
19.6. consistency group set
整合性グループのプロパティーを設定します。
使用方法
openstack consistency group set [-h] [--name <name>] [--description <description>] <consistency-group>
表19.18 位置引数
値 | 概要 |
---|---|
<consistency-group> | 変更する整合性グループ (名前または ID) |
表19.19 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 整合性グループの新しい名前 |
--description <description> | 整合性グループの新たな説明 |
19.7. consistency group show
整合性グループの詳細を表示します。
使用方法
openstack consistency group show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <consistency-group>
表19.20 位置引数
値 | 概要 |
---|---|
<consistency-group> | 表示する整合性グループ (名前または ID) |
表19.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表19.22 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表19.23 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表19.24 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表19.25 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
19.8. consistency group snapshot create
新規整合性グループのスナップショットを作成します。
使用方法
openstack consistency group snapshot create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--consistency-group <consistency-group>] [--description <description>] [<snapshot-name>]
表19.26 位置引数
値 | 概要 |
---|---|
<snapshot-name> | 新規整合性グループのスナップショット名 (デフォルトは None) |
表19.27 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--consistency-group <consistency-group> | スナップショット (名前または ID) を作成する整合性グループ (デフォルトは <snapshot-name> と同じ) |
--description <description> | この整合性グループのスナップショットの説明 |
表19.28 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表19.29 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表19.30 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表19.31 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
19.9. consistency group snapshot delete
整合性グループのスナップショットを削除します。
使用方法
openstack consistency group snapshot delete [-h] <consistency-group-snapshot> [<consistency-group-snapshot> ...]
表19.32 位置引数
値 | 概要 |
---|---|
<consistency-group-snapshot> | 削除する整合性グループのスナップショット (名前または ID) |
表19.33 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
19.10. consistency group snapshot list
整合性グループのスナップショットをリスト表示します。
使用方法
openstack consistency group snapshot list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--all-projects] [--long] [--status <status>] [--consistency-group <consistency-group>]
表19.34 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの詳細を表示します。管理者のみ (デフォルトは False) |
--long | 出力の追加フィールドをリスト表示します。 |
--status <status> | ステータスで結果をフィルターします (available、error、deleting、deleting、または error_deleting)。 |
--consistency-group <consistency-group> | 整合性グループ (名前または ID) で結果をフィルタリングします |
表19.35 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表19.36 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表19.37 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表19.38 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
19.11. consistency group snapshot show
整合性グループのスナップショットの詳細を表示します。
使用方法
openstack consistency group snapshot show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <consistency-group-snapshot>
表19.39 位置引数
値 | 概要 |
---|---|
<consistency-group-snapshot> | 表示する整合性グループのスナップショット (名前または ID) |
表19.40 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表19.41 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表19.42 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表19.43 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表19.44 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第20章 console
本章では、console
コマンドに含まれるコマンドについて説明します。
20.1. console log show
サーバーのコンソール出力を表示します。
使用方法
openstack console log show [-h] [--lines <num-lines>] <server>
表20.1 位置引数
値 | 概要 |
---|---|
<server> | コンソールログ (名前または ID) を表示するサーバー |
表20.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--lines <num-lines> | ログの末尾から表示する行数 (デフォルト=all)。 |
20.2. console url show
サーバーのリモートコンソール URL を表示します。
使用方法
openstack console url show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--novnc | --xvpvnc | --spice | --rdp | --serial | --mks] <server>
表20.3 位置引数
値 | 概要 |
---|---|
<server> | URL(名前または ID) を表示するサーバー |
表20.4 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--novnc | Novnc コンソール URL を表示します (デフォルト) |
--xvpvnc | Xvpvnc コンソール URL を表示します。 |
--spice | Spice コンソールの URL を表示します。 |
--rdp | Rdp コンソールの URL を表示します。 |
--serial | シリアルコンソールの URL を表示します。 |
--mks | Webmks コンソールの URL を表示します。 |
表20.5 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表20.6 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表20.7 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表20.8 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第21章 consumer
本章では、consumer
コマンドに含まれるコマンドについて説明します。
21.1. consumer create
新規コンシューマーを作成します。
使用方法
openstack consumer create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>]
表21.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | 新規コンシューマーの説明 |
表21.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表21.3 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表21.4 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表21.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
21.2. consumer delete
コンシューマーを削除します。
使用方法
openstack consumer delete [-h] <consumer> [<consumer> ...]
表21.6 位置引数
値 | 概要 |
---|---|
<consumer> | 削除するコンシューマー |
表21.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
21.3. consumer list
コンシューマーをリスト表示します。
使用方法
openstack consumer list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表21.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表21.9 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表21.10 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表21.11 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表21.12 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
21.4. consumer set
コンシューマープロパティーを設定します。
使用方法
openstack consumer set [-h] [--description <description>] <consumer>
表21.13 位置引数
値 | 概要 |
---|---|
<consumer> | 変更するコンシューマー |
表21.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | 新規コンシューマーの説明 |
21.5. consumer show
コンシューマーの詳細を表示します。
使用方法
openstack consumer show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <consumer>
表21.15 位置引数
値 | 概要 |
---|---|
<consumer> | 表示するコンシューマー |
表21.16 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表21.17 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表21.18 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表21.19 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表21.20 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第22章 コンテナー
本章では、container
コマンドに含まれるコマンドについて説明します。
22.1. container create
新規コンテナーを作成します。
使用方法
openstack container create [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <container-name> [<container-name> ...]
表22.1 位置引数
値 | 概要 |
---|---|
<container-name> | 新しいコンテナー名 |
表22.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表22.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表22.4 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表22.5 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表22.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
22.2. container delete
コンテナーを削除します。
使用方法
openstack container delete [-h] [--recursive] <container> [<container> ...]
表22.7 位置引数
値 | 概要 |
---|---|
<container> | 削除するコンテナー |
表22.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--recursive, -r | オブジェクトおよびコンテナーを再帰的に削除します。 |
22.3. container list
コンテナーの一覧を表示します。
使用方法
openstack container list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--prefix <prefix>] [--marker <marker>] [--end-marker <end-marker>] [--limit <num-containers>] [--long] [--all]
表22.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--prefix <prefix> | <prefix> を使用してリストをフィルタリングします |
--marker <marker> | ページングのアンカー |
--end-marker <end-marker> | ページングの終了アンカー |
--limit <num-containers> | 返されるコンテナーの数を制限します。 |
--long | 出力の追加フィールドをリスト表示します。 |
--all | すべてのコンテナーをリスト表示します (デフォルトは 10000)。 |
表22.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表22.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表22.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表22.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
22.4. container save
コンテナーのコンテンツをローカルで保存します。
使用方法
openstack container save [-h] <container>
表22.14 位置引数
値 | 概要 |
---|---|
<container> | 保存するコンテナー |
表22.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
22.5. container set
コンテナープロパティーを設定します。
使用方法
openstack container set [-h] --property <key=value> <container>
表22.16 位置引数
値 | 概要 |
---|---|
<container> | 変更するコンテナー |
表22.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--property <key=value> | このコンテナーにプロパティーを設定します (複数のプロパティーを設定する場合はオプションを繰り返し使用します) |
22.6. container show
コンテナーの詳細を表示します。
使用方法
openstack container show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <container>
表22.18 位置引数
値 | 概要 |
---|---|
<container> | 表示するコンテナー |
表22.19 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表22.20 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表22.21 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表22.22 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表22.23 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
22.7. container unset
コンテナーのプロパティーの設定を解除します。
使用方法
openstack container unset [-h] --property <key> <container>
表22.24 位置引数
値 | 概要 |
---|---|
<container> | 変更するコンテナー |
表22.25 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--property <key> | コンテナーから削除するプロパティー (複数のプロパティーを削除する場合はオプションを繰り返し使用します) |
第23章 credential
本章では、credential
コマンドに含まれるコマンドについて説明します。
23.1. credential create
新規認証情報を作成します。
使用方法
openstack credential create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--type <type>] [--project <project>] <user> <data>
表23.1 位置引数
値 | 概要 |
---|---|
<user> | 認証情報を所有するユーザー (名前または ID) |
<data> | 新しい認証情報データ |
表23.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--type <type> | 新規の認証タイプ:cert、ec2、tp など |
--project <project> | 認証情報の範囲を制限するプロジェクト (名前または ID) |
表23.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表23.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表23.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表23.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
23.2. credential delete
認証情報を削除します。
使用方法
openstack credential delete [-h] <credential-id> [<credential-id> ...]
表23.7 位置引数
値 | 概要 |
---|---|
<credential-id> | 削除する認証情報の ID |
表23.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
23.3. credential list
認証情報をリスト表示します。
使用方法
openstack credential list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--user <user>] [--user-domain <user-domain>] [--type <type>]
表23.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--user <user> | <user>(名前または ID) 別に認証情報をフィルタリングします |
--user-domain <user-domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
--type <type> | タイプで認証情報をフィルターします (cert、ec2、totp など)。 |
表23.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表23.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表23.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表23.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
23.4. credential set
認証情報のプロパティーを設定します。
使用方法
openstack credential set [-h] --user <user> --type <type> --data <data> [--project <project>] <credential-id>
表23.14 位置引数
値 | 概要 |
---|---|
<credential-id> | 変更する認証情報の ID |
表23.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--user <user> | 認証情報を所有するユーザー (名前または ID) |
--type <type> | 新規の認証タイプ:cert、ec2、tp など |
--data <data> | 新しい認証情報データ |
--project <project> | 認証情報の範囲を制限するプロジェクト (名前または ID) |
23.5. credential show
認証情報の詳細を表示します。
使用方法
openstack credential show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <credential-id>
表23.16 位置引数
値 | 概要 |
---|---|
<credential-id> | 表示する認証情報の ID |
表23.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表23.18 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表23.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表23.20 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表23.21 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第24章 cron
本章では、cron
コマンドに含まれるコマンドについて説明します。
24.1. cron trigger create
新規トリガーを作成します。
使用方法
openstack cron trigger create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--params PARAMS] [--pattern <* * * * *>] [--first-time <YYYY-MM-DD HH:MM>] [--count <integer>] [--utc] name workflow_identifier [workflow_input]
表24.1 位置引数
値 | 概要 |
---|---|
name | Cron trigger の名前 |
workflow_identifier | ワークフローの名前または ID |
workflow_input | ワークフロー入力 |
表24.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--params PARAMS | ワークフローパラメーター |
--pattern <* * * * *> | Cron trigger のパターン |
--first-time <YYYY-MM-DD HH:MM> | 最初の実行日時。時間は、--utc も併せて指定されていない場合にローカル時間として処理されます。 |
--count <integer> | 任意の実行数 |
--utc | 指定した時間はすべて utc として処理する必要があります。 |
表24.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表24.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表24.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表24.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
24.2. cron trigger delete
トリガーを削除します。
使用方法
openstack cron trigger delete [-h] cron_trigger [cron_trigger ...]
表24.7 位置引数
値 | 概要 |
---|---|
cron_trigger | Cron トリガーの名前。 |
表24.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
24.3. cron trigger list
すべての cron トリガーをリスト表示します。
使用方法
openstack cron trigger list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS]
表24.9 コマンド引数
値 | 概要 |
---|---|
-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 | フィルター。繰り返し使用できます。 |
表24.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表24.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表24.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表24.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
24.4. cron trigger show
特定の cron トリガーを表示します。
使用方法
openstack cron trigger show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] cron_trigger
表24.14 位置引数
値 | 概要 |
---|---|
cron_trigger | Cron trigger の名前 |
表24.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表24.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表24.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表24.18 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表24.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第25章 datastore
本章では、datastore
コマンドに含まれるコマンドについて説明します。
25.1. datastore list
利用可能なデータストアをリスト表示します。
使用方法
openstack datastore list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表25.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表25.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表25.3 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表25.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表25.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
25.2. datastore show
データストアの詳細を表示します。
使用方法
openstack datastore show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <datastore>
表25.6 位置引数
値 | 概要 |
---|---|
<datastore> | データストアの ID |
表25.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表25.8 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表25.9 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表25.10 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表25.11 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
25.3. datastore version list
データストアで利用可能なバージョンをリスト表示します。
使用方法
openstack datastore version list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <datastore>
表25.12 位置引数
値 | 概要 |
---|---|
<datastore> | データストアの ID または名前 |
表25.13 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表25.14 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表25.15 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表25.16 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表25.17 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
25.4. datastore version show
データストアバージョンの詳細を表示します。
使用方法
openstack datastore version show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--datastore <datastore>] <datastore_version>
表25.18 位置引数
値 | 概要 |
---|---|
<datastore_version> | データストアバージョンの ID または名前。 |
表25.19 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--datastore <datastore> | データストアの ID または名前。Datastore_version の ID が指定されている場合はオプションになります。 |
表25.20 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表25.21 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表25.22 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表25.23 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第26章 dns
本章では、dns
コマンドに含まれるコマンドについて説明します。
26.1. dns quota list
クォータをリスト表示します。
使用方法
openstack dns quota list [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] [--project-id PROJECT_ID]
表26.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
--project-id PROJECT_ID | プロジェクト ID のデフォルト: 現在のプロジェクト |
表26.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表26.3 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表26.4 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表26.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
26.2. dns quota reset
クォータをリセットします。
使用方法
openstack dns quota reset [-h] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] [--project-id PROJECT_ID]
表26.6 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
--project-id PROJECT_ID | プロジェクト ID |
26.3. dns quota set
クォータを設定します。
使用方法
openstack dns quota set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] [--project-id PROJECT_ID] [--api-export-size <api-export-size>] [--recordset-records <recordset-records>] [--zone-records <zone-records>] [--zone-recordsets <zone-recordsets>] [--zones <zones>]
表26.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
--project-id PROJECT_ID | プロジェクト ID |
--api-export-size <api-export-size> | Api-export-size クォータの新しい値 |
--recordset-records <recordset-records> | Recordset-records クォータの新しい値 |
--zone-records <zone-records> | Zone-records クォータの新しい値 |
--zone-recordsets <zone-recordsets> | Zone-recordsets クォータの新しい値 |
--zones <zones> | ゾーンクォータの新しい値 |
表26.8 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表26.9 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表26.10 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表26.11 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
26.4. dns service list
サービスステータスをリスト表示します。
使用方法
openstack dns service list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--hostname HOSTNAME] [--service_name SERVICE_NAME] [--status STATUS] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
表26.12 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--hostname HOSTNAME | Hostname |
--service_name SERVICE_NAME | サービス名 |
--status STATUS | ステータス |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表26.13 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表26.14 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表26.15 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表26.16 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
26.5. dns service show
サービスステータスの詳細を表示します。
使用方法
openstack dns service show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表26.17 位置引数
値 | 概要 |
---|---|
id | サービスのステータス ID |
表26.18 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表26.19 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表26.20 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表26.21 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表26.22 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第27章 domain
本章では、domain
コマンドに含まれるコマンドについて説明します。
27.1. domain create
新規ドメインを作成します。
使用方法
openstack domain create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--enable | --disable] [--or-show] <domain-name>
表27.1 位置引数
値 | 概要 |
---|---|
<domain-name> | 新規ドメイン名 |
表27.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | 新規ドメインの説明 |
--enable | ドメインを有効化します (デフォルト)。 |
--disable | ドメインを無効化します。 |
--or-show | 既存のドメインを返します。 |
表27.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表27.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表27.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表27.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
27.2. domain delete
ドメインを削除します。
使用方法
openstack domain delete [-h] <domain> [<domain> ...]
表27.7 位置引数
値 | 概要 |
---|---|
<domain> | 削除するドメイン (名前または ID) |
表27.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
27.3. ドメインリスト
ドメインのリストを表示します。
使用方法
openstack domain list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表27.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表27.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表27.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表27.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表27.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
27.4. domain set
ドメインプロパティーを設定します。
使用方法
openstack domain set [-h] [--name <name>] [--description <description>] [--enable | --disable] <domain>
表27.14 位置引数
値 | 概要 |
---|---|
<domain> | 変更するドメイン (名前または ID) |
表27.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 新規ドメイン名 |
--description <description> | 新規ドメインの説明 |
--enable | ドメインを有効化します。 |
--disable | ドメインを無効化します。 |
27.5. domain show
ドメインの詳細を表示します。
使用方法
openstack domain show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <domain>
表27.16 位置引数
値 | 概要 |
---|---|
<domain> | 表示するドメイン (名前または ID) |
表27.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表27.18 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表27.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表27.20 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表27.21 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第28章 ec2
本章では、ec2
コマンドに含まれるコマンドについて説明します。
28.1. ec2 credentials create
EC2 認証情報を作成します。
使用方法
openstack ec2 credentials create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--project <project>] [--user <user>] [--user-domain <user-domain>] [--project-domain <project-domain>]
表28.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | プロジェクトで認証情報を作成します (名前または ID、デフォルト: 現在の認証プロジェクト)。 |
--user <user> | ユーザーの認証情報を作成します (名前または ID、デフォルト: 現在の認証ユーザー)。 |
--user-domain <user-domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
表28.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表28.3 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表28.4 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表28.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
28.2. ec2 credentials delete
EC2 認証情報を削除します。
使用方法
openstack ec2 credentials delete [-h] [--user <user>] [--user-domain <user-domain>] <access-key> [<access-key> ...]
表28.6 位置引数
値 | 概要 |
---|---|
<access-key> | 認証情報アクセスキー |
表28.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--user <user> | ユーザーの認証情報を削除します (名前または ID)。 |
--user-domain <user-domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
28.3. ec2 credentials list
EC2 認証情報をリスト表示します。
使用方法
openstack ec2 credentials list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--user <user>] [--user-domain <user-domain>]
表28.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--user <user> | ユーザー別にリストを絞り込みます (名前または ID)。 |
--user-domain <user-domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
表28.9 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表28.10 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表28.11 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表28.12 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
28.4. ec2 credentials show
EC2 認証情報の詳細を表示します。
使用方法
openstack ec2 credentials show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--user <user>] [--user-domain <user-domain>] <access-key>
表28.13 位置引数
値 | 概要 |
---|---|
<access-key> | 認証情報アクセスキー |
表28.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--user <user> | ユーザーの認証情報 (名前または ID) を表示します。 |
--user-domain <user-domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
表28.15 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表28.16 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表28.17 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表28.18 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第29章 endpoint
本章では、endpoint
コマンドに含まれるコマンドについて説明します。
29.1. endpoint add project
プロジェクトをエンドポイントに関連付けます。
使用方法
openstack endpoint add project [-h] [--project-domain <project-domain>] <endpoint> <project>
表29.1 位置引数
値 | 概要 |
---|---|
<endpoint> | 指定したプロジェクト (名前または ID) に関連付けるエンドポイント |
<project> | 指定のエンドポイント名または ID に関連付けるプロジェクト |
表29.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
29.2. endpoint create
新規エンドポイントを作成します。
使用方法
openstack endpoint create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--region <region-id>] [--enable | --disable] <service> <interface> <url>
表29.3 位置引数
値 | 概要 |
---|---|
<service> | 新しいエンドポイント (名前または ID) に関連付けるサービス |
<interface> | 新規エンドポイントインターフェイスタイプ (admin、public または internal) |
<url> | 新規エンドポイント URL |
表29.4 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--region <region-id> | 新規エンドポイントのリージョン ID |
--enable | エンドポイントを有効化します (デフォルト) |
--disable | エンドポイントを無効化します |
表29.5 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表29.6 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表29.7 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表29.8 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
29.3. endpoint delete
エンドポイントを削除します。
使用方法
openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]
表29.9 位置引数
値 | 概要 |
---|---|
<endpoint-id> | 削除するエンドポイント (id のみ) |
表29.10 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
29.4. endpoint group add project
プロジェクトをエンドポイントグループに追加します。
使用方法
openstack endpoint group add project [-h] [--project-domain <project-domain>] <endpoint-group> <project>
表29.11 位置引数
値 | 概要 |
---|---|
<endpoint-group> | エンドポイントグループ (名前または ID) |
<project> | 関連付けるプロジェクト (名前または ID) |
表29.12 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
29.5. endpoint group create
新規エンドポイントグループを作成します。
使用方法
openstack endpoint group create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description DESCRIPTION] <name> <filename>
表29.13 位置引数
値 | 概要 |
---|---|
<name> | エンドポイントグループの名前 |
<filename> | 新しいフィルターセットを含むファイル名 |
表29.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description DESCRIPTION | エンドポイントグループの説明 |
表29.15 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表29.16 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表29.17 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表29.18 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
29.6. endpoint group delete
エンドポイントグループを削除します。
使用方法
openstack endpoint group delete [-h] <endpoint-group> [<endpoint-group> ...]
表29.19 位置引数
値 | 概要 |
---|---|
<endpoint-group> | 削除するエンドポイントグループ (名前または ID) |
表29.20 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
29.7. endpoint group list
エンドポイントグループをリスト表示します。
使用方法
openstack endpoint group list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--endpointgroup <endpoint-group> | --project <project>] [--domain <domain>]
表29.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--endpointgroup <endpoint-group> | エンドポイントグループ (名前または ID) |
--project <project> | プロジェクト (名前または ID) |
--domain <domain> | <project> を所有するドメイン (名前または ID) |
表29.22 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表29.23 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表29.24 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表29.25 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
29.8. endpoint group remove project
エンドポイントグループからプロジェクトを削除します。
使用方法
openstack endpoint group remove project [-h] [--project-domain <project-domain>] <endpoint-group> <project>
表29.26 位置引数
値 | 概要 |
---|---|
<endpoint-group> | エンドポイントグループ (名前または ID) |
<project> | 削除するプロジェクト (名前または ID) |
表29.27 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
29.9. endpoint group set
エンドポイントグループプロパティーを設定します。
使用方法
openstack endpoint group set [-h] [--name <name>] [--filters <filename>] [--description <description>] <endpoint-group>
表29.28 位置引数
値 | 概要 |
---|---|
<endpoint-group> | 変更するエンドポイントグループ (名前または ID) |
表29.29 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | アタ r シイエンドポイントグループ名 |
--filters <filename> | 新しいフィルターセットを含むファイル名 |
--description <description> | 新規エンドポイントグループの説明 |
29.10. endpoint group show
エンドポイントグループの詳細を表示します。
使用方法
openstack endpoint group show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <endpointgroup>
表29.30 位置引数
値 | 概要 |
---|---|
<endpointgroup> | エンドポイントグループ (名前または ID) |
表29.31 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表29.32 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表29.33 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表29.34 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表29.35 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
29.11. endpoint list
エンドポイントをリスト表示します。
使用方法
openstack endpoint list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--service <service>] [--interface <interface>] [--region <region-id>] [--endpoint <endpoint-group> | --project <project>] [--project-domain <project-domain>]
表29.36 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--service <service> | サービス (タイプ、名前または ID) 別に絞り込みます。 |
--interface <interface> | インターフェイスタイプ別に絞り込みます (管理者、パブリック、または内部) |
--region <region-id> | リージョン ID 別に絞り込みます。 |
--endpoint <endpoint-group> | フィルターをリスト表示するエンドポイント |
--project <project> | フィルターをリスト表示するプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
表29.37 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表29.38 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表29.39 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表29.40 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
29.12. endpoint remove project
エンドポイントからプロジェクトを分散します。
使用方法
openstack endpoint remove project [-h] [--project-domain <project-domain>] <endpoint> <project>
表29.41 位置引数
値 | 概要 |
---|---|
<endpoint> | 指定したプロジェクト (名前または ID) から関連付けを解除するエンドポイント |
<project> | 指定されたエンドポイント名または ID から関連付けを解除するプロジェクト |
表29.42 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
29.13. endpoint set
エンドポイントプロパティーを設定します。
使用方法
openstack endpoint set [-h] [--region <region-id>] [--interface <interface>] [--url <url>] [--service <service>] [--enable | --disable] <endpoint-id>
表29.43 位置引数
値 | 概要 |
---|---|
<endpoint-id> | 変更するエンドポイント (ID のみ) |
表29.44 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--region <region-id> | 新規エンドポイントのリージョン ID |
--interface <interface> | 新規エンドポイントインターフェイスタイプ (admin、public または internal) |
--url <url> | 新規エンドポイント URL |
--service <service> | 新しいエンドポイントサービス (名前または ID) |
--enable | エンドポイントを有効化します。 |
--disable | エンドポイントを無効化します |
29.14. endpoint show
エンドポイントの詳細を表示します。
使用方法
openstack endpoint show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <endpoint>
表29.45 位置引数
値 | 概要 |
---|---|
<endpoint> | 表示するエンドポイント (エンドポイント id、サービス ID、サービス名、サービスタイプ) |
表29.46 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表29.47 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表29.48 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表29.49 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表29.50 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第30章 event
本章では、event
コマンドに含まれるコマンドについて説明します。
30.1. event trigger create
新規トリガーを作成します。
使用方法
openstack event trigger create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--params PARAMS] name workflow_id exchange topic event [workflow_input]
表30.1 位置引数
値 | 概要 |
---|---|
name | イベントトリガー名 |
workflow_id | ワークフロー id |
exchange | イベントトリガーの交換 |
topic | イベントトリガートピック |
event | イベントトリガーイベント名 |
workflow_input | ワークフロー入力 |
表30.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--params PARAMS | ワークフローパラメーター |
表30.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表30.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表30.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表30.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
30.2. event trigger delete
トリガーを削除します。
使用方法
openstack event trigger delete [-h] event_trigger_id [event_trigger_id ...]
表30.7 位置引数
値 | 概要 |
---|---|
event_trigger_id | イベントトリガーの ID。 |
表30.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
30.3. event trigger list
すべてのイベントトリガーをリスト表示します。
使用方法
openstack event trigger list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS]
表30.9 コマンド引数
値 | 概要 |
---|---|
-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 | フィルター。繰り返し使用できます。 |
表30.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表30.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表30.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表30.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
30.4. event trigger show
特定のイベントトリガーを表示します。
使用方法
openstack event trigger show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] event_trigger
表30.14 位置引数
値 | 概要 |
---|---|
event_trigger | イベントトリガー ID |
表30.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表30.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表30.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表30.18 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表30.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第31章 extension
本章では、extension
コマンドに含まれるコマンドについて説明します。
31.1. extension list
API 拡張をリスト表示します。
使用方法
openstack extension list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--compute] [--identity] [--network] [--volume] [--long]
表31.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--compute | コンピュート api の拡張機能をリスト表示します。 |
--identity | アイデンティティー api の拡張機能をリスト表示します。 |
--network | ネットワーク api の拡張機能をリスト表示します。 |
--volume | ブロックストレージ api の拡張機能をリスト表示します。 |
--long | 出力の追加フィールドをリスト表示します。 |
表31.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表31.3 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表31.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表31.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
31.2. extension show
API 拡張機能を表示します。
使用方法
openstack extension show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <extension>
表31.6 位置引数
値 | 概要 |
---|---|
<extension> | 表示する拡張機能。現在、ネットワーク拡張機能のみがサポートされます。(名前またはエイリアス) |
表31.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表31.8 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表31.9 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表31.10 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表31.11 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第32章 federation
本章では、federation
コマンドに含まれるコマンドについて説明します。
32.1. federation domain list
アクセス可能なドメインをリスト表示します。
使用方法
openstack federation domain list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表32.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表32.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表32.3 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表32.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表32.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
32.2. federation project list
アクセス可能なプロジェクトをリスト表示します。
使用方法
openstack federation project list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表32.6 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表32.7 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表32.8 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表32.9 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表32.10 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
32.3. federation protocol create
新規フェデレーションプロトコルを作成します。
使用方法
openstack federation protocol create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --identity-provider <identity-provider> --mapping <mapping> <name>
表32.11 位置引数
値 | 概要 |
---|---|
<name> | 新しいフェデレーションプロトコル名 (認証プロバイダーごとに一意である必要があります) |
表32.12 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--identity-provider <identity-provider> | 新しいフェデレーションプロトコル (名前または ID) をサポートする認証プロバイダー (必須) |
--mapping <mapping> | 使用されるマッピング (名前または ID)(必須) |
表32.13 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表32.14 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表32.15 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表32.16 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
32.4. federation protocol delete
フェデレーションプロトコルを削除します。
使用方法
openstack federation protocol delete [-h] --identity-provider <identity-provider> <federation-protocol> [<federation-protocol> ...]
表32.17 位置引数
値 | 概要 |
---|---|
<federation-protocol> | 削除するフェデレーションプロトコル (名前または ID) |
表32.18 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--identity-provider <identity-provider> | <federation-protocol>(名前または ID) をサポートする認証プロバイダー (必須) |
32.5. federation protocol list
フェデレーションプロトコルをリスト表示します。
使用方法
openstack federation protocol list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] --identity-provider <identity-provider>
表32.19 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--identity-provider <identity-provider> | リスト表示する認証プロバイダー (名前または ID)(必須) |
表32.20 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表32.21 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表32.22 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表32.23 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
32.6. federation protocol set
フェデレーションプロトコルプロパティーを設定します。
使用方法
openstack federation protocol set [-h] --identity-provider <identity-provider> [--mapping <mapping>] <name>
表32.24 位置引数
値 | 概要 |
---|---|
<name> | 変更するフェデレーションプロトコル (名前または ID) |
表32.25 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--identity-provider <identity-provider> | <federation-protocol>(名前または ID) をサポートする認証プロバイダー (必須) |
--mapping <mapping> | 使用されるマッピング (名前または ID) |
32.7. federation protocol show
フェデレーションプロトコルの詳細を表示します。
使用方法
openstack federation protocol show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --identity-provider <identity-provider> <federation-protocol>
表32.26 位置引数
値 | 概要 |
---|---|
<federation-protocol> | 表示するフェデレーションプロトコル (名前または ID) |
表32.27 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--identity-provider <identity-provider> | <federation-protocol>(名前または ID) をサポートする認証プロバイダー (必須) |
表32.28 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表32.29 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表32.30 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表32.31 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第33章 flavor
本章では、flavor
コマンドに含まれるコマンドについて説明します。
33.1. flavor create
新規フレーバーを作成します。
使用方法
openstack flavor create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--id <id>] [--ram <size-mb>] [--disk <size-gb>] [--ephemeral <size-gb>] [--swap <size-mb>] [--vcpus <vcpus>] [--rxtx-factor <factor>] [--public | --private] [--property <key=value>] [--project <project>] [--description <description>] [--project-domain <project-domain>] <flavor-name>
表33.1 位置引数
値 | 概要 |
---|---|
<flavor-name> | 新規フレーバー名 |
表33.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--id <id> | 一意のフレーバー ID。uuid を自動生成します (デフォルト:auto) |
--ram <size-mb> | MB 単位のメモリーサイズ (デフォルトは 256m) |
--disk <size-gb> | GB 単位のディスクサイズ (デフォルトは 0g) |
--ephemeral <size-gb> | GB 単位の一時ディスクサイズ (デフォルトは 0g) |
--swap <size-mb> | MB 単位の追加のスワップ領域サイズ (デフォルト: 0m) |
--vcpus <vcpus> | 仮想 CPU の数 (デフォルトは 1) |
--rxtx-factor <factor> | Rx/tx ファクター (デフォルトは 1.0) |
--public | 他のプロジェクトでフレーバーが利用できます (デフォルト) |
--private | 他のプロジェクトでフレーバーは利用できません。 |
--property <key=value> | このフレーバーに追加する属性 (複数の属性を設定する場合はオプションを繰り返し使用します) |
--project <project> | <project> がプライベートフレーバー (名前または ID) にアクセスできるようにします (--private オプションと併せて使用する必要があります)。 |
--description <description> | フレーバーの説明 (api バージョン 2.55 - 2.latest でサポート) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
表33.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表33.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表33.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表33.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
33.2. flavor delete
フレーバーを削除します。
使用方法
openstack flavor delete [-h] <flavor> [<flavor> ...]
表33.7 位置引数
値 | 概要 |
---|---|
<flavor> | 削除するフレーバー (名前または ID) |
表33.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
33.3. flavor list
フレーバーをリスト表示します。
使用方法
openstack flavor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--public | --private | --all] [--long] [--marker <flavor-id>] [--limit <num-flavors>]
表33.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--public | パブリックフレーバーのみをリスト表示します (デフォルト) |
--private | プライベートフレーバーのみをリスト表示します。 |
--all | パブリックまたはプライベートのすべてのフレーバーをリスト表示します。 |
--long | 出力の追加フィールドをリスト表示します。 |
--marker <flavor-id> | 前のページにある最後のフレーバー ID |
--limit <num-flavors> | 表示するフレーバーの最大数 |
表33.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表33.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表33.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表33.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
33.4. flavor set
フレーバーのプロパティーを設定します。
使用方法
openstack flavor set [-h] [--no-property] [--property <key=value>] [--project <project>] [--description <description>] [--project-domain <project-domain>] <flavor>
表33.14 位置引数
値 | 概要 |
---|---|
<flavor> | 変更するフレーバー (名前または ID) |
表33.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--no-property | このフレーバーからすべてのプロパティーを削除します (新しいプロパティーを設定する前に現在のプロパティーを削除するには --no-property と --property の両方を指定)。 |
--property <key=value> | このフレーバーに追加または変更する属性 (複数の属性を設定する場合はオプションを繰り返し使用します) |
--project <project> | プロジェクト (名前または ID) へのフレーバーアクセスを設定します (管理者のみ)。 |
--description <description> | フレーバーの説明を設定します (api バージョン 2.55 - 2.latest でサポート) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
33.5. flavor show
フレーバーの詳細を表示します。
使用方法
openstack flavor show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <flavor>
表33.16 位置引数
値 | 概要 |
---|---|
<flavor> | 表示するフレーバー (名前または ID) |
表33.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表33.18 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表33.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表33.20 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表33.21 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
33.6. flavor unset
フレーバーのプロパティーを設定します。
使用方法
openstack flavor unset [-h] [--property <key>] [--project <project>] [--project-domain <project-domain>] <flavor>
表33.22 位置引数
値 | 概要 |
---|---|
<flavor> | 変更するフレーバー (名前または ID) |
表33.23 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--property <key> | フレーバーから削除するプロパティー (複数プロパティーの設定を解除する場合はオプションを繰り返し使用します) |
--project <project> | プロジェクト (名前または ID) からフレーバーアクセスを削除します (管理者のみ)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
第34章 floating
本章では、floating
コマンドに含まれるコマンドについて説明します。
34.1. floating ip create
Floating IP を作成します。
使用方法
openstack floating ip create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--subnet <subnet>] [--port <port>] [--floating-ip-address <ip-address>] [--fixed-ip-address <ip-address>] [--qos-policy <qos-policy>] [--description <description>] [--project <project>] [--dns-domain <dns-domain>] [--dns-name <dns-name>] [--project-domain <project-domain>] [--tag <tag> | --no-tag] <network>
表34.1 位置引数
値 | 概要 |
---|---|
<network> | Floating IP の割り当て元のネットワーク (名前または ID) |
表34.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--subnet <subnet> | Floating IP(名前または ID) を作成するサブネット |
--port <port> | Floating IP(名前または ID) に関連付けるポート |
--floating-ip-address <ip-address> | Floating IP アドレス |
--fixed-ip-address <ip-address> | Floating IP にマッピングされた Fixed IP アドレス |
--qos-policy <qos-policy> | Floating IP(名前または ID) に qos ポリシーを割り当てます。 |
--description <description> | Floating IP の説明を設定します。 |
--project <project> | 所有者のプロジェクト (名前または ID) |
--dns-domain <dns-domain> | この Floating IP に DNS ドメインを設定します。 |
--dns-name <dns-name> | この Floating IP に DNS 名を設定します。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--tag <tag> | Floating IP に追加するタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--no-tag | Floating IP にタグを関連付けない |
表34.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表34.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表34.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表34.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
34.2. floating ip delete
Floating IP を削除します。
使用方法
openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]
表34.7 位置引数
値 | 概要 |
---|---|
<floating-ip> | 削除する Floating IP(IP アドレスまたは ID) |
表34.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
34.3. floating ip list
Floating IP をリスト表示します。
使用方法
openstack floating ip list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--network <network>] [--port <port>] [--fixed-ip-address <ip-address>] [--floating-ip-address <ip-address>] [--long] [--status <status>] [--project <project>] [--project-domain <project-domain>] [--router <router>] [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]] [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]]
表34.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--network <network> | 指定されたネットワーク (名前または ID) に従って Floating IP をリスト表示します。 |
--port <port> | 指定ポート (名前または ID) に従って Floating IP をリスト表示します。 |
--fixed-ip-address <ip-address> | 指定の Fixed IP アドレスに従って、Floating IP をリスト表示します。 |
--floating-ip-address <ip-address> | 指定の Floating IP アドレスに従って Floating IP をリスト表示します。 |
--long | 出力の追加フィールドをリスト表示します。 |
--status <status> | 指定されたステータス (ACTIVE, DOWN) に従って Floating IP をリスト表示します。 |
--project <project> | 指定のプロジェクト (名前または ID) に従って Floating IP をリスト表示します。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--router <router> | 指定のルーター (名前または ID) に従って Floating IP をリスト表示します。 |
--tags <tag>[,<tag>,…] | 指定されたタグ (タグのコンマ区切りリスト) がすべて割り当てられた Floating IP をリスト表示します。 |
--any-tags <tag>[,<tag>,…] | 指定されたタグ (タグのコンマ区切りリスト) のいずれかが割り当てられた Floating IP をリスト表示します。 |
--not-tags <tag>[,<tag>,…] | 指定されたタグ (タグのコンマ区切りリスト) がすべて割り当てられた Floating IP を除外します。 |
--not-any-tags <tag>[,<tag>,…] | 指定されたタグ (タグのコンマ区切りリスト) のいずれかが割り当てられた Floating IP を除外します。 |
表34.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表34.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表34.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表34.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
34.4. floating ip pool list
Floating IP アドレスのプールをリスト表示します。
使用方法
openstack floating ip pool list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表34.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表34.15 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表34.16 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表34.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表34.18 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
34.5. floating ip port forwarding create
Floating IP ポート転送を作成します。
使用方法
openstack floating ip port forwarding create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --internal-ip-address <internal-ip-address> --port <port> --internal-protocol-port <port-number> --external-protocol-port <port-number> --protocol <protocol> <floating-ip>
表34.19 位置引数
値 | 概要 |
---|---|
<floating-ip> | ポート転送が属する Floating IP(IP アドレスまたは ID) |
表34.20 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--internal-ip-address <internal-ip-address> | Floating IP ポート転送に関連付けられたネットワークポートの Fixed ipv4 アドレス |
--port <port> | Floating IP ポート転送に関連付けられたネットワークポートの名前または ID |
--internal-protocol-port <port-number> | Floating IP ポート転送に関連付けられたネットワークポートの Fixed IPv4 アドレスのプロトコルポート番号 |
--external-protocol-port <port-number> | ポート転送の Floating IP アドレスのプロトコルポート番号 |
--protocol <protocol> | Floating IP ポート転送で使用されるプロトコル:TCP、UDP |
表34.21 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表34.22 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表34.23 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表34.24 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
34.6. Floating ip port forwarding delete
Floating IP ポート転送を削除します。
使用方法
openstack floating ip port forwarding delete [-h] <floating-ip> <port-forwarding-id> [<port-forwarding-id> ...]
表34.25 位置引数
値 | 概要 |
---|---|
<floating-ip> | ポート転送が属する Floating IP(IP アドレスまたは ID) |
<port-forwarding-id> | 削除する Floating IP ポート転送の ID |
表34.26 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
34.7. floating ip port forwarding list
Floating IP ポート転送をリスト表示します。
使用方法
openstack floating ip port forwarding list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--port <port>] [--external-protocol-port <port-number>] [--protocol protocol] <floating-ip>
表34.27 位置引数
値 | 概要 |
---|---|
<floating-ip> | ポート転送が属する Floating IP(IP アドレスまたは ID) |
表34.28 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--port <port> | 内部ネットワークポートの ID または名前でリストの結果をフィルタリングします |
--external-protocol-port <port-number> | Floating IP のプロトコルポート番号で結果を絞り込みます。 |
--protocol protocol | ポートプロトコルでリストの結果をフィルタリングします |
表34.29 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表34.30 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表34.31 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表34.32 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
34.8. floating ip port forwarding set
Floating IP ポート転送プロパティーを設定します。
使用方法
openstack floating ip port forwarding set [-h] [--port <port>] [--internal-ip-address <internal-ip-address>] [--internal-protocol-port <port-number>] [--external-protocol-port <port-number>] [--protocol <protocol>] <floating-ip> <port-forwarding-id>
表34.33 位置引数
値 | 概要 |
---|---|
<floating-ip> | ポート転送が属する Floating IP(IP アドレスまたは ID) |
<port-forwarding-id> | Floating IP ポート転送の ID |
表34.34 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--port <port> | Floating IP ポート転送に関連付けられたネットワークポートの ID |
--internal-ip-address <internal-ip-address> | Floating IP ポート転送に関連付けられたネットワークポートの Fixed ipv4 アドレス |
--internal-protocol-port <port-number> | Floating IP ポート転送に関連付けられたネットワークポートの Fixed IPv4 アドレスの tcp/udp/other プロトコルポート番号 |
--external-protocol-port <port-number> | ポート転送の Floating IP アドレスの tcp/udp/other プロトコルポート番号 |
--protocol <protocol> | Floating IP ポート転送で使用されるプロトコル |
34.9. floating ip port forwarding show
Floating IP ポート転送の詳細を表示します。
使用方法
openstack floating ip port forwarding show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <floating-ip> <port-forwarding-id>
表34.35 位置引数
値 | 概要 |
---|---|
<floating-ip> | ポート転送が属する Floating IP(IP アドレスまたは ID) |
<port-forwarding-id> | Floating IP ポート転送の ID |
表34.36 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表34.37 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表34.38 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表34.39 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表34.40 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
34.10. floating ip set
Floating IP 属性を設定します。
使用方法
openstack floating ip set [-h] [--port <port>] [--fixed-ip-address <ip-address>] [--qos-policy <qos-policy> | --no-qos-policy] [--tag <tag>] [--no-tag] <floating-ip>
表34.41 位置引数
値 | 概要 |
---|---|
<floating-ip> | 変更する Floating IP(IP アドレスまたは ID) |
表34.42 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--port <port> | Floating IP をポートに関連付けます (名前または ID)。 |
--fixed-ip-address <ip-address> | ポートの Fixed IP(ポートに複数の IP がある場合のみ必要) |
--qos-policy <qos-policy> | Floating IP(名前または ID) に qos ポリシーを割り当てます。 |
--no-qos-policy | Floating IP に割り当てられた qos ポリシーを削除します。 |
--tag <tag> | Floating IP に追加するタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--no-tag | Floating IP に関連付けられたタグをクリアします。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。 |
34.11. floating ip show
Floating IP の詳細を表示します。
使用方法
openstack floating ip show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <floating-ip>
表34.43 位置引数
値 | 概要 |
---|---|
<floating-ip> | 表示する Floating IP(IP アドレスまたは ID) |
表34.44 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表34.45 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表34.46 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表34.47 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表34.48 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
34.12. floating ip unset
Floating IP 属性の設定を解除します。
使用方法
openstack floating ip unset [-h] [--port] [--qos-policy] [--tag <tag> | --all-tag] <floating-ip>
表34.49 位置引数
値 | 概要 |
---|---|
<floating-ip> | 関連付けを解除する Floating IP(IP アドレスまたは ID) |
表34.50 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--port | Floating IP に関連付けられたポートの関連付けを解除します。 |
--qos-policy | Floating IP に割り当てられた qos ポリシーを削除します。 |
--tag <tag> | Floating IP から削除するタグ (複数のタグを削除する場合はオプションを繰り返し使用します) |
--all-tag | Floating IP に関連付けられたすべてのタグをクリアします。 |
第35章 group
本章では、group
コマンドに含まれるコマンドについて説明します。
35.1. group add user
ユーザーをグループに追加します。
使用方法
openstack group add user [-h] [--group-domain <group-domain>] [--user-domain <user-domain>] <group> <user> [<user> ...]
表35.1 位置引数
値 | 概要 |
---|---|
<group> | <user>が含まれるグループ (名前または ID) |
<user> | <group>(名前または ID) に追加するユーザー (複数のユーザーを追加する場合はオプションを繰り返し使用します) |
表35.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--group-domain <group-domain> | グループが所属するドメイン (名前または ID)。グループ名の競合が発生した場合に、使用できます。 |
--user-domain <user-domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
35.2. group contains user
グループ内のユーザーメンバーシップを確認します。
使用方法
openstack group contains user [-h] [--group-domain <group-domain>] [--user-domain <user-domain>] <group> <user>
表35.3 位置引数
値 | 概要 |
---|---|
<group> | チェックするグループ (名前または ID) |
<user> | 確認するユーザー (名前または ID) |
表35.4 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--group-domain <group-domain> | グループが所属するドメイン (名前または ID)。グループ名の競合が発生した場合に、使用できます。 |
--user-domain <user-domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
35.3. group create
新規グループを作成します。
使用方法
openstack group create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--domain <domain>] [--description <description>] [--or-show] <group-name>
表35.5 位置引数
値 | 概要 |
---|---|
<group-name> | 新しいグループ名 |
表35.6 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | 新しいグループが含まれるドメイン (名前または ID) |
--description <description> | 新しいグループの説明 |
--or-show | 既存グループを返します。 |
表35.7 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表35.8 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表35.9 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表35.10 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
35.4. group delete
グループを削除します。
使用方法
openstack group delete [-h] [--domain <domain>] <group> [<group> ...]
表35.11 位置引数
値 | 概要 |
---|---|
<group> | 削除するグループ (名前または ID) |
表35.12 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | グループが含まれるドメイン (名前または ID) |
35.5. group list
グループのリスト表示
使用方法
openstack group list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--domain <domain>] [--user <user>] [--user-domain <user-domain>] [--long]
表35.13 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | <domain>でグループリストをフィルターします (名前または ID)。 |
--user <user> | <user>でグループリストをフィルターします (名前または ID)。 |
--user-domain <user-domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
--long | 出力の追加フィールドをリスト表示します。 |
表35.14 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表35.15 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表35.16 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表35.17 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
35.6. group remove user
グループからユーザーを削除します。
使用方法
openstack group remove user [-h] [--group-domain <group-domain>] [--user-domain <user-domain>] <group> <user> [<user> ...]
表35.18 位置引数
値 | 概要 |
---|---|
<group> | <user>が含まれるグループ (名前または ID) |
<user> | <group> (名前または id) から削除するユーザー (複数のボリュームを削除する場合はオプションを繰り返し使用します) |
表35.19 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--group-domain <group-domain> | グループが所属するドメイン (名前または ID)。グループ名の競合が発生した場合に、使用できます。 |
--user-domain <user-domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
35.7. group set
グループ属性を設定します。
使用方法
openstack group set [-h] [--domain <domain>] [--name <name>] [--description <description>] <group>
表35.20 位置引数
値 | 概要 |
---|---|
<group> | 変更するグループ (名前または ID) |
表35.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | <group>が含まれるドメイン (名前または ID) |
--name <name> | 新しいグループ名 |
--description <description> | 新しいグループの説明 |
35.8. group show
グループの詳細を表示します。
使用方法
openstack group show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--domain <domain>] <group>
表35.22 位置引数
値 | 概要 |
---|---|
<group> | 表示するグループ (名前または ID) |
表35.23 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | <group>が含まれるドメイン (名前または ID) |
表35.24 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表35.25 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表35.26 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表35.27 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第36章 help
この章では、help
コマンドに含まれるコマンドについて説明します。
36.1. help
別のコマンドの詳細なヘルプを出力します。
使用方法
openstack help [-h] [cmd [cmd ...]]
表36.1 位置引数
値 | 概要 |
---|---|
cmd | コマンドの名前 |
表36.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
第37章 ホスト
本章では、host
コマンドに含まれるコマンドについて説明します。
37.1. host list
ホストをリスト表示します。
使用方法
openstack host list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--zone <zone>]
表37.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--zone <zone> | アベイラビリティーゾーン内のホストのみを返します。 |
表37.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表37.3 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表37.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表37.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
37.2. host set
ホスト属性を設定します。
使用方法
openstack host set [-h] [--enable | --disable] [--enable-maintenance | --disable-maintenance] <host>
表37.6 位置引数
値 | 概要 |
---|---|
<host> | 変更するホスト (名前のみ) |
表37.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--enable | ホストを有効にします。 |
--disable | ホストを無効にします。 |
--enable-maintenance | ホストのメンテナンスモードを有効にします。 |
--disable-maintenance | ホストのメンテナンスモードを無効にします。 |
37.3. host show
ホストの詳細を表示します。
使用方法
openstack host show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <host>
表37.8 位置引数
値 | 概要 |
---|---|
<host> | ホスト名 |
表37.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表37.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表37.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表37.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表37.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第38章 hypervisor
本章では、hypervisor
コマンドに含まれるコマンドについて説明します。
38.1. hypervisor list
ハイパーバイザーをリスト表示します。
使用方法
openstack hypervisor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--matching <hostname>] [--long]
表38.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--matching <hostname> | <hostname> 部分文字列を使用してハイパーバイザーをフィルターします。 |
--long | 出力の追加フィールドをリスト表示します。 |
表38.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表38.3 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表38.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表38.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
38.2. hypervisor show
ハイパーバイザーの詳細を表示します。
使用方法
openstack hypervisor show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <hypervisor>
表38.6 位置引数
値 | 概要 |
---|---|
<hypervisor> | 表示するハイパーバイザー (名前または ID) |
表38.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表38.8 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表38.9 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表38.10 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表38.11 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
38.3. hypervisor stats show
ハイパーバイザーの統計情報を表示します。
使用方法
openstack hypervisor stats show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
表38.12 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表38.13 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表38.14 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表38.15 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表38.16 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第39章 identity
本章では、identity
コマンドに含まれるコマンドについて説明します。
39.1. identity provider create
新規認証プロバイダーを作成します。
使用方法
openstack identity provider create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--remote-id <remote-id> | --remote-id-file <file-name>] [--description <description>] [--domain <domain>] [--enable | --disable] <name>
表39.1 位置引数
値 | 概要 |
---|---|
<name> | 新しい認証プロバイダー名 (一意である必要があります) |
表39.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--remote-id <remote-id> | 認証プロバイダーに関連付けるリモート ID(複数の値を指定する場合はオプションを繰り返し使用します) |
--remote-id-file <file-name> | 認証プロバイダーに関連付ける多数のリモート ID が含まれるファイルの名前 (行ごとに 1 つ) |
--description <description> | 新規の認証プロバイダーの説明 |
--domain <domain> | 認証プロバイダーに関連付けるドメイン。指定されていない場合、ドメインが自動的に作成されます。(名前または ID) |
--enable | 認証プロバイダーを有効にします (デフォルト)。 |
--disable | 認証プロバイダーを無効にします。 |
表39.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表39.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表39.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表39.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
39.2. identity provider delete
認証プロバイダーを削除します。
使用方法
openstack identity provider delete [-h] <identity-provider> [<identity-provider> ...]
表39.7 位置引数
値 | 概要 |
---|---|
<identity-provider> | 削除する認証プロバイダー |
表39.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
39.3. identity provider list
認証プロバイダーをリスト表示します。
使用方法
openstack identity provider list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表39.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表39.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表39.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表39.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表39.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
39.4. identity provider set
認証プロバイダー属性を設定します。
使用方法
openstack identity provider set [-h] [--description <description>] [--remote-id <remote-id> | --remote-id-file <file-name>] [--enable | --disable] <identity-provider>
表39.14 位置引数
値 | 概要 |
---|---|
<identity-provider> | 変更する認証プロバイダー |
表39.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | 認証プロバイダーの説明を設定します。 |
--remote-id <remote-id> | 認証プロバイダーに関連付けるリモート ID(複数の値を指定する場合はオプションを繰り返し使用します) |
--remote-id-file <file-name> | 認証プロバイダーに関連付ける多数のリモート ID が含まれるファイルの名前 (行ごとに 1 つ) |
--enable | 認証プロバイダーを有効にします。 |
--disable | 認証プロバイダーを無効にします。 |
39.5. identity provider show
認証プロバイダーの詳細を表示します。
使用方法
openstack identity provider show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <identity-provider>
表39.16 位置引数
値 | 概要 |
---|---|
<identity-provider> | 表示する認証プロバイダー |
表39.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表39.18 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表39.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表39.20 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表39.21 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第40章 image
本章では、image
コマンドに含まれるコマンドについて説明します。
40.1. image add project
プロジェクトをイメージに関連付けます。
使用方法
openstack image add project [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--project-domain <project-domain>] <image> <project>
表40.1 位置引数
値 | 概要 |
---|---|
<image> | 共有するイメージ (名前または ID) |
<project> | イメージに関連付けるプロジェクト (id) |
表40.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
表40.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表40.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表40.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表40.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
40.2. image create
イメージを作成/アップロードします。
使用方法
openstack image create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--id <id>] [--container-format <container-format>] [--disk-format <disk-format>] [--min-disk <disk-gb>] [--min-ram <ram-mb>] [--file <file> | --volume <volume>] [--force] [--sign-key-path <sign-key-path>] [--sign-cert-id <sign-cert-id>] [--protected | --unprotected] [--public | --private | --community | --shared] [--property <key=value>] [--tag <tag>] [--project <project>] [--project-domain <project-domain>] <image-name>
表40.7 位置引数
値 | 概要 |
---|---|
<image-name> | 新しいイメージ名 |
表40.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--id <id> | 予約するイメージ ID |
--container-format <container-format> | イメージコンテナーの形式。サポートされるオプションは ami、ari、aki、bare、docker、ova、ovf です。デフォルトの形式は bare です。 |
--disk-format <disk-format> | イメージディスクの形式。サポートされるオプションは ami、ari、aki、vhd、vmdk、raw、qcow2、vhdx、vdi、iso、ploop です。デフォルトの形式は raw です。 |
--min-disk <disk-gb> | イメージのブートに必要な最小ディスクサイズ (ギガバイト単位) |
--min-ram <ram-mb> | イメージのブートに必要な最小 RAM サイズ (メガバイト単位) |
--file <file> | ローカルファイルからイメージをアップロードします。 |
--volume <volume> | ボリュームからイメージを作成します。 |
--force | ボリュームが使用中の場合にイメージ作成を強制的に実行します (--volume と共に使用する場合にのみ意味があります)。 |
--sign-key-path <sign-key-path> | 指定した秘密鍵を使用してイメージを署名します。--sign-cert-id と併用する場合にのみ使用します。 |
--sign-cert-id <sign-cert-id> | 指定された証明書の uuid は、公開鍵に対応し、署名の検証に使用されるキーマネージャーの証明書への参照です。--sign-key-path と併用する場合にのみ使用します。 |
--protected | イメージが削除されないようにします。 |
--unprotected | イメージの削除を許可します (デフォルト) |
--public | イメージは一般に公開されます。 |
--private | イメージは一般に公開されません (デフォルト)。 |
--community | イメージはコミュニティーに公開されます。 |
--shared | イメージを共有可能です。 |
--property <key=value> | このイメージにプロパティーを設定します (複数のプロパティーを設定する場合はオプションを繰り返し使用します)。 |
--tag <tag> | このイメージにタグを設定します (複数のタグを設定する場合はオプションを繰り返し使用します)。 |
--project <project> | このイメージの代替プロジェクトを設定します (名前または ID)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
表40.9 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表40.10 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表40.11 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表40.12 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
40.3. image delete
イメージを削除します。
使用方法
openstack image delete [-h] <image> [<image> ...]
表40.13 位置引数
値 | 概要 |
---|---|
<image> | 削除するイメージ (名前または ID) |
表40.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
40.4. image list
利用可能なイメージをリスト表示します。
使用方法
openstack image list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--public | --private | --community | --shared] [--property <key=value>] [--name <name>] [--status <status>] [--member-status <member-status>] [--tag <tag>] [--long] [--sort <key>[:<direction>]] [--limit <num-images>] [--marker <image>]
表40.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--public | パブリックイメージのみをリスト表示します。 |
--private | プライベートイメージのみをリスト表示します。 |
--community | コミュニティーイメージのみをリスト表示します。 |
--shared | 共有イメージのみをリスト表示します。 |
--property <key=value> | プロパティーに基づいて出力をフィルターします (複数のプロパティーでフィルタリングする場合はオプションを繰り返し使用します) |
--name <name> | 名前に基づいてイメージをフィルタリングします。 |
--status <status> | ステータスに基づいてイメージをフィルタリングします。 |
--member-status <member-status> | メンバーステータスをもとにイメージをフィルターします。サポートされるオプションは、accepted、pending、rejected、all です。 |
--tag <tag> | タグに基づいてイメージをフィルタリングします。 |
--long | 出力の追加フィールドをリスト表示します。 |
--sort <key>[:<direction>] | 選択した鍵と方向 (asc または desc) で出力をソートします (デフォルト:name:asc)。複数のキーと方向をコンマで区切ることができます。 |
--limit <num-images> | 表示するイメージの最大数。 |
--marker <image> | 前のページにある最後のイメージ。マーカーの後にイメージのリストを表示します。指定されていない場合には、すべてのイメージを表示します (名前または ID)。 |
表40.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表40.17 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表40.18 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表40.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
40.5. image member list
イメージに関連付けられたプロジェクトをリスト表示します。
使用方法
openstack image member list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--project-domain <project-domain>] <image>
表40.20 位置引数
値 | 概要 |
---|---|
<image> | イメージ (名前または ID) |
表40.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
表40.22 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表40.23 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表40.24 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表40.25 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
40.6. image remove project
イメージとプロジェクトの関連付けを解除します。
使用方法
openstack image remove project [-h] [--project-domain <project-domain>] <image> <project>
表40.26 位置引数
値 | 概要 |
---|---|
<image> | 共有を解除するイメージ (名前または ID) |
<project> | イメージとの関連付けを解除するプロジェクト (名前または ID) |
表40.27 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
40.7. image save
イメージをローカルに保存します。
使用方法
openstack image save [-h] [--file <filename>] <image>
表40.28 位置引数
値 | 概要 |
---|---|
<image> | 保存するイメージ (名前または ID) |
表40.29 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--file <filename> | ダウンロードしたイメージを保存するファイル名 (デフォルト:stdout) |
40.8. image set
イメージ属性を設定します。
使用方法
openstack image set [-h] [--name <name>] [--min-disk <disk-gb>] [--min-ram <ram-mb>] [--container-format <container-format>] [--disk-format <disk-format>] [--protected | --unprotected] [--public | --private | --community | --shared] [--property <key=value>] [--tag <tag>] [--architecture <architecture>] [--instance-id <instance-id>] [--kernel-id <kernel-id>] [--os-distro <os-distro>] [--os-version <os-version>] [--ramdisk-id <ramdisk-id>] [--deactivate | --activate] [--project <project>] [--project-domain <project-domain>] [--accept | --reject | --pending] <image>
表40.30 位置引数
値 | 概要 |
---|---|
<image> | 変更するイメージ (名前または ID) |
表40.31 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 新しいイメージ名 |
--min-disk <disk-gb> | イメージのブートに必要な最小ディスクサイズ (ギガバイト単位) |
--min-ram <ram-mb> | イメージのブートに必要な最小 RAM サイズ (メガバイト単位) |
--container-format <container-format> | イメージコンテナーの形式。サポートされるオプションは ami、ari、aki、bare、docker、ova、ovf です。 |
--disk-format <disk-format> | イメージディスクの形式。サポートされるオプションは ami、ari、aki、vhd、vmdk、raw、qcow2、vhdx、vdi、iso、ploop です。 |
--protected | イメージが削除されないようにします。 |
--unprotected | イメージの削除を許可します (デフォルト) |
--public | イメージは一般に公開されます。 |
--private | イメージは一般に公開されません (デフォルト)。 |
--community | イメージはコミュニティーに公開されます。 |
--shared | イメージを共有可能です。 |
--property <key=value> | このイメージにプロパティーを設定します (複数のプロパティーを設定する場合はオプションを繰り返し使用します)。 |
--tag <tag> | このイメージにタグを設定します (複数のタグを設定する場合はオプションを繰り返し使用します)。 |
--architecture <architecture> | オペレーティングシステムのアーキテクチャー |
--instance-id <instance-id> | このイメージの作成に使用するサーバーインスタンスの ID |
--kernel-id <kernel-id> | このディスクイメージのブートに使用するカーネルイメージの ID |
--os-distro <os-distro> | オペレーティングシステムのディストリビューション名 |
--os-version <os-version> | オペレーティングシステムディストリビューションのバージョン |
--ramdisk-id <ramdisk-id> | このディスクイメージのブートに使用する ramdisk イメージの ID |
--deactivate | イメージを非アクティブ化します。 |
--activate | イメージをアクティベートします。 |
--project <project> | このイメージの代替プロジェクトを設定します (名前または ID)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--accept | イメージメンバーシップを許可します。 |
--reject | イメージメンバーシップを拒否します。 |
--pending | イメージのメンバーシップを 保留中にリセットします。 |
40.9. image show
イメージの詳細を表示します。
使用方法
openstack image show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--human-readable] <image>
表40.32 位置引数
値 | 概要 |
---|---|
<image> | 表示するイメージ (名前または ID) |
表40.33 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--human-readable | 人間が解読しやすい形式でイメージサイズを出力します。 |
表40.34 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表40.35 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表40.36 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表40.37 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
40.10. image unset
イメージタグおよび属性の設定を解除します。
使用方法
openstack image unset [-h] [--tag <tag>] [--property <property-key>] <image>
表40.38 位置引数
値 | 概要 |
---|---|
<image> | 変更するイメージ (名前または ID) |
表40.39 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--tag <tag> | このイメージのタグ設定を解除します (複数のタグの設定を解除する場合はオプションを繰り返し使用します)。 |
--property <property-key> | このイメージのプロパティーの設定を解除します (複数のプロパティー設定を解除する場合はオプションを繰り返し使用します)。 |
第41章 implied
本章では、implied
コマンドに含まれるコマンドについて説明します。
41.1. implied role create
以前のロールと暗黙的なロール間の関連付けを作成します。
使用方法
openstack implied role create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --implied-role <role> <role>
表41.1 位置引数
値 | 概要 |
---|---|
<role> | 別のロールを暗示するロール (名前または ID) |
表41.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--implied-role <role> | 別のロールによって暗示される<role>(名前または id) |
表41.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表41.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表41.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表41.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
41.2. implied role delete
以前のロールと暗黙的なロール間の関連付けを削除します。
使用方法
openstack implied role delete [-h] --implied-role <role> <role>
表41.7 位置引数
値 | 概要 |
---|---|
<role> | 別のロールを暗示するロール (名前または ID) |
表41.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--implied-role <role> | 別のロールによって暗示される<role>(名前または id) |
41.3. implied role list
暗黙的なロールをリスト表示します。
使用方法
openstack implied role list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表41.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表41.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表41.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表41.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表41.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第42章 ip
本章では、ip
コマンドに含まれるコマンドについて説明します。
42.1. ip availability list
ネットワークの IP の可用性をリスト表示します。
使用方法
openstack ip availability list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--ip-version <ip-version>] [--project <project>] [--project-domain <project-domain>]
表42.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--ip-version <ip-version> | 指定した ip バージョンのネットワーク (デフォルトは 4) の ip の可用性をリスト表示します。 |
--project <project> | 指定されたプロジェクトの ip の可用性をリスト表示します (名前または ID)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
表42.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表42.3 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表42.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表42.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
42.2. ip availability show
ネットワーク IP の可用性の詳細を表示します。
使用方法
openstack ip availability show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <network>
表42.6 位置引数
値 | 概要 |
---|---|
<network> | 特定のネットワークの ip 可用性を表示します (名前または ID)。 |
表42.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表42.8 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表42.9 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表42.10 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表42.11 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第43章 keypair
本章では、keypair
コマンドに含まれるコマンドについて説明します。
43.1. keypair create
サーバーの ssh アクセス用に新しい公開鍵または秘密鍵を作成します。
使用方法
openstack keypair create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--public-key <file> | --private-key <file>] <name>
表43.1 位置引数
値 | 概要 |
---|---|
<name> | 新しい公開鍵または秘密鍵名 |
表43.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--public-key <file> | 追加する公開鍵のファイル名。使用されていない場合は、秘密鍵を作成します。 |
--private-key <file> | 保存する秘密鍵のファイル名。使用されていない場合は、秘密鍵をコンソールに出力します。 |
表43.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表43.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表43.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表43.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
43.2. keypair delete
公開鍵または秘密鍵を削除します。
使用方法
openstack keypair delete [-h] <key> [<key> ...]
表43.7 位置引数
値 | 概要 |
---|---|
<key> | 削除する鍵の名前 (名前のみ) |
表43.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
43.3. keypair list
鍵のフィンガープリントをリスト表示します。
使用方法
openstack keypair list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表43.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表43.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表43.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表43.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表43.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
43.4. keypair show
鍵の詳細を表示します。
使用方法
openstack keypair show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--public-key] <key>
表43.14 位置引数
値 | 概要 |
---|---|
<key> | 表示する公開鍵または秘密鍵 (名前のみ) |
表43.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--public-key | 生成された鍵とペアになったベア公開鍵のみを表示します。 |
表43.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表43.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表43.18 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表43.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第44章 l2gw
本章では、l2gw
コマンドに含まれるコマンドについて説明します。
44.1. l2gw connection create
l2gateway-connection を作成します。
使用方法
openstack l2gw connection create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--default-segmentation-id SEG_ID] <GATEWAY-NAME/UUID> <NETWORK-NAME/UUID>
表44.1 位置引数
値 | 概要 |
---|---|
<GATEWAY-NAME/UUID> | 論理ゲートウェイの説明的な名前。 |
<NETWORK-NAME/UUID> | ネットワーク名または uuid |
表44.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--default-segmentation-id SEG_ID | l2-gateway-create コマンドでセグメンテーション ID が指定されていなかったインターフェイスに適用されるデフォルトのセグメンテーション ID。 |
表44.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表44.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表44.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表44.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
44.2. l2gw connection delete
指定した l2gateway-connection を削除します。
使用方法
openstack l2gw connection delete [-h] <L2_GATEWAY_CONNECTIONS> [<L2_GATEWAY_CONNECTIONS> ...]
表44.7 位置引数
値 | 概要 |
---|---|
<L2_GATEWAY_CONNECTIONS> | 削除する l2_gateway_connections(s) の ID。 |
表44.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
44.3. l2gw connection list
l2gateway-connections をリスト表示します。
使用方法
openstack l2gw connection list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--project <project>] [--project-domain <project-domain>]
表44.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
表44.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表44.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表44.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表44.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
44.4. l2gw connection show
指定した l2gateway-connection の情報を表示します。
使用方法
openstack l2gw connection show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <L2_GATEWAY_CONNECTION>
表44.14 位置引数
値 | 概要 |
---|---|
<L2_GATEWAY_CONNECTION> | 検索する l2_gateway_connection の ID。 |
表44.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表44.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表44.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表44.18 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表44.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
44.5. l2gw create
l2gateway リソースを作成します。
使用方法
openstack l2gw create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--project <project>] [--project-domain <project-domain>] [--device name=name,interface_names=INTERFACE-DETAILS] <GATEWAY-NAME>
表44.20 位置引数
値 | 概要 |
---|---|
<GATEWAY-NAME> | 論理ゲートウェイの説明的な名前。 |
表44.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--device name=name,interface_names=INTERFACE-DETAILS | l2gateway のデバイス名およびインターフェイス名。INTERFACE-DETAILS の形式は"<interface_name1>;[<inte rface_name2>][|<seg_id1>[#<seg_id2>]]"です (--device オプションを繰り返し使用できます)。 |
表44.22 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表44.23 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表44.24 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表44.25 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
44.6. l2gw delete
指定の l2gateway を削除します。
使用方法
openstack l2gw delete [-h] <L2_GATEWAY> [<L2_GATEWAY> ...]
表44.26 位置引数
値 | 概要 |
---|---|
<L2_GATEWAY> | 削除する l2_gateway の ID または名前。 |
表44.27 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
44.7. l2gw list
指定のテナントに属する l2gateway をリスト表示します。
使用方法
openstack l2gw list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--project <project>] [--project-domain <project-domain>]
表44.28 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
表44.29 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表44.30 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表44.31 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表44.32 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
44.8. l2gw show
指定の l2gateway の情報を表示します。
使用方法
openstack l2gw show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <L2_GATEWAY>
表44.33 位置引数
値 | 概要 |
---|---|
<L2_GATEWAY> | 検索する l2_gateway の ID または名前。 |
表44.34 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表44.35 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表44.36 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表44.37 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表44.38 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
44.9. l2gw update
指定の l2gateway を更新します。
使用方法
openstack l2gw update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name name] [--device name=name,interface_names=INTERFACE-DETAILS] <L2_GATEWAY>
表44.39 位置引数
値 | 概要 |
---|---|
<L2_GATEWAY> | 更新する l2_gateway の ID または名前。 |
表44.40 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name name | 論理ゲートウェイの説明的な名前。 |
--device name=name,interface_names=INTERFACE-DETAILS | l2gateway のデバイス名およびインターフェイス名。INTERFACE-DETAILS の形式は"<interface_name1>;[<inte rface_name2>][|<seg_id1>[#<seg_id2>]]"です (--device オプションを繰り返し使用できます)。 |
表44.41 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表44.42 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表44.43 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表44.44 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第45章 limit
本章では、limit
コマンドに含まれるコマンドについて説明します。
45.1. limit create
制限を作成します。
使用方法
openstack limit create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--region <region>] --project <project> --service <service> --resource-limit <resource-limit> <resource-name>
表45.1 位置引数
値 | 概要 |
---|---|
<resource-name> | 制限するリソースの名前 |
表45.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | 制限の説明 |
--region <region> | 影響する制限のリージョン。 |
--project <project> | リソース制限を関連付けるプロジェクト |
--service <service> | 制限するリソースに関するサービス |
--resource-limit <resource-limit> | 想定するプロジェクトのリソース制限 |
表45.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表45.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表45.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表45.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
45.2. limit delete
制限を削除します。
使用方法
openstack limit delete [-h] <limit-id> [<limit-id> ...]
表45.7 位置引数
値 | 概要 |
---|---|
<limit-id> | 削除の制限 (id) |
表45.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
45.3. limit list
制限をリスト表示します。
使用方法
openstack limit list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--service <service>] [--resource-name <resource-name>] [--region <region>] [--project <project>]
表45.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--service <service> | 制限するリソースに関するサービス |
--resource-name <resource-name> | 制限するリソースの名前 |
--region <region> | 影響する登録された制限のリージョン。 |
--project <project> | プロジェクトに関連付けられたリソース制限をリスト表示します。 |
表45.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表45.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表45.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表45.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
45.4. limit set
制限に関する情報を更新します。
使用方法
openstack limit set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--resource-limit <resource-limit>] <limit-id>
表45.14 位置引数
値 | 概要 |
---|---|
<limit-id> | 更新する制限 (id) |
表45.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | 制限の説明 |
--resource-limit <resource-limit> | 想定するプロジェクトのリソース制限 |
表45.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表45.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表45.18 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表45.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
45.5. limit show
制限の詳細を表示します。
使用方法
openstack limit show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <limit-id>
表45.20 位置引数
値 | 概要 |
---|---|
<limit-id> | 表示する制限 (id) |
表45.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表45.22 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表45.23 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表45.24 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表45.25 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第46章 limits
本章では、limits
コマンドに含まれるコマンドについて説明します。
46.1. limits show
コンピュートおよびブロックストレージの制限を表示します。
使用方法
openstack limits show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] (--absolute | --rate) [--reserved] [--project <project>] [--domain <domain>]
表46.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--absolute | 絶対制限を表示します。 |
--rate | 流量制御の表示 |
--reserved | 予約数を含めます [--absolute と共に使用する場合にのみ有効]。 |
--project <project> | 特定のプロジェクト (名前または ID) の制限を表示します [--absolute と共に使用する場合にのみ有効]。 |
--domain <domain> | プロジェクトが属するドメイン (名前または ID)[--absolute と共に使用する場合にのみ有効]。 |
表46.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表46.3 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表46.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表46.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第47章 loadbalancer
本章では、loadbalancer
コマンドに含まれるコマンドについて説明します。
47.1. loadbalancer amphora configure
amphora エージェントの設定を更新します。
使用方法
openstack loadbalancer amphora configure [-h] <amphora-id>
表47.1 位置引数
値 | 概要 |
---|---|
<amphora-id> | 設定する amphora の UUID |
表47.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
47.2. loadbalancer amphora failover
amphora を強制的にフェイルオーバーします。
使用方法
openstack loadbalancer amphora failover [-h] <amphora-id>
表47.3 位置引数
値 | 概要 |
---|---|
<amphora-id> | amphora の UUID |
表47.4 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
47.3. loadbalancer amphora list
amphora をリスト表示します。
使用方法
openstack loadbalancer amphora list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--loadbalancer <loadbalancer>] [--compute-id <compute-id>] [--role {BACKUP,MASTER,STANDALONE}] [--status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}]
表47.5 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--loadbalancer <loadbalancer> | ロードバランサーでフィルタリングします (名前または ID)。 |
--compute-id <compute-id> | コンピュート ID でフィルタリングします。 |
--role {BACKUP,MASTER,STANDALONE} | ロールでフィルタリングします。 |
--status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}, --provisioning-status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY} | amphora のプロビジョニングステータスでフィルタリングします。 |
表47.6 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表47.7 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表47.8 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.9 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.4. loadbalancer amphora show
1 つの amphora の詳細を表示します。
使用方法
openstack loadbalancer amphora show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <amphora-id>
表47.10 位置引数
値 | 概要 |
---|---|
<amphora-id> | amphora の UUID |
表47.11 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.12 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.13 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.14 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.15 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.5. loadbalancer create
ロードバランサーを作成します。
使用方法
openstack loadbalancer create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] [--vip-address <vip_address>] [--vip-port-id <vip_port_id>] [--vip-subnet-id <vip_subnet_id>] [--vip-network-id <vip_network_id>] [--vip-qos-policy-id <vip_qos_policy_id>] [--project <project>] [--provider <provider>] [--enable | --disable] [--flavor <flavor>]
表47.16 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 新しいロードバランサー名。 |
--description <description> | ロードバランサーの説明を設定します。 |
--vip-address <vip_address> | vip ip アドレスを設定します。 |
--vip-qos-policy-id <vip_qos_policy_id> | vip port に qos policy id を設定します。設定を解除する場合は none にします。 |
--project <project> | ロードバランサーのプロジェクト (名前または id)。 |
--provider <provider> | ロードバランサーのプロバイダー名。 |
--enable | ロードバランサーを有効にします (デフォルト)。 |
--disable | ロードバランサーを無効にします。 |
--flavor <flavor> | ロードバランサーのフレーバーの名前または ID。 |
表47.17 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.18 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.19 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.20 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
表47.21 VIP ネットワーク
値 | 概要 |
---|---|
少なくとも以下の引数のいずれかが必要です。--vip-port-id <vip_port_id> | ロードバランサーのポートを設定します (名前または id)。 |
--vip-subnet-id <vip_subnet_id> | ロードバランサーにサブネットを設定します (名前または ID)。 |
--vip-network-id <vip_network_id> | ロードバランサーにネットワークを設定します (名前または id)。 |
47.6. loadbalancer delete
ロードバランサーを削除します。
使用方法
openstack loadbalancer delete [-h] [--cascade] <load_balancer>
表47.22 位置引数
値 | 概要 |
---|---|
<load_balancer> | 削除するロードバランサー (名前または ID) |
表47.23 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--cascade | 削除をロードバランサーのすべての子要素に適用します。 |
47.7. loadbalancer failover
ロードバランサーのフェイルオーバーをトリガーします。
使用方法
openstack loadbalancer failover [-h] <load_balancer>
表47.24 位置引数
値 | 概要 |
---|---|
<load_balancer> | ロードバランサーの名前または uuid |
表47.25 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
47.8. loadbalancer flavor create
octavia フレーバーを作成します。
使用方法
openstack loadbalancer flavor create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --name <name> --flavorprofile <flavor_profile> [--description <description>] [--enable | --disable]
表47.26 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 新規フレーバー名。 |
--flavorprofile <flavor_profile> | フレーバーを追加するフレーバープロファイル (名前または ID) |
--description <description> | フレーバーの説明を設定します。 |
--enable | フレーバーを有効にします。 |
--disable | フレーバーを無効にします。 |
表47.27 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.28 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.29 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.30 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.9. loadbalancer flavor delete
フレーバーを削除します。
使用方法
openstack loadbalancer flavor delete [-h] <flavor>
表47.31 位置引数
値 | 概要 |
---|---|
<flavor> | 削除するフレーバー (名前または ID) |
表47.32 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
47.10. loadbalancer flavor list
フレーバーをリスト表示します。
使用方法
openstack loadbalancer flavor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name <name>] [--flavorprofile <flavor_profile>] [--enable | --disable]
表47.33 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 名前に従ってフレーバーをリスト表示します。 |
--flavorprofile <flavor_profile> | フレーバープロファイルに従ってフレーバーをリスト表示します。 |
--enable | 有効なフレーバーをリスト表示します。 |
--disable | 無効なフレーバーをリスト表示します。 |
表47.34 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表47.35 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表47.36 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.37 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.11. loadbalancer flavor set
フレーバーを更新します。
使用方法
openstack loadbalancer flavor set [-h] [--name <name>] [--enable | --disable] <flavor>
表47.38 位置引数
値 | 概要 |
---|---|
<flavor> | 更新するフレーバーの名前または uuid |
表47.39 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | フレーバーの名前を設定します。 |
--enable | フレーバーを有効にします。 |
--disable | フレーバーを無効にします。 |
47.12. loadbalancer flavor show
1 つのフレーバーの詳細を表示します。
使用方法
openstack loadbalancer flavor show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <flavor>
表47.40 位置引数
値 | 概要 |
---|---|
<flavor> | フレーバーの名前または uuid |
表47.41 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.42 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.43 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.44 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.45 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.13. loadbalancer flavor unset
ヘルスモニター設定を消去します。
使用方法
openstack loadbalancer flavor unset [-h] [--description] <flavor>
表47.46 位置引数
値 | 概要 |
---|---|
<flavor> | 更新するフレーバー (名前または ID) |
表47.47 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description | フレーバーの説明をクリアします |
47.14. loadbalancer flavorprofile create
octavia フレーバープロファイルを作成します。
使用方法
openstack loadbalancer flavorprofile create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --name <name> --provider <provider name> --flavor-data <flavor_data>
表47.48 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 新規 octavia フレーバープロファイル名。 |
--provider <provider name> | フレーバープロファイルのプロバイダー名。 |
--flavor-data <flavor_data> | フレーバーメタデータが含まれる json 文字列。 |
表47.49 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.50 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.51 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.52 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.15. loadbalancer flavorprofile delete
フレーバープロファイルを削除します。
使用方法
openstack loadbalancer flavorprofile delete [-h] <flavor_profile>
表47.53 位置引数
値 | 概要 |
---|---|
<flavor_profile> | 削除するフレーバープロファイル (名前または ID) |
表47.54 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
47.16. loadbalancer flavorprofile list
フレーバープロファイルをリスト表示します。
使用方法
openstack loadbalancer flavorprofile list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name <name>] [--provider <provider_name>]
表47.55 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | フレーバープロファイル名でフレーバープロファイルをリスト表示します。 |
--provider <provider_name> | プロバイダーに従ってフレーバープロファイルをリスト表示します。 |
表47.56 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表47.57 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表47.58 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.59 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.17. loadbalancer flavorprofile set
フレーバープロファイルを更新します。
使用方法
openstack loadbalancer flavorprofile set [-h] [--name <name>] [--provider <provider_name>] [--flavor-data <flavor_data>] <flavor_profile>
表47.60 位置引数
値 | 概要 |
---|---|
<flavor_profile> | 更新するフレーバープロファイルの名前または uuid。 |
表47.61 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | フレーバープロファイルの名前を設定します。 |
--provider <provider_name> | フレーバープロファイルのプロバイダーを設定します。 |
--flavor-data <flavor_data> | フレーバープロファイルのフレーバーデータを設定します。 |
47.18. loadbalancer flavorprofile show
1 つのフレーバープロファイルの詳細を表示します。
使用方法
openstack loadbalancer flavorprofile show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <flavor_profile>
表47.62 位置引数
値 | 概要 |
---|---|
<flavor_profile> | 表示するフレーバープロファイルの名前または uuid |
表47.63 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.64 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.65 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.66 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.67 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.19. loadbalancer healthmonitor create
ヘルスモニターを作成します。
使用方法
openstack loadbalancer healthmonitor create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] --delay <delay> [--domain-name <domain_name>] [--expected-codes <codes>] [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}] [--http-version <http_version>] --timeout <timeout> --max-retries <max_retries> [--url-path <url_path>] --type {PING,HTTP,TCP,HTTPS,TLS-HELLO,UDP-CONNECT} [--max-retries-down <max_retries_down>] [--enable | --disable] <pool>
表47.68 位置引数
値 | 概要 |
---|---|
<pool> | ヘルスモニターのプールを設定します (名前または ID)。 |
表47.69 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | ヘルスモニター名を設定します。 |
--delay <delay> | プローブをメンバーに送信する間隔を秒単位で設定します。 |
--domain-name <domain_name> | HTTP ヘルスチェックのバックエンドサーバーに、http ホストヘッダーにインジェクトされるドメイン名を設定します。 |
--expected-codes <codes> | 正常であることを宣言するためのメンバーからの応答で予想される http ステータスコードのリストを設定します。 |
--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE} | ヘルスモニターがリクエストに使用する http メソッドを設定します。 |
--http-version <http_version> | http バージョンを設定します。 |
--timeout <timeout> | モニターが接続を待つ最大のタイムアウト時間を秒単位で設定します。この値は delay 値よりも小さくなければなりません。 |
--max-retries <max_retries> | メンバーの稼働ステータスを ONLINE に変更するのに必要な正常なチェックの数。 |
--url-path <url_path> | バックエンドメンバーの健全性をテストするためにモニターによって送信されるリクエストの http url パスを設定します。 |
--type {PING,HTTP,TCP,HTTPS,TLS-HELLO,UDP-CONNECT} | ヘルスモニターのタイプを設定します。 |
--max-retries-down <max_retries_down> | メンバーのオペレーティングステータスを ERROR に変更する前に許容されるチェックの失敗数を設定します。 |
--enable | ヘルスモニターを有効にします (デフォルト)。 |
--disable | ヘルスモニターを無効にします。 |
表47.70 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.71 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.72 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.73 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.20. loadbalancer healthmonitor delete
ヘルスモニターを削除します。
使用方法
openstack loadbalancer healthmonitor delete [-h] <health_monitor>
表47.74 位置引数
値 | 概要 |
---|---|
<health_monitor> | 削除するヘルスモニター (名前または ID) |
表47.75 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
47.21. loadbalancer healthmonitor list
ヘルスモニターをリスト表示します。
使用方法
openstack loadbalancer healthmonitor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表47.76 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.77 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表47.78 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表47.79 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.80 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.22. loadbalancer healthmonitor set
ヘルスモニターを更新します。
使用方法
openstack loadbalancer healthmonitor set [-h] [--name <name>] [--delay <delay>] [--domain-name <domain_name>] [--expected-codes <codes>] [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}] [--http-version <http_version>] [--timeout <timeout>] [--max-retries <max_retries>] [--max-retries-down <max_retries_down>] [--url-path <url_path>] [--enable | --disable] <health_monitor>
表47.81 位置引数
値 | 概要 |
---|---|
<health_monitor> | 更新するヘルスモニター (名前または ID) |
表47.82 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | ヘルスモニター名を設定します。 |
--delay <delay> | プローブをメンバーに送信する間隔を秒単位で設定します。 |
--domain-name <domain_name> | HTTP ヘルスチェックのバックエンドサーバーに、http ホストヘッダーにインジェクトされるドメイン名を設定します。 |
--expected-codes <codes> | 正常であることを宣言するためのメンバーからの応答で予想される http ステータスコードのリストを設定します。 |
--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE} | ヘルスモニターがリクエストに使用する http メソッドを設定します。 |
--http-version <http_version> | http バージョンを設定します。 |
--timeout <timeout> | モニターが接続を待つ最大のタイムアウト時間を秒単位で設定します。この値は delay 値よりも小さくなければなりません。 |
--max-retries <max_retries> | メンバーの稼働ステータスを ONLINE に変更するのに必要な正常なチェックの数を設定します。 |
--max-retries-down <max_retries_down> | メンバーのオペレーティングステータスを ERROR に変更する前に許容されるチェックの失敗数を設定します。 |
--url-path <url_path> | バックエンドメンバーの健全性をテストするためにモニターによって送信されるリクエストの http url パスを設定します。 |
--enable | ヘルスモニターを有効にします。 |
--disable | ヘルスモニターを無効にします。 |
47.23. loadbalancer healthmonitor show
単一のヘルスモニターの詳細を表示します。
使用方法
openstack loadbalancer healthmonitor show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <health_monitor>
表47.83 位置引数
値 | 概要 |
---|---|
<health_monitor> | ヘルスモニターの名前または uuid。 |
表47.84 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.85 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.86 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.87 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.88 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.24. loadbalancer healthmonitor unset
ヘルスモニター設定をクリアします。
使用方法
openstack loadbalancer healthmonitor unset [-h] [--domain-name] [--expected-codes] [--http-method] [--http-version] [--max-retries-down] [--name] [--url-path] <health_monitor>
表47.89 位置引数
値 | 概要 |
---|---|
<health_monitor> | 更新するヘルスモニター (名前または ID) |
表47.90 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain-name | ヘルスモニターのドメイン名をクリアします。 |
--expected-codes | ヘルスモニターの想定されるコードを api のデフォルトにリセットします。 |
--http-method | ヘルスモニターの http メソッドを api のデフォルトにリセットします。 |
--http-version | ヘルスモニターの http バージョンを api のデフォルトにリセットします。 |
--max-retries-down | ヘルスモニターの最大リトライ数を api のデフォルトにリセットして下げます。 |
--name | ヘルスモニター名をクリアします。 |
--url-path | ヘルスモニター URL パスを消去します。 |
47.25. loadbalancer l7policy create
l7policy を作成します。
使用方法
openstack loadbalancer l7policy create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] --action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT} [--redirect-pool <pool> | --redirect-url <url> | --redirect-prefix <url>] [--redirect-http-code <redirect_http_code>] [--position <position>] [--enable | --disable] <listener>
表47.91 位置引数
値 | 概要 |
---|---|
<listener> | l7policy をに追加するリスナー (名前または id)。 |
表47.92 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | l7policy 名を設定します。 |
--description <description> | l7policy の説明を設定します。 |
--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT} | ポリシーのアクションを設定します。 |
--redirect-pool <pool> | 要求をリダイレクトするプールを設定します (名前または ID)。 |
--redirect-url <url> | 要求のリダイレクト先となる URL を設定します。 |
--redirect-prefix <url> | 要求のリダイレクト先となる url 接頭辞を設定します。 |
--redirect-http-code <redirect_http_code> | redirect_url または REDIRECT_PREFIX アクションの http 応答コードを設定します。 |
--position <position> | この l7 ポリシーのシーケンス番号。 |
--enable | l7policy を有効にします (デフォルト)。 |
--disable | l7policy を無効にします。 |
表47.93 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.94 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.95 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.96 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.26. loadbalancer l7policy delete
l7policy を削除します。
使用方法
openstack loadbalancer l7policy delete [-h] <policy>
表47.97 位置引数
値 | 概要 |
---|---|
<policy> | 削除する L7policy(名前または ID)。 |
表47.98 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
47.27. loadbalancer l7policy list
l7policies をリスト表示します。
使用方法
openstack loadbalancer l7policy list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表47.99 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.100 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表47.101 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表47.102 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.103 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.28. loadbalancer l7policy set
l7policy を更新します。
使用方法
openstack loadbalancer l7policy set [-h] [--name <name>] [--description <description>] [--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}] [--redirect-pool <pool> | --redirect-url <url> | --redirect-prefix <url>] [--redirect-http-code <redirect_http_code>] [--position <position>] [--enable | --disable] <policy>
表47.104 位置引数
値 | 概要 |
---|---|
<policy> | 更新する L7policy(名前または ID)。 |
表47.105 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | l7policy 名を設定します。 |
--description <description> | l7policy の説明を設定します。 |
--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT} | ポリシーのアクションを設定します。 |
--redirect-pool <pool> | 要求をリダイレクトするプールを設定します (名前または ID)。 |
--redirect-url <url> | 要求のリダイレクト先となる URL を設定します。 |
--redirect-prefix <url> | 要求のリダイレクト先となる url 接頭辞を設定します。 |
--redirect-http-code <redirect_http_code> | redirect_url または REDIRECT_PREFIX アクションの http 応答コードを設定します。 |
--position <position> | この l7 ポリシーのシーケンス番号を設定します。 |
--enable | l7policy を有効にします。 |
--disable | l7policy を無効にします。 |
47.29. loadbalancer l7policy show
1 つの l7policy の詳細を表示します。
使用方法
openstack loadbalancer l7policy show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <policy>
表47.106 位置引数
値 | 概要 |
---|---|
<policy> | l7policy の名前または uuid |
表47.107 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.108 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.109 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.110 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.111 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.30. loadbalancer l7policy unset
l7policy 設定をクリアします
使用方法
openstack loadbalancer l7policy unset [-h] [--description] [--name] [--redirect-http-code] <policy>
表47.112 位置引数
値 | 概要 |
---|---|
<policy> | 更新する L7policy(名前または ID)。 |
表47.113 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description | l7policy の説明をクリアします |
--name | l7policy 名をクリアします。 |
--redirect-http-code | l7policy リダイレクト http コードを消去します。 |
47.31. loadbalancer l7rule create
l7rule を作成します。
使用方法
openstack loadbalancer l7rule create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH} [--invert] --value <value> [--key <key>] --type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD} [--enable | --disable] <l7policy>
表47.114 位置引数
値 | 概要 |
---|---|
<l7policy> | l7rule を追加する L7policy(名前または ID)。 |
表47.115 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH} | l7rule の比較タイプを設定します。 |
--invert | l7rule を反転します。 |
--value <value> | 照合するルールの値を設定します。 |
--key <key> | 照合する l7rule の値のキーを設定します。 |
--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD} | l7rule のタイプを設定します。 |
--enable | l7rule を有効にします (デフォルト)。 |
--disable | l7rule を無効にします。 |
表47.116 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.117 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.118 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.119 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.32. loadbalancer l7rule delete
l7rule を削除します。
使用方法
openstack loadbalancer l7rule delete [-h] <l7policy> <rule_id>
表47.120 位置引数
値 | 概要 |
---|---|
<l7policy> | ルールを削除する L7policy(名前または ID) |
<rule_id> | 削除する L7rule。 |
表47.121 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
47.33. loadbalancer l7rule list
l7policy の l7rules をリスト表示します。
使用方法
openstack loadbalancer l7rule list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <l7policy>
表47.122 位置引数
値 | 概要 |
---|---|
<l7policy> | ルールをリスト表示する L7policy(名前または ID) |
表47.123 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.124 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表47.125 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表47.126 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.127 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.34. loadbalancer l7rule set
l7rule を更新します。
使用方法
openstack loadbalancer l7rule set [-h] [--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}] [--invert] [--value <value>] [--key <key>] [--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}] [--enable | --disable] <l7policy> <l7rule_id>
表47.128 位置引数
値 | 概要 |
---|---|
<l7policy> | l7rule を更新する l7policy(名前または id) |
<l7rule_id> | 更新する L7rule。 |
表47.129 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH} | l7rule の比較タイプを設定します。 |
--invert | l7rule を反転します。 |
--value <value> | 照合するルールの値を設定します。 |
--key <key> | 照合する l7rule の値のキーを設定します。 |
--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD} | l7rule のタイプを設定します。 |
--enable | l7rule を有効にします。 |
--disable | l7rule を無効にします。 |
47.35. loadbalancer l7rule show
1 つの l7rule の詳細を表示します。
使用方法
openstack loadbalancer l7rule show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <l7policy> <l7rule_id>
表47.130 位置引数
値 | 概要 |
---|---|
<l7policy> | ルールを表示する L7policy(名前または ID)。 |
<l7rule_id> | 表示する L7rule。 |
表47.131 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.132 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.133 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.134 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.135 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.36. loadbalancer l7rule unset
l7rule の設定をクリアします
使用方法
openstack loadbalancer l7rule unset [-h] [--invert] [--key] <l7policy> <l7rule_id>
表47.136 位置引数
値 | 概要 |
---|---|
<l7policy> | 更新する L7policy(名前または ID)。 |
<l7rule_id> | 更新する L7rule。 |
表47.137 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--invert | l7rule を反転して api のデフォルトにリセットします。 |
--key | l7rule キーを消去します。 |
47.37. loadbalancer list
ロードバランサーをリスト表示します。
使用方法
openstack loadbalancer list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name <name>] [--enable | --disable] [--project <project-id>] [--vip-network-id <vip_network_id>] [--vip-subnet-id <vip_subnet_id>] [--vip-qos-policy-id <vip_qos_policy_id>] [--vip-port-id <vip_port_id>] [--provisioning-status {ACTIVE,DELETED,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE}] [--operating-status {ONLINE,DRAINING,OFFLINE,DEGRADED,ERROR,NO_MONITOR}] [--provider <provider>] [--flavor <flavor>]
表47.138 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 名前に従ってロードバランサーをリスト表示します。 |
--enable | 有効なロードバランサーをリスト表示します。 |
--disable | 無効にされたロードバランサーをリスト表示します。 |
--project <project-id> | プロジェクトに従ってロードバランサーをリスト表示します (名前または ID)。 |
--vip-network-id <vip_network_id> | vip ネットワークに従ってロードバランサーをリスト表示します (名前または ID)。 |
--vip-subnet-id <vip_subnet_id> | vip サブネットに従ってロードバランサーをリスト表示します (名前または ID)。 |
--vip-qos-policy-id <vip_qos_policy_id> | vip qos ポリシーに従ってロードバランサーをリスト表示します (名前または ID)。 |
--vip-port-id <vip_port_id> | vip ポートに従ってロードバランサーをリスト表示します (名前または ID)。 |
--provisioning-status {ACTIVE,DELETED,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE} | プロビジョニングのステータスに従ってロードバランサーをリスト表示します。 |
--operating-status {ONLINE,DRAINING,OFFLINE,DEGRADED,ERROR,NO_MONITOR} | 動作ステータスに従ってロードバランサーをリスト表示します。 |
--provider <provider> | プロバイダーに従ってロードバランサーをリスト表示します。 |
--flavor <flavor> | フレーバーに従ってロードバランサーをリスト表示します。 |
表47.139 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表47.140 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表47.141 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.142 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.38. loadbalancer listener create
リスナーを作成します。
使用方法
openstack loadbalancer listener create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] --protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,UDP} [--connection-limit <limit>] [--default-pool <pool>] [--default-tls-container-ref <container_ref>] [--sni-container-refs [<container_ref> [<container_ref> ...]]] [--insert-headers <header=value,...>] --protocol-port <port> [--timeout-client-data <timeout>] [--timeout-member-connect <timeout>] [--timeout-member-data <timeout>] [--timeout-tcp-inspect <timeout>] [--enable | --disable] [--client-ca-tls-container-ref <container_ref>] [--client-authentication {NONE,OPTIONAL,MANDATORY}] [--client-crl-container-ref <client_crl_container_ref>] [--allowed-cidr [<allowed_cidr>]] <loadbalancer>
表47.143 位置引数
値 | 概要 |
---|---|
<loadbalancer> | リスナーのロードバランサー (名前または id) |
表47.144 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | リスナー名を設定します。 |
--description <description> | このリスナーの説明を設定します。 |
--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,UDP} | リスナーのプロトコル。 |
--connection-limit <limit> | このリスナーで許可される接続の最大数を設定します。 |
--default-pool <pool> | L7 ポリシーが一致しない場合、リスナーによって使用されるプールの名前または ID を設定します。 |
--default-tls-container-ref <container_ref> | TERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI。 |
--sni-container-refs [<container_ref> [<container_ref> …]] | Server Name Indication を使用する TERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI のリスト。 |
--insert-headers <header=value,…> | バックエンドメンバーに送信される前にリクエストに挿入するオプションヘッダーのディクショナリー。 |
--protocol-port <port> | リスナーのプロトコルポート番号を設定します。 |
--timeout-client-data <timeout> | フロントエンドクライアントの停止状態タイムアウト (ミリ秒単位)。デフォルト: 50000。 |
--timeout-member-connect <timeout> | バックエンドメンバーの接続タイムアウト (ミリ秒単位)。Default: 5000。 |
--timeout-member-data <timeout> | バックエンドメンバーの停止状態タイムアウト (ミリ秒単位)。デフォルト: 50000。 |
--timeout-tcp-inspect <timeout> | コンテンツの検査用に追加の tcp パケットを待機する時間 (ミリ秒単位)。デフォルト: 0 |
--enable | リスナーを有効にします (デフォルト)。 |
--disable | リスナーを無効にします。 |
--client-ca-tls-container-ref <container_ref> | TERMINATED_TLS リスナーの CA 証明書が含まれるキーマネージャーサービスシークレットコンテナーへの URI。 |
--client-authentication {NONE,OPTIONAL,MANDATORY} | TERMINATED_TLS リスナーの tls クライアントの認証検証オプション。 |
--client-crl-container-ref <client_crl_container_ref> | TERMINATED_TLS リスナーの CA 失効リストファイルが含まれるキーマネージャーサービスシークレットコンテナーへの URI。 |
--allowed-cidr [<allowed_cidr>] | リスナーへのアクセスを許可する CIDR(複数回設定できます)。 |
表47.145 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.146 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.147 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.148 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.39. loadbalancer listener delete
リスナーを削除します。
使用方法
openstack loadbalancer listener delete [-h] <listener>
表47.149 位置引数
値 | 概要 |
---|---|
<listener> | 削除するリスナー (名前または ID) |
表47.150 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
47.40. loadbalancer listener list
リスナーのリストを表示します。
使用方法
openstack loadbalancer listener list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name <name>] [--loadbalancer <loadbalancer>] [--enable | --disable] [--project <project>]
表47.151 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | リスナー名でリスナーをリスト表示します。 |
--loadbalancer <loadbalancer> | ロードバランサーでフィルタリングします (名前または ID)。 |
--enable | 有効なリスナーをリスト表示します。 |
--disable | 無効なリスナーをリスト表示します。 |
--project <project> | プロジェクト ID でリスナーをリスト表示します。 |
表47.152 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表47.153 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表47.154 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.155 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.41. loadbalancer listener set
リスナーを更新します。
使用方法
openstack loadbalancer listener set [-h] [--name <name>] [--description <description>] [--connection-limit <limit>] [--default-pool <pool>] [--default-tls-container-ref <container-ref>] [--sni-container-refs [<container-ref> [<container-ref> ...]]] [--insert-headers <header=value>] [--timeout-client-data <timeout>] [--timeout-member-connect <timeout>] [--timeout-member-data <timeout>] [--timeout-tcp-inspect <timeout>] [--enable | --disable] [--client-ca-tls-container-ref <container_ref>] [--client-authentication {NONE,OPTIONAL,MANDATORY}] [--client-crl-container-ref <client_crl_container_ref>] [--allowed-cidr [<allowed_cidr>]] <listener>
表47.156 位置引数
値 | 概要 |
---|---|
<listener> | 変更するリスナー (名前または ID)。 |
表47.157 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | リスナー名を設定します。 |
--description <description> | このリスナーの説明を設定します。 |
--connection-limit <limit> | このリスナーで許可される接続の最大数。デフォルト値は -1 で、無限接続を表します。 |
--default-pool <pool> | l7 ポリシーが一致していない場合、リスナーによって使用されるプールの ID。 |
--default-tls-container-ref <container-ref> | TERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI。 |
--sni-container-refs [<container-ref> [<container-ref> …]] | Server Name Indication を使用する TERMINATED_TLS リスナーの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの URI のリスト。 |
--insert-headers <header=value> | バックエンドメンバーに送信される前にリクエストに挿入するオプションヘッダーのディクショナリー。 |
--timeout-client-data <timeout> | フロントエンドクライアントの停止状態タイムアウト (ミリ秒単位)。デフォルト: 50000。 |
--timeout-member-connect <timeout> | バックエンドメンバーの接続タイムアウト (ミリ秒単位)。Default: 5000。 |
--timeout-member-data <timeout> | バックエンドメンバーの停止状態タイムアウト (ミリ秒単位)。デフォルト: 50000。 |
--timeout-tcp-inspect <timeout> | コンテンツの検査用に追加の tcp パケットを待機する時間 (ミリ秒単位)。デフォルト: 0 |
--enable | リスナーを有効にします。 |
--disable | リスナーを無効にします。 |
--client-ca-tls-container-ref <container_ref> | TERMINATED_TLS リスナーの CA 証明書が含まれるキーマネージャーサービスシークレットコンテナーへの URI。 |
--client-authentication {NONE,OPTIONAL,MANDATORY} | TERMINATED_TLS リスナーの tls クライアントの認証検証オプション。 |
--client-crl-container-ref <client_crl_container_ref> | TERMINATED_TLS リスナーの CA 失効リストファイルが含まれるキーマネージャーサービスシークレットコンテナーへの URI。 |
--allowed-cidr [<allowed_cidr>] | リスナーへのアクセスを許可する CIDR(複数回設定できます)。 |
47.42. loadbalancer listener show
単一のリスナーの詳細を表示します。
使用方法
openstack loadbalancer listener show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <listener>
表47.158 位置引数
値 | 概要 |
---|---|
<listener> | リスナーの名前または uuid |
表47.159 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.160 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.161 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.162 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.163 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.43. loadbalancer listener stats show
リスナーの現在の統計を表示します。
使用方法
openstack loadbalancer listener stats show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <listener>
表47.164 位置引数
値 | 概要 |
---|---|
<listener> | リスナーの名前または uuid |
表47.165 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.166 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.167 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.168 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.169 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.44. loadbalancer listener unset
リスナーの設定をクリアします
使用方法
openstack loadbalancer listener unset [-h] [--name] [--description] [--connection-limit] [--default-pool] [--default-tls-container-ref] [--sni-container-refs] [--insert-headers] [--timeout-client-data] [--timeout-member-connect] [--timeout-member-data] [--timeout-tcp-inspect] [--client-ca-tls-container-ref] [--client-authentication] [--client-crl-container-ref] [--allowed-cidrs] <listener>
表47.170 位置引数
値 | 概要 |
---|---|
<listener> | 変更するリスナー (名前または ID)。 |
表47.171 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name | リスナー名を削除します。 |
--description | このリスナーの説明をクリアします。 |
--connection-limit | 接続制限を api のデフォルトにリセットします。 |
--default-pool | リスナーからデフォルトのプールを削除します。 |
--default-tls-container-ref | リスナーからデフォルトの tls コンテナー参照を削除します。 |
--sni-container-refs | リスナーから tls sni コンテナー参照を削除します。 |
--insert-headers | リスナーから挿入ヘッダーをクリアします。 |
--timeout-client-data | クライアントデータタイムアウトを api のデフォルトにリセットします。 |
--timeout-member-connect | メンバー接続タイムアウトを api のデフォルトにリセットします。 |
--timeout-member-data | メンバーデータタイムアウトを api のデフォルトにリセットします。 |
--timeout-tcp-inspect | tcp インスペクションタイムアウトを api のデフォルトにリセットします。 |
--client-ca-tls-container-ref | リスナーからクライアント ca tls コンテナー参照をクリアします。 |
--client-authentication | クライアント認証設定を api のデフォルトにリセットします。 |
--client-crl-container-ref | リスナーからクライアントの crl コンテナーの参照をクリアします。 |
--allowed-cidrs | リスナーから許可されるすべての cidr を消去します。 |
47.45. loadbalancer member create
プールにメンバーを作成します。
使用方法
openstack loadbalancer member create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--disable-backup | --enable-backup] [--weight <weight>] --address <ip_address> [--subnet-id <subnet_id>] --protocol-port <protocol_port> [--monitor-port <monitor_port>] [--monitor-address <monitor_address>] [--enable | --disable] <pool>
表47.172 位置引数
値 | 概要 |
---|---|
<pool> | メンバーを作成するプールの ID または名前。 |
表47.173 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | メンバーの名前。 |
--disable-backup | メンバーバックアップを無効にします (デフォルト)。 |
--enable-backup | メンバーバックアップを有効にします。 |
--weight <weight> | プールの他のメンバーと比較して、提供する要求または接続の部分を決定するメンバーの重み。 |
--address <ip_address> | バックエンドメンバーサーバーの IP アドレス |
--subnet-id <subnet_id> | メンバーサービスがアクセスできるサブネット ID。 |
--protocol-port <protocol_port> | バックエンドメンバーサーバーがリッスンするプロトコルポート番号。 |
--monitor-port <monitor_port> | バックエンドメンバーの正常性モニタリングに使用する別のプロトコルポート。 |
--monitor-address <monitor_address> | バックエンドメンバーの正常性モニタリングに使用する別の IP アドレス。 |
--enable | メンバーを有効にします (デフォルト)。 |
--disable | メンバーを無効にします。 |
表47.174 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.175 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.176 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.177 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.46. loadbalancer member delete
プールからメンバーを削除します。
使用方法
openstack loadbalancer member delete [-h] <pool> <member>
表47.178 位置引数
値 | 概要 |
---|---|
<pool> | メンバーを削除するプール名または id。 |
<member> | 削除するメンバーの名前または ID。 |
表47.179 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
47.47. loadbalancer member list
プール内のメンバーをリスト表示します。
使用方法
openstack loadbalancer member list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <pool>
表47.180 位置引数
値 | 概要 |
---|---|
<pool> | メンバーをリスト表示するプール名または id。 |
表47.181 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.182 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表47.183 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表47.184 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.185 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.48. loadbalancer member set
メンバーを更新します。
使用方法
openstack loadbalancer member set [-h] [--name <name>] [--disable-backup | --enable-backup] [--weight <weight>] [--monitor-port <monitor_port>] [--monitor-address <monitor_address>] [--enable | --disable] <pool> <member>
表47.186 位置引数
値 | 概要 |
---|---|
<pool> | 更新するメンバーが属するプール (名前または ID)。 |
<member> | 更新するメンバーの名前または ID |
表47.187 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | メンバーの名前を設定します。 |
--disable-backup | メンバーバックアップを無効にします (デフォルト)。 |
--enable-backup | メンバーバックアップを有効にします。 |
--weight <weight> | プール内のメンバーの重みを設定します。 |
--monitor-port <monitor_port> | バックエンドメンバーの正常性モニタリングに使用する別のプロトコルポート。 |
--monitor-address <monitor_address> | バックエンドメンバーの正常性モニタリングに使用する別の IP アドレス。 |
--enable | admin_state_up を true に設定します。 |
--disable | admin_state_up を false に設定します。 |
47.49. loadbalancer member show
1 つのメンバーの詳細を表示します。
使用方法
openstack loadbalancer member show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <pool> <member>
表47.188 位置引数
値 | 概要 |
---|---|
<pool> | メンバーを表示するプール名または id。 |
<member> | 表示するメンバーの名前または ID。 |
表47.189 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.190 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.191 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.192 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.193 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.50. loadbalancer member unset
メンバーの設定をクリアします
使用方法
openstack loadbalancer member unset [-h] [--backup] [--monitor-address] [--monitor-port] [--name] [--weight] <pool> <member>
表47.194 位置引数
値 | 概要 |
---|---|
<pool> | 更新するメンバーが属するプール (名前または ID)。 |
<member> | 変更するメンバー (名前または ID) |
表47.195 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--backup | バックアップメンバーフラグをクリアします |
--monitor-address | メンバーモニターアドレスをクリアします |
--monitor-port | メンバーモニターポートをクリアします |
--name | メンバー名をクリアします |
--weight | メンバーの重みを api のデフォルトにリセットします。 |
47.51. loadbalancer pool create
プールを作成します。
使用方法
openstack loadbalancer pool create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] --protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY,UDP} (--listener <listener> | --loadbalancer <load_balancer>) [--session-persistence <session persistence>] --lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT} [--enable | --disable] [--tls-container-ref <container-ref>] [--ca-tls-container-ref <ca_tls_container_ref>] [--crl-container-ref <crl_container_ref>] [--enable-tls | --disable-tls]
表47.196 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | プール名を設定します。 |
--description <description> | プールの説明を設定します。 |
--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY,UDP} | プールプロトコルを設定します。 |
--listener <listener> | プールを追加するリスナー (名前または ID)。 |
--loadbalancer <load_balancer> | プールを追加するロードバランサー (名前または ID) |
--session-persistence <session persistence> | リスナーのセッション永続性を設定します (key=value)。 |
--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT} | 使用するロードバランシングアルゴリズム。 |
--enable | プールを有効にします (デフォルト)。 |
--disable | プールを無効にします。 |
--tls-container-ref <container-ref> | バックエンドメンバーサーバーへのトラフィックを再暗号化するための``tls_enabled``プールの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの参照。 |
--ca-tls-container-ref <ca_tls_container_ref> | バックエンドメンバーサーバー証明書を確認するための``tls_enabled``プールの CA 証明書が含まれるキーマネージャーサービスシークレットコンテナーへの参照。 |
--crl-container-ref <crl_container_ref> | バックエンドメンバーサーバー証明書を検証するための``tls_enabled``プールの CA 失効リストファイルが含まれるキーマネージャーサービスシークレットコンテナーへの参照。 |
--enable-tls | バックエンドメンバーの再暗号化を有効にします。 |
--disable-tls | バックエンドメンバーの再暗号化を無効にします。 |
表47.197 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.198 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.199 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.200 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.52. loadbalancer pool delete
プールを削除します。
使用方法
openstack loadbalancer pool delete [-h] <pool>
表47.201 位置引数
値 | 概要 |
---|---|
<pool> | 削除するプール (名前または ID) |
表47.202 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
47.53. loadbalancer pool list
プールをリスト表示します。
使用方法
openstack loadbalancer pool list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--loadbalancer <loadbalancer>]
表47.203 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--loadbalancer <loadbalancer> | ロードバランサーでフィルタリングします (名前または ID)。 |
表47.204 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表47.205 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表47.206 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.207 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.54. loadbalancer pool set
プールを更新します。
使用方法
openstack loadbalancer pool set [-h] [--name <name>] [--description <description>] [--session-persistence <session_persistence>] [--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT}] [--enable | --disable] [--tls-container-ref <container-ref>] [--ca-tls-container-ref <ca_tls_container_ref>] [--crl-container-ref <crl_container_ref>] [--enable-tls | --disable-tls] <pool>
表47.208 位置引数
値 | 概要 |
---|---|
<pool> | 更新するプール (名前または ID)。 |
表47.209 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | プールの名前を設定します。 |
--description <description> | プールの説明を設定します。 |
--session-persistence <session_persistence> | リスナーのセッション永続性を設定します (key=value)。 |
--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT} | 使用するロードバランシングアルゴリズムを設定します。 |
--enable | プールを有効にします。 |
--disable | プールを無効にします。 |
--tls-container-ref <container-ref> | TERMINATED_TLS リスナーからバックエンドサーバーへのトラフィックを再暗号化するための TERMINATED_TLS プールの証明書および鍵が含まれるキーマネージャーサービスシークレットコンテナーへの uri。 |
--ca-tls-container-ref <ca_tls_container_ref> | ssl トラフィックのバックエンドサーバー証明書を確認するための TERMINATED_TLS リスナーの CA 証明書が含まれるキーマネージャーサービスシークレットコンテナーへの URI。 |
--crl-container-ref <crl_container_ref> | ssl トラフィックのバックエンドサーバー証明書を検証するための TERMINATED_TLS リスナーの CA 失効リストファイルが含まれるキーマネージャーサービスシークレットコンテナーへの URI。 |
--enable-tls | バックエンドの関連メンバーの再暗号化を有効にします。 |
--disable-tls | バックエンドの関連メンバーの再暗号化を無効にします。 |
47.55. loadbalancer pool show
単一プールの詳細を表示します。
使用方法
openstack loadbalancer pool show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <pool>
表47.210 位置引数
値 | 概要 |
---|---|
<pool> | プールの名前または uuid。 |
表47.211 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.212 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.213 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.214 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.215 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.56. loadbalancer pool unset
プールの設定をクリアします
使用方法
openstack loadbalancer pool unset [-h] [--name] [--description] [--ca-tls-container-ref] [--crl-container-ref] [--session-persistence] [--tls-container-ref] <pool>
表47.216 位置引数
値 | 概要 |
---|---|
<pool> | 変更するプール (名前または ID)。 |
表47.217 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name | プール名をクリアします。 |
--description | このプールの説明をクリアします。 |
--ca-tls-container-ref | このプールの認証局の証明書参照をクリアします。 |
--crl-container-ref | このプールの証明書失効リスト参照をクリアします。 |
--session-persistence | プールのセッションの永続性を無効にします。 |
--tls-container-ref | このプールの証明書参照を消去します。 |
47.57. loadbalancer provider capability list
指定したプロバイダードライバーのフレーバーの機能をリスト表示します。
使用方法
openstack loadbalancer provider capability list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <provider_name>
表47.218 位置引数
値 | 概要 |
---|---|
<provider_name> | プロバイダードライバーの名前。 |
表47.219 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.220 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表47.221 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表47.222 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.223 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.58. loadbalancer provider list
プロバイダーのリストを表示します。
使用方法
openstack loadbalancer provider list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表47.224 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.225 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表47.226 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表47.227 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.228 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.59. loadbalancer quota defaults show
クォータのデフォルトを表示します。
使用方法
openstack loadbalancer quota defaults show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
表47.229 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.230 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.231 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.232 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.233 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.60. loadbalancer quota list
クォータをリスト表示します。
使用方法
openstack loadbalancer quota list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--project <project-id>]
表47.234 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project-id> | プロジェクトの名前または uuid。 |
表47.235 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表47.236 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表47.237 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.238 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.61. loadbalancer quota reset
クォータをデフォルトのクォータにリセットします。
使用方法
openstack loadbalancer quota reset [-h] <project>
表47.239 位置引数
値 | 概要 |
---|---|
<project> | クォータをリセットするプロジェクト (名前または ID) |
表47.240 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
47.62. loadbalancer quota set
クォータを更新します。
使用方法
openstack loadbalancer quota set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--healthmonitor <health_monitor>] [--listener <listener>] [--loadbalancer <load_balancer>] [--member <member>] [--pool <pool>] <project>
表47.241 位置引数
値 | 概要 |
---|---|
<project> | プロジェクトの名前または uuid。 |
表47.242 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.243 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.244 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.245 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.246 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
表47.247 クォータの制限
値 | 概要 |
---|---|
以下の引数のいずれかが必要です。--healthmonitor <health_monitor> | ヘルスモニタークォータの新しい値。値が -1 の場合は無制限を意味します。 |
--listener <listener> | リスナークォータの新しい値。値が -1 の場合は無制限を意味します。 |
--loadbalancer <load_balancer> | ロードバランサークォータ制限の新しい値。値が -1 の場合は無制限を意味します。 |
--member <member> | メンバークォータ制限の新しい値。値が -1 の場合は無制限を意味します。 |
--pool <pool> | プールクォータ制限の新しい値。値が -1 の場合は無制限を意味します。 |
47.63. loadbalancer quota show
プロジェクトのクォータの詳細を表示します。
使用方法
openstack loadbalancer quota show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <project>
表47.248 位置引数
値 | 概要 |
---|---|
<project> | プロジェクトの名前または uuid。 |
表47.249 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.250 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.251 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.252 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.253 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.64. loadbalancer quota unset
クォータの設定をクリアします
使用方法
openstack loadbalancer quota unset [-h] [--loadbalancer] [--listener] [--pool] [--member] [--healthmonitor] <project>
表47.254 位置引数
値 | 概要 |
---|---|
<project> | プロジェクトの名前または uuid。 |
表47.255 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--loadbalancer | ロードバランサークォータをデフォルトにリセットします。 |
--listener | リスナーのクォータをデフォルトにリセットします。 |
--pool | プールクォータをデフォルトにリセットします。 |
--member | メンバークォータをデフォルトにリセットします。 |
--healthmonitor | ヘルスモニタークォータをデフォルトにリセットします。 |
47.65. loadbalancer set
ロードバランサーを更新します。
使用方法
openstack loadbalancer set [-h] [--name <name>] [--description <description>] [--vip-qos-policy-id <vip_qos_policy_id>] [--enable | --disable] <load_balancer>
表47.256 位置引数
値 | 概要 |
---|---|
<load_balancer> | 更新するロードバランサーの名前または uuid |
表47.257 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | ロードバランサー名を設定します。 |
--description <description> | ロードバランサーの説明を設定します。 |
--vip-qos-policy-id <vip_qos_policy_id> | vip port に qos policy id を設定します。設定を解除する場合は none にします。 |
--enable | ロードバランサーを有効にします。 |
--disable | ロードバランサーを無効にします。 |
47.66. loadbalancer show
単一のロードバランサーの詳細を表示します。
使用方法
openstack loadbalancer show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <load_balancer>
表47.258 位置引数
値 | 概要 |
---|---|
<load_balancer> | ロードバランサーの名前または uuid |
表47.259 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.260 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.261 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.262 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.263 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.67. loadbalancer stats show
ロードバランサーの現在の統計を表示します。
使用方法
openstack loadbalancer stats show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <load_balancer>
表47.264 位置引数
値 | 概要 |
---|---|
<load_balancer> | ロードバランサーの名前または uuid |
表47.265 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表47.266 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表47.267 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表47.268 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表47.269 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
47.68. loadbalancer status show
json 形式でのロードバランサーのステータスツリーを表示します。
使用方法
openstack loadbalancer status show [-h] <load_balancer>
表47.270 位置引数
値 | 概要 |
---|---|
<load_balancer> | ロードバランサーの名前または uuid |
表47.271 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
47.69. loadbalancer unset
ロードバランサーの設定をクリアします
使用方法
openstack loadbalancer unset [-h] [--name] [--description] [--vip-qos-policy-id] <load_balancer>
表47.272 位置引数
値 | 概要 |
---|---|
<load_balancer> | 更新するロードバランサーの名前または uuid |
表47.273 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name | ロードバランサー名をクリアします。 |
--description | ロードバランサーの説明をクリアします。 |
--vip-qos-policy-id | ロードバランサー qos ポリシーを消去します。 |
第48章 mapping
本章では、mapping
コマンドに含まれるコマンドについて説明します。
48.1. mapping create
新規マッピングを作成します。
使用方法
openstack mapping create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --rules <filename> <name>
表48.1 位置引数
値 | 概要 |
---|---|
<name> | 新しいマッピング名 (一意である必要があります) |
表48.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--rules <filename> | 一連のマッピングルールが含まれるファイル名 (必須) |
表48.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表48.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表48.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表48.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
48.2. mapping delete
マッピングを削除します。
使用方法
openstack mapping delete [-h] <mapping> [<mapping> ...]
表48.7 位置引数
値 | 概要 |
---|---|
<mapping> | 削除するマッピング |
表48.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
48.3. mapping list
マッピングをリスト表示します。
使用方法
openstack mapping list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表48.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表48.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表48.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表48.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表48.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
48.4. mapping set
マッピングの属性を設定します。
使用方法
openstack mapping set [-h] [--rules <filename>] <name>
表48.14 位置引数
値 | 概要 |
---|---|
<name> | 変更するマッピング |
表48.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--rules <filename> | 新しいマッピングルールセットが含まれるファイル名 |
48.5. mapping show
マッピングの詳細を表示します。
使用方法
openstack mapping show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <mapping>
表48.16 位置引数
値 | 概要 |
---|---|
<mapping> | 表示するパッピング |
表48.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表48.18 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表48.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表48.20 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表48.21 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第49章 messaging
本章では、messaging
コマンドに含まれるコマンドについて説明します。
49.1. messaging claim create
要求を作成し、要求されたメッセージのリストを返します。
使用方法
openstack messaging claim create [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--ttl <ttl>] [--grace <grace>] [--limit <limit>] <queue_name>
表49.1 位置引数
値 | 概要 |
---|---|
<queue_name> | 要求するキューの名前 |
表49.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--ttl <ttl> | 要求の存続期間 (秒単位) |
--grace <grace> | メッセージの猶予期間 (秒単位) |
--limit <limit> | 制限まで、メッセージのセットを要求します。 |
表49.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表49.4 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表49.5 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.2. messaging claim query
要求の詳細を表示します。
使用方法
openstack messaging claim query [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <queue_name> <claim_id>
表49.7 位置引数
値 | 概要 |
---|---|
<queue_name> | 要求されたキューの名前 |
<claim_id> | 要求の ID |
表49.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表49.9 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表49.10 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表49.11 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.12 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.3. messaging claim release
要求を削除します。
使用方法
openstack messaging claim release [-h] <queue_name> <claim_id>
表49.13 位置引数
値 | 概要 |
---|---|
<queue_name> | 要求されたキューの名前 |
<claim_id> | 削除する要求 ID |
表49.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
49.4. messaging claim renew
要求を更新します。
使用方法
openstack messaging claim renew [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--ttl <ttl>] [--grace <grace>] <queue_name> <claim_id>
表49.15 位置引数
値 | 概要 |
---|---|
<queue_name> | 要求されたキューの名前 |
<claim_id> | 要求 ID |
表49.16 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--ttl <ttl> | 要求の存続期間 (秒単位) |
--grace <grace> | メッセージの猶予期間 (秒単位) |
表49.17 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表49.18 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表49.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.20 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.5. messaging flavor create
プールのフレーバーを作成します。
使用方法
openstack messaging flavor create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--pool_list <pool_list>] [--capabilities <capabilities>] <flavor_name>
表49.21 位置引数
値 | 概要 |
---|---|
<flavor_name> | フレーバーの名前 |
表49.22 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--pool_list <pool_list> | フレーバーのプールリスト |
--capabilities <capabilities> | フレーバー固有の機能を記述します。このオプションはクライアント api バージョン が 2 より前の場合のみ利用可能です。 |
表49.23 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表49.24 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.25 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表49.26 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.6. messaging flavor delete
プールのフレーバーを削除します。
使用方法
openstack messaging flavor delete [-h] <flavor_name>
表49.27 位置引数
値 | 概要 |
---|---|
<flavor_name> | フレーバーの名前 |
表49.28 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
49.7. messaging flavor list
利用可能なプールのフレーバーをリスト表示します。
使用方法
openstack messaging flavor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker <flavor_name>] [--limit <limit>] [--detailed]
表49.29 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--marker <flavor_name> | フレーバーのページングマーカー |
--limit <limit> | ページサイズの制限 |
--detailed | フレーバーの詳細な機能を表示する場合 |
表49.30 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表49.31 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表49.32 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.33 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.8. messaging flavor show
プールフレーバーの詳細を表示します。
使用方法
openstack messaging flavor show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <flavor_name>
表49.34 位置引数
値 | 概要 |
---|---|
<flavor_name> | 表示するフレーバー (名前) |
表49.35 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表49.36 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表49.37 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.38 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表49.39 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.9. messaging flavor update
フレーバーの属性を更新します。
使用方法
openstack messaging flavor update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--pool_list <pool_list>] [--capabilities <capabilities>] <flavor_name>
表49.40 位置引数
値 | 概要 |
---|---|
<flavor_name> | フレーバーの名前 |
表49.41 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--pool_list <pool_list> | フレーバーが存在するプールのリスト |
--capabilities <capabilities> | フレーバー固有の機能を説明します。 |
表49.42 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表49.43 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.44 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表49.45 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.10. messaging health
Zaqar サーバーの詳細なヘルスステータスを表示します。
使用方法
openstack messaging health [-h]
表49.46 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
49.11. messaging homedoc
Zaqar サーバーの詳細なリソースドキュメントを表示します。
使用方法
openstack messaging homedoc [-h]
表49.47 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
49.12. messaging message list
指定のキューのすべてのメッセージをリスト表示します。
使用方法
openstack messaging message list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--message-ids <message_ids>] [--limit <limit>] [--echo] [--include-claimed] [--include-delayed] [--client-id <client_id>] <queue_name>
表49.48 位置引数
値 | 概要 |
---|---|
<queue_name> | キューの名前 |
表49.49 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--message-ids <message_ids> | 取得するメッセージの ID のリスト |
--limit <limit> | 取得するメッセージの最大数。 |
--echo | このクライアント自体のメッセージを受信するかどうか。 |
--include-claimed | 要求されたメッセージを含めるかどうか。 |
--include-delayed | 遅延メッセージを含めるかどうか。 |
--client-id <client_id> | 各クライアントインスタンスの UUID。 |
表49.50 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表49.51 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表49.52 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.53 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.13. messaging message post
指定のキューのメッセージを投稿します。
使用方法
openstack messaging message post [-h] [--client-id <client_id>] <queue_name> <messages>
表49.54 位置引数
値 | 概要 |
---|---|
<queue_name> | キューの名前 |
<messages> | 投稿されるメッセージ。 |
表49.55 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--client-id <client_id> | 各クライアントインスタンスの UUID。 |
49.14. messaging ping
Zaqar サーバーが稼働しているかどうかを確認します。
使用方法
openstack messaging ping [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
表49.56 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表49.57 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表49.58 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.59 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表49.60 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.15. messaging pool create
プールを作成します。
使用方法
openstack messaging pool create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--flavor <flavor>] [--pool_options <pool_options>] <pool_name> <pool_uri> <pool_weight>
表49.61 位置引数
値 | 概要 |
---|---|
<pool_name> | プールの名前 |
<pool_uri> | ストレージエンジン URI |
<pool_weight> | プールの重み |
表49.62 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--flavor <flavor> | プールのフレーバー |
--pool_options <pool_options> | ストレージ固有のオプションに関連するオプションの要求コンポーネント |
表49.63 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表49.64 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.65 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表49.66 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.16. messaging pool delete
プールを削除します。
使用方法
openstack messaging pool delete [-h] <pool_name>
表49.67 位置引数
値 | 概要 |
---|---|
<pool_name> | プールの名前 |
表49.68 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
49.17. messaging pool list
利用可能なプールをリスト表示します。
使用方法
openstack messaging pool list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker <pool_name>] [--limit <limit>] [--detailed]
表49.69 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--marker <pool_name> | プールのページングマーカー |
--limit <limit> | ページサイズの制限 |
--detailed | 詳細出力 |
表49.70 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表49.71 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表49.72 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.73 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.18. messaging pool show
プールの詳細を表示します。
使用方法
openstack messaging pool show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <pool_name>
表49.74 位置引数
値 | 概要 |
---|---|
<pool_name> | 表示するプール (名前) |
表49.75 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表49.76 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表49.77 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.78 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表49.79 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.19. messaging pool update
プール属性を更新します。
使用方法
openstack messaging pool update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--pool_uri <pool_uri>] [--pool_weight <pool_weight>] [--flavor <flavor>] [--pool_options <pool_options>] <pool_name>
表49.80 位置引数
値 | 概要 |
---|---|
<pool_name> | プールの名前 |
表49.81 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--pool_uri <pool_uri> | ストレージエンジン URI |
--pool_weight <pool_weight> | プールの重み |
--flavor <flavor> | プールのフレーバー |
--pool_options <pool_options> | ストレージ固有のオプションに関連するオプションの要求コンポーネント |
表49.82 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表49.83 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.84 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表49.85 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.20. messaging queue create
キューを作成します。
使用方法
openstack messaging queue create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <queue_name>
表49.86 位置引数
値 | 概要 |
---|---|
<queue_name> | キューの名前 |
表49.87 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表49.88 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表49.89 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.90 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表49.91 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.21. messaging queue delete
キューを削除します。
使用方法
openstack messaging queue delete [-h] <queue_name>
表49.92 位置引数
値 | 概要 |
---|---|
<queue_name> | キューの名前 |
表49.93 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
49.22. messaging queue get metadata
キューのメタデータを取得します。
使用方法
openstack messaging queue get metadata [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <queue_name>
表49.94 位置引数
値 | 概要 |
---|---|
<queue_name> | キューの名前 |
表49.95 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表49.96 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表49.97 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.98 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表49.99 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.23. messaging queue list
利用可能なキューをリスト表示します。
使用方法
openstack messaging queue list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker <queue_id>] [--limit <limit>] [--detailed]
表49.100 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--marker <queue_id> | キューのページングマーカー |
--limit <limit> | ページサイズの制限 |
--detailed | キューの詳細情報を表示する場合 |
表49.101 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表49.102 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表49.103 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.104 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.24. messaging queue purge
キューをパージします。
使用方法
openstack messaging queue purge [-h] [--resource_types <resource_types>] <queue_name>
表49.105 位置引数
値 | 概要 |
---|---|
<queue_name> | キューの名前 |
表49.106 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resource_types <resource_types> | パージするリソースタイプ。 |
49.25. messaging queue set metadata
キューのメタデータを設定します。
使用方法
openstack messaging queue set metadata [-h] <queue_name> <queue_metadata>
表49.107 位置引数
値 | 概要 |
---|---|
<queue_name> | キューの名前 |
<queue_metadata> | キューメタデータ。キューのメタデータはすべて queue_metadata に置き換えられます。 |
表49.108 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
49.26. messaging queue signed url
事前に署名された URL を作成します。
使用方法
openstack messaging queue signed url [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--paths <paths>] [--ttl-seconds <ttl_seconds>] [--methods <methods>] <queue_name>
表49.109 位置引数
値 | 概要 |
---|---|
<queue_name> | キューの名前 |
表49.110 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--paths <paths> | 許可されるパスのコンマ区切りリスト。オプション:messages、subscriptions、claims |
--ttl-seconds <ttl_seconds> | 署名の有効期限が切れるまでの期間 (秒単位) |
--methods <methods> | 許可する HTTP メソッドのコンマ区切りリスト。オプション:GET、HEAD、OPTIONS、POST、PUT、DELETE |
表49.111 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表49.112 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.113 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表49.114 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.27. messaging queue stats
キューの統計値を取得します。
使用方法
openstack messaging queue stats [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <queue_name>
表49.115 位置引数
値 | 概要 |
---|---|
<queue_name> | キューの名前 |
表49.116 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表49.117 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表49.118 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.119 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表49.120 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.28. messaging subscription create
キューのサブスクリプションを作成します。
使用方法
openstack messaging subscription create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--options <options>] <queue_name> <subscriber> <ttl>
表49.121 位置引数
値 | 概要 |
---|---|
<queue_name> | サブスクライブするキューの名前 |
<subscriber> | 通知されるサブスクライバー |
<ttl> | サブスクリプションの存続期間 (秒単位) |
表49.122 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--options <options> | json 形式のサブスクリプションのメタデータ |
表49.123 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表49.124 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.125 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表49.126 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.29. messaging subscription delete
サブスクリプションを削除します。
使用方法
openstack messaging subscription delete [-h] <queue_name> <subscription_id>
表49.127 位置引数
値 | 概要 |
---|---|
<queue_name> | サブスクリプションのキューの名前 |
<subscription_id> | サブスクリプションの ID |
表49.128 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
49.30. messaging subscription list
利用可能なサブスクリプションをリスト表示します。
使用方法
openstack messaging subscription list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker <subscription_id>] [--limit <limit>] <queue_name>
表49.129 位置引数
値 | 概要 |
---|---|
<queue_name> | サブスクライブするキューの名前 |
表49.130 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--marker <subscription_id> | サブスクリプションのページングマーカー、前のページにある最後のサブスクリプションの ID |
--limit <limit> | ページサイズの制限。デフォルト値は 20 です。 |
表49.131 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表49.132 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表49.133 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.134 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.31. messaging subscription show
サブスクリプションの詳細を表示します。
使用方法
openstack messaging subscription show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <queue_name> <subscription_id>
表49.135 位置引数
値 | 概要 |
---|---|
<queue_name> | サブスクライブするキューの名前 |
<subscription_id> | サブスクリプションの ID |
表49.136 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表49.137 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表49.138 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.139 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表49.140 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
49.32. messaging subscription update
サブスクリプションを更新します。
使用方法
openstack messaging subscription update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--subscriber <subscriber>] [--ttl <ttl>] [--options <options>] <queue_name> <subscription_id>
表49.141 位置引数
値 | 概要 |
---|---|
<queue_name> | サブスクライブするキューの名前 |
<subscription_id> | サブスクリプションの ID |
表49.142 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--subscriber <subscriber> | 通知されるサブスクライバー |
--ttl <ttl> | サブスクリプションの存続期間 (秒単位) |
--options <options> | json 形式のサブスクリプションのメタデータ |
表49.143 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表49.144 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表49.145 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表49.146 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第50章 metric
本章では、metric
コマンドに含まれるコマンドについて説明します。
50.1. metric aggregates
集約されたメトリックの計測値を取得します。
使用方法
openstack metric aggregates [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--resource-type RESOURCE_TYPE] [--start START] [--stop STOP] [--granularity GRANULARITY] [--needed-overlap NEEDED_OVERLAP] [--groupby GROUPBY] [--fill FILL] operations [search]
表50.1 位置引数
値 | 概要 |
---|---|
operations | 時系列に適用する操作 |
search | リソースをフィルターするクエリー。構文は、属性、演算子、および値の組み合わせです。たとえば、id=90d58eea-70d7-4294-a49a-170dcdf44c3c は特定の ID でリソースをフィルタリングします。より複雑なクエリーを構築することができます (例:not (flavor_id!="1" and memory>=24))。"" を使用して、データを文字列として解釈するように強制します。サポートされる演算子は not、and、∧、or、∨、>=、⇐、!=、>、<、=、==、eq、ne、lt、gt、ge、le、in、like、≠、≥、≤、like、in です。 |
表50.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resource-type RESOURCE_TYPE | 問い合わせるリソースタイプ |
--start START | 期間の開始 |
--stop STOP | 期間の終了 |
--granularity GRANULARITY | 取得する際の詳細度 |
--needed-overlap NEEDED_OVERLAP | データポイント間での重複の割合 |
--groupby GROUPBY | リソースをグループ化するために使用する属性 |
--fill FILL | シリーズのサブセットに値がない状態でタイムスタンプをバックフィルする際に使用する値。値は浮動小数点または null である必要があります。 |
表50.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表50.4 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表50.5 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.2. metric archive-policy create
アーカイブポリシーを作成します。
使用方法
openstack metric archive-policy create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] -d <DEFINITION> [-b BACK_WINDOW] [-m AGGREGATION_METHODS] name
表50.7 位置引数
値 | 概要 |
---|---|
name | アーカイブポリシーの名前 |
表50.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-D <DEFINITION>、--definition <DEFINITION> | 名前と値を:で区切った、アーカイブポリシー定義の (,で区切られた)2 つの属性 |
-b BACK_WINDOW, --back-window BACK_WINDOW | アーカイブポリシーのバックウィンドウ |
-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS | アーカイブポリシーの集約メソッド |
表50.9 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.10 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.11 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.12 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.3. metric archive-policy delete
アーカイブポリシーを削除します。
使用方法
openstack metric archive-policy delete [-h] name
表50.13 位置引数
値 | 概要 |
---|---|
name | アーカイブポリシーの名前 |
表50.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
50.4. metric archive-policy list
アーカイブポリシーをリスト表示します。
使用方法
openstack metric archive-policy list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表50.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表50.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表50.17 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表50.18 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.5. metric archive-policy-rule create
アーカイブポリシールールを作成します。
使用方法
openstack metric archive-policy-rule create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] -a ARCHIVE_POLICY_NAME -m METRIC_PATTERN name
表50.20 位置引数
値 | 概要 |
---|---|
name | ルール名 |
表50.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME | アーカイブポリシー名 |
-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN | 照合するメトリック名のワイルドカード |
表50.22 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.23 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.24 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.25 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.6. metric archive-policy-rule delete
アーカイブポリシールールを削除します。
使用方法
openstack metric archive-policy-rule delete [-h] name
表50.26 位置引数
値 | 概要 |
---|---|
name | アーカイブポリシールールの名前 |
表50.27 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
50.7. metric archive-policy-rule list
アーカイブポリシールールをリスト表示します。
使用方法
openstack metric archive-policy-rule list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表50.28 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表50.29 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表50.30 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表50.31 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.32 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.8. metric archive-policy-rule show
アーカイブポリシールールを表示します。
使用方法
openstack metric archive-policy-rule show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] name
表50.33 位置引数
値 | 概要 |
---|---|
name | アーカイブポリシールールの名前 |
表50.34 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表50.35 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.36 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.37 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.38 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.9. metric archive-policy show
アーカイブポリシーを表示します。
使用方法
openstack metric archive-policy show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] name
表50.39 位置引数
値 | 概要 |
---|---|
name | アーカイブポリシーの名前 |
表50.40 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表50.41 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.42 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.43 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.44 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.10. metric archive-policy update
アーカイブポリシーを更新します。
使用方法
openstack metric archive-policy update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] -d <DEFINITION> name
表50.45 位置引数
値 | 概要 |
---|---|
name | アーカイブポリシーの名前 |
表50.46 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-D <DEFINITION>、--definition <DEFINITION> | 名前と値を:で区切った、アーカイブポリシー定義の (,で区切られた)2 つの属性 |
表50.47 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.48 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.49 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.50 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.11. metric benchmark measures add
測定の追加のベンチマークテストを行います。
使用方法
openstack metric benchmark measures add [-h] [--resource-id RESOURCE_ID] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--workers WORKERS] --count COUNT [--batch BATCH] [--timestamp-start TIMESTAMP_START] [--timestamp-end TIMESTAMP_END] [--wait] metric
表50.51 位置引数
値 | 概要 |
---|---|
metric | メトリックの ID または名前 |
表50.52 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resource-id RESOURCE_ID, -r RESOURCE_ID | リソースの ID |
--workers WORKERS, -w WORKERS | 使用するワーカー数 |
--count COUNT, -n COUNT | 送信する合計計測値の数 |
--batch BATCH, -b BATCH | 各バッチで送信する計測値の数 |
--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START | 使用する最初のタイムスタンプ |
--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END | 使用する最終タイムスタンプ |
--wait | 全計測が処理されるのを待ちます。 |
表50.53 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.54 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.55 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.56 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.12. metric benchmark measures show
measurements show のベンチマークテストを行います。
使用方法
openstack metric benchmark measures show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--utc] [--resource-id RESOURCE_ID] [--aggregation AGGREGATION] [--start START] [--stop STOP] [--granularity GRANULARITY] [--refresh] [--resample RESAMPLE] [--workers WORKERS] --count COUNT metric
表50.57 位置引数
値 | 概要 |
---|---|
metric | メトリックの ID または名前 |
表50.58 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--utc | タイムスタンプを utc として返します。 |
--resource-id RESOURCE_ID, -r RESOURCE_ID | リソースの ID |
--aggregation AGGREGATION | 取得する集約 |
--start START | 期間の開始 |
--stop STOP | 期間の終了 |
--granularity GRANULARITY | 取得する際の詳細度 |
--refresh | すべての既知の計測値を強制的に集計します。 |
--resample RESMYBACKUPDIRLE | 時系列を再サンプリングする粒度 (秒単位) |
--workers WORKERS, -w WORKERS | 使用するワーカー数 |
--count COUNT, -n COUNT | 送信する合計計測値の数 |
表50.59 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表50.60 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.61 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.62 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.13. metric benchmark metric create
メトリック作成のベンチマークテストを行います。
使用方法
openstack metric benchmark metric create [-h] [--resource-id RESOURCE_ID] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--archive-policy-name ARCHIVE_POLICY_NAME] [--workers WORKERS] --count COUNT [--keep]
表50.63 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resource-id RESOURCE_ID, -r RESOURCE_ID | リソースの ID |
--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME | アーカイブポリシーの名前 |
--workers WORKERS, -w WORKERS | 使用するワーカー数 |
--count COUNT, -n COUNT | 作成するメトリックの数 |
--keep, -k | 作成されたメトリックを保持します。 |
表50.64 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.65 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.66 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.67 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.14. metric benchmark metric show
metric show のベンチマークテストを行います。
使用方法
openstack metric benchmark metric show [-h] [--resource-id RESOURCE_ID] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--workers WORKERS] --count COUNT metric [metric ...]
表50.68 位置引数
値 | 概要 |
---|---|
metric | メトリック ID または名前 |
表50.69 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resource-id RESOURCE_ID, -r RESOURCE_ID | リソースの ID |
--workers WORKERS, -w WORKERS | 使用するワーカー数 |
--count COUNT, -n COUNT | 取得するメトリックの数 |
表50.70 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.71 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.72 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.73 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.15. metric capabilities list
機能をリスト表示します。
使用方法
openstack metric capabilities list [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
表50.74 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表50.75 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.76 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.77 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.78 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.16. metric create
メトリックを作成します。
使用方法
openstack metric create [-h] [--resource-id RESOURCE_ID] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--archive-policy-name ARCHIVE_POLICY_NAME] [--unit UNIT] [METRIC_NAME]
表50.79 位置引数
値 | 概要 |
---|---|
METRIC_NAME | メトリックの名前 |
表50.80 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resource-id RESOURCE_ID, -r RESOURCE_ID | リソースの ID |
--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME | アーカイブポリシーの名前 |
--unit UNIT, -u UNIT | メトリックの単位 |
表50.81 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.82 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.83 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.84 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.17. metric delete
メトリックを削除します。
使用方法
openstack metric delete [-h] [--resource-id RESOURCE_ID] metric [metric ...]
表50.85 位置引数
値 | 概要 |
---|---|
metric | メトリックの ID または名前 |
表50.86 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resource-id RESOURCE_ID, -r RESOURCE_ID | リソースの ID |
50.18. metric list
メトリックをリスト表示します。
使用方法
openstack metric list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT>]
表50.87 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit <LIMIT> | 返すメトリックの数 (デフォルトはサーバーのデフォルトです) |
--marker <MARKER> | 前のリストの最後のアイテム。この値の後に来る結果を返します。 |
--sort <SORT> | メトリック属性のソート (例:user_id:desc- nullslast) |
表50.88 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表50.89 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表50.90 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.91 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.19. metric measures add
計測値をメトリックに追加します。
使用方法
openstack metric measures add [-h] [--resource-id RESOURCE_ID] -m MEASURE metric
表50.92 位置引数
値 | 概要 |
---|---|
metric | メトリックの ID または名前 |
表50.93 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resource-id RESOURCE_ID, -r RESOURCE_ID | リソースの ID |
-m MEASURE、--measure MEASURE | @で区切った計測のタイムスタンプおよび値 |
50.20. metric measures aggregation
集約されたメトリックの計測値を取得します。
使用方法
openstack metric measures aggregation [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--utc] -m METRIC [METRIC ...] [--aggregation AGGREGATION] [--reaggregation REAGGREGATION] [--start START] [--stop STOP] [--granularity GRANULARITY] [--needed-overlap NEEDED_OVERLAP] [--query QUERY] [--resource-type RESOURCE_TYPE] [--groupby GROUPBY] [--refresh] [--resample RESAMPLE] [--fill FILL]
表50.94 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--utc | タイムスタンプを utc として返します。 |
-m METRIC [METRIC …], --metric METRIC [METRIC …] | メトリック ID またはメトリック名 |
--aggregation AGGREGATION | 取得する粒度集約機能 |
--reaggregation REAGGREGATION | 取得する groupBy 集約機能 |
--start START | 期間の開始 |
--stop STOP | 期間の終了 |
--granularity GRANULARITY | 取得する際の詳細度 |
--needed-overlap NEEDED_OVERLAP | 要求される各メトリックのデータポイントの割合 (パーセント) |
--query QUERY | リソースをフィルターするクエリー。構文は、属性、演算子、および値の組み合わせです。たとえば、id=90d58eea-70d7-4294-a49a-170dcdf44c3c は特定の ID でリソースをフィルタリングします。より複雑なクエリーを構築することができます (例:not (flavor_id!="1" and memory>=24))。"" を使用して、データを文字列として解釈するように強制します。サポートされる演算子は not、and、∧、or、∨、>=、⇐、!=、>、<、=、==、eq、ne、lt、gt、ge、le、in、like、≠、≥、≤、like、in です。 |
--resource-type RESOURCE_TYPE | 問い合わせるリソースタイプ |
--groupby GROUPBY | リソースをグループ化するために使用する属性 |
--refresh | すべての既知の計測値を強制的に集計します。 |
--resample RESMYBACKUPDIRLE | 時系列を再サンプリングする粒度 (秒単位) |
--fill FILL | シリーズのサブセットに値がない状態でタイムスタンプをバックフィルする際に使用する値。値は浮動小数点または null である必要があります。 |
表50.95 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表50.96 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表50.97 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.98 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.21. metric measures batch-metrics
使用方法
openstack metric measures batch-metrics [-h] file
表50.99 位置引数
値 | 概要 |
---|---|
file | バッチ処理または stdin の測定値が含まれるファイル (形式は Gnocchi REST API のドキュメントを参照してください)。 |
表50.100 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
50.22. metric measures batch-resources-metrics
使用方法
openstack metric measures batch-resources-metrics [-h] [--create-metrics] file
表50.101 位置引数
値 | 概要 |
---|---|
file | バッチ処理または stdin の測定値が含まれるファイル (形式は Gnocchi REST API のドキュメントを参照してください)。 |
表50.102 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--create-metrics | 不明なメトリックを作成します。 |
50.23. metric measures show
メトリックの測定値を取得します。
使用方法
openstack metric measures show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--utc] [--resource-id RESOURCE_ID] [--aggregation AGGREGATION] [--start START] [--stop STOP] [--granularity GRANULARITY] [--refresh] [--resample RESAMPLE] metric
表50.103 位置引数
値 | 概要 |
---|---|
metric | メトリックの ID または名前 |
表50.104 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--utc | タイムスタンプを utc として返します。 |
--resource-id RESOURCE_ID, -r RESOURCE_ID | リソースの ID |
--aggregation AGGREGATION | 取得する集約 |
--start START | 期間の開始 |
--stop STOP | 期間の終了 |
--granularity GRANULARITY | 取得する際の詳細度 |
--refresh | すべての既知の計測値を強制的に集計します。 |
--resample RESMYBACKUPDIRLE | 時系列を再サンプリングする粒度 (秒単位) |
表50.105 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表50.106 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表50.107 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.108 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.24. metric metric create
非推奨: メトリックを作成します。
使用方法
openstack metric metric create [-h] [--resource-id RESOURCE_ID] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--archive-policy-name ARCHIVE_POLICY_NAME] [--unit UNIT] [METRIC_NAME]
表50.109 位置引数
値 | 概要 |
---|---|
METRIC_NAME | メトリックの名前 |
表50.110 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resource-id RESOURCE_ID, -r RESOURCE_ID | リソースの ID |
--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME | アーカイブポリシーの名前 |
--unit UNIT, -u UNIT | メトリックの単位 |
表50.111 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.112 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.113 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.114 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.25. metric metric delete
非推奨: メトリックを削除します。
使用方法
openstack metric metric delete [-h] [--resource-id RESOURCE_ID] metric [metric ...]
表50.115 位置引数
値 | 概要 |
---|---|
metric | メトリックの ID または名前 |
表50.116 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resource-id RESOURCE_ID, -r RESOURCE_ID | リソースの ID |
50.26. metric metric list
非推奨: メトリックをリスト表示します。
使用方法
openstack metric metric list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT>]
表50.117 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit <LIMIT> | 返すメトリックの数 (デフォルトはサーバーのデフォルトです) |
--marker <MARKER> | 前のリストの最後のアイテム。この値の後に来る結果を返します。 |
--sort <SORT> | メトリック属性のソート (例:user_id:desc- nullslast) |
表50.118 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表50.119 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表50.120 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.121 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.27. metric metric show
非推奨: メトリックを表示します。
使用方法
openstack metric metric show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--resource-id RESOURCE_ID] metric
表50.122 位置引数
値 | 概要 |
---|---|
metric | メトリックの ID または名前 |
表50.123 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resource-id RESOURCE_ID, -r RESOURCE_ID | リソースの ID |
表50.124 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.125 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.126 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.127 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.28. metric resource batch delete
属性値に基づいてリソースのバッチを削除します。
使用方法
openstack metric resource batch delete [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--type RESOURCE_TYPE] query
表50.128 位置引数
値 | 概要 |
---|---|
query | リソースをフィルターするクエリー。構文は、属性、演算子、および値の組み合わせです。たとえば、id=90d58eea-70d7-4294-a49a-170dcdf44c3c は特定の ID でリソースをフィルタリングします。より複雑なクエリーを構築することができます (例:not (flavor_id!="1" and memory>=24))。"" を使用して、データを文字列として解釈するように強制します。サポートされる演算子は not、and、∧、or、∨、>=、⇐、!=、>、<、=、==、eq、ne、lt、gt、ge、le、in、like、≠、≥、≤、like、in です。 |
表50.129 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--type RESOURCE_TYPE, -t RESOURCE_TYPE | リソースのタイプ |
表50.130 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.131 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.132 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.133 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.29. metric resource create
リソースを作成します。
使用方法
openstack metric resource create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--type RESOURCE_TYPE] [-a ATTRIBUTE] [-m ADD_METRIC] [-n CREATE_METRIC] resource_id
表50.134 位置引数
値 | 概要 |
---|---|
resource_id | リソースの ID |
表50.135 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--type RESOURCE_TYPE, -t RESOURCE_TYPE | リソースのタイプ |
-a MYBACKUPDIR、--attribute MYBACKUPDIR | :で区切った属性の名前および値 |
-m ADD_METRIC, --add-metric ADD_METRIC | 追加するメトリックの Name:id |
-n CREATE_METRIC, --create-metric CREATE_METRIC | 作成するメトリックの Name:archive_policy_name |
表50.136 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.137 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.138 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.139 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.30. metric resource delete
リソースを削除します。
使用方法
openstack metric resource delete [-h] resource_id
表50.140 位置引数
値 | 概要 |
---|---|
resource_id | リソースの ID |
表50.141 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
50.31. metric resource history
リソースの履歴を表示します。
使用方法
openstack metric resource history [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--details] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT>] [--type RESOURCE_TYPE] resource_id
表50.142 位置引数
値 | 概要 |
---|---|
resource_id | リソースの ID |
表50.143 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--details | 汎用リソースの属性をすべて表示します。 |
--limit <LIMIT> | 返すリソースの数 (デフォルトはサーバーのデフォルトです)。 |
--marker <MARKER> | 前のリストの最後のアイテム。この値の後に来る結果を返します。 |
--sort <SORT> | リソース属性のソート (例:user_id:desc- nullslast) |
--type RESOURCE_TYPE, -t RESOURCE_TYPE | リソースのタイプ |
表50.144 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表50.145 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表50.146 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.147 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.32. metric resource list
リソースをリスト表示します。
使用方法
openstack metric resource list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--details] [--history] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT>] [--type RESOURCE_TYPE]
表50.148 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--details | 汎用リソースの属性をすべて表示します。 |
--history | リソースの履歴を表示します。 |
--limit <LIMIT> | 返すリソースの数 (デフォルトはサーバーのデフォルトです)。 |
--marker <MARKER> | 前のリストの最後のアイテム。この値の後に来る結果を返します。 |
--sort <SORT> | リソース属性のソート (例:user_id:desc- nullslast) |
--type RESOURCE_TYPE, -t RESOURCE_TYPE | リソースのタイプ |
表50.149 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表50.150 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表50.151 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.152 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.33. metric resource search
指定のクエリールールでリソースを検索します。
使用方法
openstack metric resource search [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--details] [--history] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT>] [--type RESOURCE_TYPE] query
表50.153 位置引数
値 | 概要 |
---|---|
query | リソースをフィルターするクエリー。構文は、属性、演算子、および値の組み合わせです。たとえば、id=90d58eea-70d7-4294-a49a-170dcdf44c3c は特定の ID でリソースをフィルタリングします。より複雑なクエリーを構築することができます (例:not (flavor_id!="1" and memory>=24))。"" を使用して、データを文字列として解釈するように強制します。サポートされる演算子は not、and、∧、or、∨、>=、⇐、!=、>、<、=、==、eq、ne、lt、gt、ge、le、in、like、≠、≥、≤、like、in です。 |
表50.154 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--details | 汎用リソースの属性をすべて表示します。 |
--history | リソースの履歴を表示します。 |
--limit <LIMIT> | 返すリソースの数 (デフォルトはサーバーのデフォルトです)。 |
--marker <MARKER> | 前のリストの最後のアイテム。この値の後に来る結果を返します。 |
--sort <SORT> | リソース属性のソート (例:user_id:desc- nullslast) |
--type RESOURCE_TYPE, -t RESOURCE_TYPE | リソースのタイプ |
表50.155 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表50.156 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表50.157 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.158 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.34. metric resource show
リソースを表示します。
使用方法
openstack metric resource show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--type RESOURCE_TYPE] resource_id
表50.159 位置引数
値 | 概要 |
---|---|
resource_id | リソースの ID |
表50.160 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--type RESOURCE_TYPE, -t RESOURCE_TYPE | リソースのタイプ |
表50.161 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.162 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.163 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.164 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.35. metric resource-type create
リソース種別を作成します。
使用方法
openstack metric resource-type create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [-a ATTRIBUTE] name
表50.165 位置引数
値 | 概要 |
---|---|
name | リソース種別の名前 |
表50.166 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-a MYBACKUPDIR、--attribute MYBACKUPDIR | 属性定義、attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:… 例: display_name:string:true:max_length=255 |
表50.167 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.168 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.169 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.170 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.36. metric resource-type delete
リソース種別を削除します。
使用方法
openstack metric resource-type delete [-h] name
表50.171 位置引数
値 | 概要 |
---|---|
name | リソース種別の名前 |
表50.172 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
50.37. metric resource-type list
リソース種別をリスト表示します。
使用方法
openstack metric resource-type list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表50.173 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表50.174 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表50.175 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表50.176 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.177 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.38. metric resource-type show
リソース種別を表示します。
使用方法
openstack metric resource-type show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] name
表50.178 位置引数
値 | 概要 |
---|---|
name | リソース種別の名前 |
表50.179 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表50.180 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.181 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.182 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.183 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.39. metric resource-type update
リソース種別を作成します。
使用方法
openstack metric resource-type update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [-a ATTRIBUTE] [-r REMOVE_ATTRIBUTE] name
表50.184 位置引数
値 | 概要 |
---|---|
name | リソース種別の名前 |
表50.185 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-a MYBACKUPDIR、--attribute MYBACKUPDIR | 属性定義、attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:… 例: display_name:string:true:max_length=255 |
-r REMOVE_ATTRIBUTE, --remove-attribute REMOVE_ATTRIBUTE | Attribute name |
表50.186 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.187 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.188 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.189 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.40. metric resource update
リソースを更新します。
使用方法
openstack metric resource update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--type RESOURCE_TYPE] [-a ATTRIBUTE] [-m ADD_METRIC] [-n CREATE_METRIC] [-d DELETE_METRIC] resource_id
表50.190 位置引数
値 | 概要 |
---|---|
resource_id | リソースの ID |
表50.191 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--type RESOURCE_TYPE, -t RESOURCE_TYPE | リソースのタイプ |
-a MYBACKUPDIR、--attribute MYBACKUPDIR | :で区切った属性の名前および値 |
-m ADD_METRIC, --add-metric ADD_METRIC | 追加するメトリックの Name:id |
-n CREATE_METRIC, --create-metric CREATE_METRIC | 作成するメトリックの Name:archive_policy_name |
-d DELETE_METRIC, --delete-metric DELETE_METRIC | 削除するメトリックの名前 |
表50.192 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.193 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.194 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.195 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.41. metric server version
Gnocchi サーバーのバージョンを表示します。
使用方法
openstack metric server version [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
表50.196 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表50.197 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.198 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.199 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.200 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.42. metric show
メトリックを表示します。
使用方法
openstack metric show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--resource-id RESOURCE_ID] metric
表50.201 位置引数
値 | 概要 |
---|---|
metric | メトリックの ID または名前 |
表50.202 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resource-id RESOURCE_ID, -r RESOURCE_ID | リソースの ID |
表50.203 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.204 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.205 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.206 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
50.43. metric status
測定値処理のステータスを表示します。
使用方法
openstack metric status [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
表50.207 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表50.208 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表50.209 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表50.210 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表50.211 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第51章 module
本章では、module
コマンドに含まれるコマンドについて説明します。
51.1. module list
モジュールのバージョンをリスト表示します。
使用方法
openstack module list [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all]
表51.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all | バージョン情報を持つモジュールをすべて表示します。 |
表51.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表51.3 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表51.4 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表51.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第52章 network
本章では、network
コマンドに含まれるコマンドについて説明します。
52.1. network agent add network
エージェントにネットワークを追加します。
使用方法
openstack network agent add network [-h] [--dhcp] <agent-id> <network>
表52.1 位置引数
値 | 概要 |
---|---|
<agent-id> | ネットワークが追加されるエージェント (id のみ) |
<network> | エージェントに追加されるネットワーク (名前または ID) |
表52.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--dhcp | dhcp エージェントにネットワークを追加します。 |
52.2. network agent add router
エージェントにルーターを追加します。
使用方法
openstack network agent add router [-h] [--l3] <agent-id> <router>
表52.3 位置引数
値 | 概要 |
---|---|
<agent-id> | ルーターが追加されるエージェント (id のみ) |
<router> | エージェントに追加されるルーター (名前または ID) |
表52.4 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--l3 | ルーターを l3 エージェントに追加します。 |
52.3. network agent delete
ネットワークエージェントを削除します。
使用方法
openstack network agent delete [-h] <network-agent> [<network-agent> ...]
表52.5 位置引数
値 | 概要 |
---|---|
<network-agent> | 削除するネットワークエージェント (id のみ) |
表52.6 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.4. network agent list
ネットワークエージェントのリストを表示します。
使用方法
openstack network agent list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--agent-type <agent-type>] [--host <host>] [--network <network> | --router <router>] [--long]
表52.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--agent-type <agent-type> | 指定したエージェントタイプのエージェントのみをリスト表示します。サポートされるエージェントタイプは、bgp、dhcp、open-vswitch、linux-bridge、ofa、l3、loadbalancer、metering、metadata、macvtap、nic です。 |
--host <host> | 指定されたホストで実行されているエージェントのみをリスト表示します。 |
--network <network> | ネットワークをホストするエージェント (名前または ID) をリスト表示します。 |
--router <router> | このルーターをホストするエージェントをリスト表示します (名前または ID)。 |
--long | 出力の追加フィールドをリスト表示します。 |
表52.8 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.9 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.10 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.11 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.5. network agent remove network
エージェントからネットワークを削除します。
使用方法
openstack network agent remove network [-h] [--dhcp] <agent-id> <network>
表52.12 位置引数
値 | 概要 |
---|---|
<agent-id> | ネットワークを削除するエージェント (id のみ) |
<network> | エージェントから削除されるネットワーク (名前または ID) |
表52.13 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--dhcp | dhcp エージェントからネットワークを削除します。 |
52.6. network agent remove router
エージェントからルーターを削除します。
使用方法
openstack network agent remove router [-h] [--l3] <agent-id> <router>
表52.14 位置引数
値 | 概要 |
---|---|
<agent-id> | ルーターを削除するエージェント (id のみ) |
<router> | エージェントから削除されるルーター (名前または ID) |
表52.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--l3 | l3 エージェントからルーターを削除します。 |
52.7. network agent set
ネットワークエージェントの属性を設定します。
使用方法
openstack network agent set [-h] [--description <description>] [--enable | --disable] <network-agent>
表52.16 位置引数
値 | 概要 |
---|---|
<network-agent> | 変更するネットワークエージェント (id のみ) |
表52.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | ネットワークエージェントの説明を設定します。 |
--enable | ネットワークエージェントを有効にします。 |
--disable | ネットワークエージェントを無効にします。 |
52.8. network agent show
ネットワークエージェントの詳細を表示します。
使用方法
openstack network agent show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <network-agent>
表52.18 位置引数
値 | 概要 |
---|---|
<network-agent> | 表示するネットワークエージェント (id のみ) |
表52.19 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.20 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.21 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.22 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.23 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.9. network auto allocated topology create
プロジェクトの自動割り当てトポロジーを作成します。
使用方法
openstack network auto allocated topology create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--project <project>] [--project-domain <project-domain>] [--check-resources] [--or-show]
表52.24 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | 指定されたプロジェクトに対して自動的に割り当てられたトポロジーを返します。デフォルトは現在のプロジェクトです。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--check-resources | 自動割り当てトポロジーの要件を検証します。トポロジーを返しません。 |
--or-show | トポロジーが存在する場合は、トポロジーの情報を返します (デフォルト)。 |
表52.25 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.26 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.27 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.28 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.10. network auto allocated topology delete
プロジェクトの自動割り当てトポロジーを削除します。
使用方法
openstack network auto allocated topology delete [-h] [--project <project>] [--project-domain <project-domain>]
表52.29 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | 指定されたプロジェクトに対して自動的に割り当てられたトポロジーを削除します。デフォルトは現在のプロジェクトです。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
52.11. network create
新規ネットワークを作成します。
使用方法
openstack network create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--share | --no-share] [--enable | --disable] [--project <project>] [--description <description>] [--mtu <mtu>] [--project-domain <project-domain>] [--availability-zone-hint <availability-zone>] [--enable-port-security | --disable-port-security] [--external | --internal] [--default | --no-default] [--qos-policy <qos-policy>] [--transparent-vlan | --no-transparent-vlan] [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] [--provider-segment <provider-segment>] [--dns-domain <dns-domain>] [--tag <tag> | --no-tag] <name>
表52.30 位置引数
値 | 概要 |
---|---|
<name> | 新しいネットワーク名 |
表52.31 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--share | プロジェクト間でネットワークを共有します。 |
--no-share | プロジェクト間でネットワークを共有しません。 |
--enable | ネットワークを有効にします (デフォルト)。 |
--disable | ネットワークを無効にします。 |
--project <project> | 所有者のプロジェクト (名前または ID) |
--description <description> | ネットワークの説明を設定します。 |
--mtu <mtu> | ネットワークの mtu を設定します。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--availability-zone-hint <availability-zone> | このネットワークを作成するアベイラビリティーゾーン (Network Availability Zone 拡張機能が必要、複数のアベイラビリティーゾーンに設定するにはオプションを繰り返し使用します) |
--enable-port-security | このネットワークで作成されたポートで、デフォルトでポートセキュリティーを有効にします (デフォルト)。 |
--disable-port-security | このネットワークで作成されたポートで、デフォルトでポートセキュリティーを無効にします。 |
--external | このネットワークを外部ネットワークとして設定します (external-net 拡張機能が必要) |
--internal | このネットワークを内部ネットワークとして設定します (デフォルト)。 |
--default | このネットワークをデフォルトの外部ネットワークとして使用するかどうかを指定します。 |
--no-default | ネットワークをデフォルトの外部ネットワークとして使用しません (デフォルト)。 |
--qos-policy <qos-policy> | このネットワークにアタッチする QoS ポリシー (名前または ID) |
--transparent-vlan | ネットワーク vlan を透過的にします。 |
--no-transparent-vlan | ネットワーク vlan を透過的にしません。 |
--provider-network-type <provider-network-type> | 仮想ネットワークが実装される物理メカニズム。例:flat、geneve、gre、local、vlan、vxlan |
--provider-physical-network <provider-physical-network> | 仮想ネットワークが実装される物理ネットワークの名前 |
--provider-segment <provider-segment> | vlan ネットワークの VLAN id、または GENEVE/GRE/VXLAN ネットワークのトンネル ID |
--dns-domain <dns-domain> | このネットワークに dns ドメインを設定します (dns 統合拡張が必要です)。 |
--tag <tag> | ネットワークに追加するタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--no-tag | ネットワークにタグを関連付けません。 |
表52.32 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.33 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.34 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.35 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.12. network delete
ネットワークを削除します。
使用方法
openstack network delete [-h] <network> [<network> ...]
表52.36 位置引数
値 | 概要 |
---|---|
<network> | 削除するネットワーク (名前または ID) |
表52.37 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.13. network flavor add profile
サービスプロファイルをネットワークフレーバーに追加します。
使用方法
openstack network flavor add profile [-h] <flavor> <service-profile>
表52.38 位置引数
値 | 概要 |
---|---|
<flavor> | ネットワークフレーバー (名前または ID) |
<service-profile> | サービスプロファイル (id のみ) |
表52.39 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.14. network flavor create
新規ネットワークフレーバーを作成します。
使用方法
openstack network flavor create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --service-type <service-type> [--description DESCRIPTION] [--project <project>] [--project-domain <project-domain>] [--enable | --disable] <name>
表52.40 位置引数
値 | 概要 |
---|---|
<name> | フレーバーの名前 |
表52.41 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--service-type <service-type> | フレーバーを適用するサービス種別 (例:vpn)。ロードされた例は openstack network service provider list を参照してください。 |
--description DESCRIPTION | フレーバーの説明 |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--enable | フレーバーを有効にします (デフォルト)。 |
--disable | フレーバーを無効にします。 |
表52.42 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.43 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.44 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.45 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.15. network flavor delete
ネットワークフレーバーを削除します。
使用方法
openstack network flavor delete [-h] <flavor> [<flavor> ...]
表52.46 位置引数
値 | 概要 |
---|---|
<flavor> | 削除するフレーバー (名前または ID) |
表52.47 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.16. network flavor list
ネットワークフレーバーをリスト表示します。
使用方法
openstack network flavor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表52.48 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.49 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.50 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.51 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.52 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.17. network flavor profile create
新規ネットワークフレーバープロファイルを作成します。
使用方法
openstack network flavor profile create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--project <project>] [--project-domain <project-domain>] [--description <description>] [--enable | --disable] [--driver DRIVER] [--metainfo METAINFO]
表52.53 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--description <description> | フレーバープロファイルの説明 |
--enable | フレーバープロファイルを有効にします。 |
--disable | フレーバープロファイルを無効にします。 |
--driver DRIVER | ドライバーへの Python モジュールパス。これは、--metainfo がない場合は必須です (逆の場合も同様)。 |
--metainfo METAINFO | フレーバープロファイルの metainfo。これは、--driver がない場合は必須です (逆の場合も同様)。 |
表52.54 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.55 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.56 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.57 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.18. network flavor profile delete
ネットワークフレーバープロファイルを削除します。
使用方法
openstack network flavor profile delete [-h] <flavor-profile> [<flavor-profile> ...]
表52.58 位置引数
値 | 概要 |
---|---|
<flavor-profile> | 削除するフレーバープロファイル (id のみ) |
表52.59 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.19. network flavor profile list
ネットワークフレーバープロファイルをリスト表示します。
使用方法
openstack network flavor profile list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表52.60 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.61 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.62 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.63 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.64 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.20. network flavor profile set
ネットワークフレーバープロファイル属性を設定します。
使用方法
openstack network flavor profile set [-h] [--project-domain <project-domain>] [--description <description>] [--enable | --disable] [--driver DRIVER] [--metainfo METAINFO] <flavor-profile>
表52.65 位置引数
値 | 概要 |
---|---|
<flavor-profile> | 更新するフレーバープロファイル (id のみ) |
表52.66 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--description <description> | フレーバープロファイルの説明 |
--enable | フレーバープロファイルを有効にします。 |
--disable | フレーバープロファイルを無効にします。 |
--driver DRIVER | ドライバーへの Python モジュールパス。これは、--metainfo がない場合は必須です (逆の場合も同様)。 |
--metainfo METAINFO | フレーバープロファイルの metainfo。これは、--driver がない場合は必須です (逆の場合も同様)。 |
52.21. network flavor profile show
ネットワークフレーバープロファイルの詳細を表示します。
使用方法
openstack network flavor profile show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <flavor-profile>
表52.67 位置引数
値 | 概要 |
---|---|
<flavor-profile> | 表示するフレーバープロファイル (id のみ) |
表52.68 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.69 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.70 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.71 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.72 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.22. network flavor remove profile
ネットワークフレーバーからサービスプロファイルを削除します。
使用方法
openstack network flavor remove profile [-h] <flavor> <service-profile>
表52.73 位置引数
値 | 概要 |
---|---|
<flavor> | ネットワークフレーバー (名前または ID) |
<service-profile> | サービスプロファイル (id のみ) |
表52.74 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.23. network flavor set
ネットワークフレーバー属性を設定します。
使用方法
openstack network flavor set [-h] [--description DESCRIPTION] [--disable | --enable] [--name <name>] <flavor>
表52.75 位置引数
値 | 概要 |
---|---|
<flavor> | 更新するフレーバー (名前または ID) |
表52.76 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description DESCRIPTION | ネットワークフレーバーの説明を設定します。 |
--disable | ネットワークフレーバーを無効にします。 |
--enable | ネットワークフレーバーを有効にします。 |
--name <name> | フレーバー名を設定します。 |
52.24. network flavor show
ネットワークフレーバーの詳細を表示します。
使用方法
openstack network flavor show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <flavor>
表52.77 位置引数
値 | 概要 |
---|---|
<flavor> | 表示するフレーバー (名前または ID) |
表52.78 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.79 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.80 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.81 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.82 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.25. network list
ネットワークをリスト表示します。
使用方法
openstack network list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--external | --internal] [--long] [--name <name>] [--enable | --disable] [--project <project>] [--project-domain <project-domain>] [--share | --no-share] [--status <status>] [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] [--provider-segment <provider-segment>] [--agent <agent-id>] [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]] [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]]
表52.83 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--external | 外部ネットワークをリスト表示します。 |
--internal | 内部ネットワークをリスト表示します。 |
--long | 出力の追加フィールドをリスト表示します。 |
--name <name> | 名前に従ってネットワークをリスト表示します。 |
--enable | 有効なネットワークのリストを表示します。 |
--disable | 無効なネットワークのリストを表示します。 |
--project <project> | プロジェクトに従ってネットワークをリスト表示します (名前または ID)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--share | プロジェクト間で共有されるネットワークをリスト表示します。 |
--no-share | プロジェクト間で共有されていないネットワークのリストを表示します。 |
--status <status> | ステータス (active、BUILD、DOWN、ERROR) に従ってネットワークをリスト表示します。 |
--provider-network-type <provider-network-type> | 物理メカニズムに従ってネットワークをリスト表示します。サポートされているオプションは flat、geneve、gre、local、vlan、vxlan です。 |
--provider-physical-network <provider-physical-network> | 物理ネットワークの名前に従ってネットワークをリスト表示します。 |
--provider-segment <provider-segment> | vlan ネットワークの vlan id か、GENEVE/GRE/VXLAN ネットワークの Tunnel ID に従ってネットワークをリスト表示します。 |
--agent <agent-id> | エージェントがホストするネットワークのリストを表示します (id のみ)。 |
--tags <tag>[,<tag>,…] | 指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたネットワークをリスト表示します。 |
--any-tags <tag>[,<tag>,…] | 指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたネットワークをリスト表示します。 |
--not-tags <tag>[,<tag>,…] | 指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたネットワークを除外します。 |
--not-any-tags <tag>[,<tag>,…] | 指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたネットワークを除外します。 |
表52.84 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.85 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.86 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.87 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.26. network log create
新規ネットワークログを作成指定します。
使用方法
openstack network log create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--enable | --disable] [--project <project>] [--project-domain <project-domain>] [--event {ALL,ACCEPT,DROP}] --resource-type <resource-type> [--resource <resource>] [--target <target>] <name>
表52.88 位置引数
値 | 概要 |
---|---|
<name> | ネットワークログの名前 |
表52.89 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | ネットワークログの説明 |
--enable | このログを有効にします (デフォルトは無効)。 |
--disable | このログを無効にします。 |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--event {ALL,ACCEPT,DROP} | ログと共に保存するイベント |
--resource-type <resource-type> | ネットワークログのタイプ。サポートされる種別は、$ openstack network loggable resources list で確認することができます。 |
--resource <resource> | ロギングに使用されるリソース (セキュリティーグループまたはファイアウォールグループ) の名前または ID--target オプションを使用して、ロギングターゲットの組み合わせを制御できます。 |
--target <target> | ロギング用のポート (名前または ID)。ロギングターゲットの組み合わせは、--resource オプションで制御できます。 |
表52.90 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.91 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.92 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.93 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.27. network log delete
ネットワークログを削除します。
使用方法
openstack network log delete [-h] <network-log> [<network-log> ...]
表52.94 位置引数
値 | 概要 |
---|---|
<network-log> | 削除するネットワークログ (名前または ID) |
表52.95 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.28. network log list
ネットワークログをリスト表示します。
使用方法
openstack network log list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
表52.96 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
表52.97 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.98 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.99 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.100 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.29. network log set
ネットワークログの属性を設定します。
使用方法
openstack network log set [-h] [--description <description>] [--enable | --disable] [--name <name>] <network-log>
表52.101 位置引数
値 | 概要 |
---|---|
<network-log> | 設定するネットワークログ (名前または ID) |
表52.102 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | ネットワークログの説明 |
--enable | このログを有効にします (デフォルトは無効)。 |
--disable | このログを無効にします。 |
--name <name> | ネットワークログの名前 |
52.30. network log show
ネットワークログの詳細を表示します。
使用方法
openstack network log show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <network-log>
表52.103 位置引数
値 | 概要 |
---|---|
<network-log> | 表示するネットワークログ (名前または ID) |
表52.104 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.105 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.106 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.107 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.108 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.31. network loggable resources list
サポートされるログ可能なリソースをリスト表示します。
使用方法
openstack network loggable resources list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
表52.109 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
表52.110 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.111 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.112 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.113 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.32. network meter create
ネットワークメーターを作成します。
使用方法
openstack network meter create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--project <project>] [--project-domain <project-domain>] [--share | --no-share] <name>
表52.114 位置引数
値 | 概要 |
---|---|
<name> | メーターの名前 |
表52.115 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | メーターの説明を作成します。 |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--share | プロジェクト間でメーターを共有します。 |
--no-share | プロジェクト間でメーターを共有しません。 |
表52.116 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.117 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.118 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.119 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.33. network meter delete
ネットワークメーターを削除します。
使用方法
openstack network meter delete [-h] <meter> [<meter> ...]
表52.120 位置引数
値 | 概要 |
---|---|
<meter> | 削除するメーター (名前または ID) |
表52.121 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.34. network meter list
ネットワークメーターをリスト表示します。
使用方法
openstack network meter list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表52.122 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.123 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.124 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.125 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.126 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.35. network meter rule create
新しいメータールールを作成します。
使用方法
openstack network meter rule create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--project <project>] [--project-domain <project-domain>] [--exclude | --include] [--ingress | --egress] --remote-ip-prefix <remote-ip-prefix> <meter>
表52.127 位置引数
値 | 概要 |
---|---|
<meter> | このメータリングルールに関連付けるラベル (名前または ID) |
表52.128 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--exclude | トラフィック数からリモート ip 接頭辞を除外します。 |
--include | トラフィック数にリモート ip 接頭辞を含めます (デフォルト)。 |
--ingress | 受信ネットワークトラフィックにルールを適用します (デフォルト)。 |
--egress | 発信ネットワークトラフィックにルールを適用します。 |
--remote-ip-prefix <remote-ip-prefix> | このルールに関連付けるリモート IP 接頭辞 |
表52.129 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.130 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.131 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.132 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.36. network meter rule delete
メータールールを削除します。
使用方法
openstack network meter rule delete [-h] <meter-rule-id> [<meter-rule-id> ...]
表52.133 位置引数
値 | 概要 |
---|---|
<meter-rule-id> | 削除するメータールール (id のみ) |
表52.134 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.37. network meter rule list
メータールールをリスト表示します。
使用方法
openstack network meter rule list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表52.135 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.136 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.137 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.138 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.139 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.38. network meter rule show
メータールールの詳細を表示削除します。
使用方法
openstack network meter rule show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <meter-rule-id>
表52.140 位置引数
値 | 概要 |
---|---|
<meter-rule-id> | メータールール (id のみ) |
表52.141 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.142 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.143 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.144 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.145 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.39. network meter show
ネットワークメーターを表示します。
使用方法
openstack network meter show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <meter>
表52.146 位置引数
値 | 概要 |
---|---|
<meter> | 表示するメーター (名前または ID) |
表52.147 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.148 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.149 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.150 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.151 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.40. network onboard subnets
サブネットプールにネットワークサブネットをオンボードします。
使用方法
openstack network onboard subnets [-h] <network> <subnetpool>
表52.152 位置引数
値 | 概要 |
---|---|
<network> | このネットワークに関連付けられた全サブネットをオンボードします。 |
<subnetpool> | サブネットをオンボーディングするターゲットサブネットプール |
表52.153 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.41. network qos policy create
QoS ポリシーを作成します。
使用方法
openstack network qos policy create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--share | --no-share] [--project <project>] [--project-domain <project-domain>] [--default | --no-default] <name>
表52.154 位置引数
値 | 概要 |
---|---|
<name> | 作成する qos ポリシーの名前 |
表52.155 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | qos ポリシーの説明 |
--share | 他のプロジェクトから qos ポリシーにアクセスできるようにします。 |
--no-share | 他のプロジェクトから qos ポリシーにアクセスできないようにします (デフォルト)。 |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--default | これをデフォルトのネットワーク qos ポリシーとして設定します。 |
--no-default | これをデフォルト以外のネットワーク qos ポリシーとして設定します。 |
表52.156 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.157 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.158 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.159 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.42. network qos policy delete
Qos ポリシーを削除します。
使用方法
openstack network qos policy delete [-h] <qos-policy> [<qos-policy> ...]
表52.160 位置引数
値 | 概要 |
---|---|
<qos-policy> | 削除する QoS ポリシー (名前または ID) |
表52.161 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.43. network qos policy list
QoS ポリシーをリスト表示します。
使用方法
openstack network qos policy list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--project <project>] [--project-domain <project-domain>] [--share | --no-share]
表52.162 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | プロジェクトに従って qos ポリシーをリスト表示します (名前または ID)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--share | プロジェクト間で共有される QoS ポリシーをリスト表示します。 |
--no-share | プロジェクト間で共有されない qos ポリシーをリスト表示します。 |
表52.163 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.164 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.165 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.166 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.44. network qos policy set
QoS ポリシー属性を設定します。
使用方法
openstack network qos policy set [-h] [--name <name>] [--description <description>] [--share | --no-share] [--default | --no-default] <qos-policy>
表52.167 位置引数
値 | 概要 |
---|---|
<qos-policy> | 変更する QoS ポリシー (名前または ID) |
表52.168 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | qos ポリシー名を設定します。 |
--description <description> | qos ポリシーの説明 |
--share | 他のプロジェクトから qos ポリシーにアクセスできるようにします。 |
--no-share | 他のプロジェクトから qos ポリシーにアクセスできないようにします。 |
--default | これをデフォルトのネットワーク qos ポリシーとして設定します。 |
--no-default | これをデフォルト以外のネットワーク qos ポリシーとして設定します。 |
52.45. network qos policy show
QoS ポリシーの詳細を表示します。
使用方法
openstack network qos policy show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <qos-policy>
表52.169 位置引数
値 | 概要 |
---|---|
<qos-policy> | 表示する QoS ポリシー (名前または ID) |
表52.170 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.171 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.172 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.173 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.174 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.46. network qos rule create
新規 Network QoS ルールを作成します。
使用方法
openstack network qos rule create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --type <type> [--max-kbps <max-kbps>] [--max-burst-kbits <max-burst-kbits>] [--dscp-mark <dscp-mark>] [--min-kbps <min-kbps>] [--ingress | --egress] <qos-policy>
表52.175 位置引数
値 | 概要 |
---|---|
<qos-policy> | ルールが含まれる QoS ポリシー (名前または id) |
表52.176 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--type <type> | QoS ルールタイプ (minimum-bandwidth、dscp-marking、bandwidth-limit) |
--max-kbps <max-kbps> | 最大帯域幅 (kbps) |
--max-burst-kbits <max-burst-kbits> | キロビット単位の最大バースト。0 または指定しない場合は帯域幅の制限の 80% で、通常の TCP トラフィックで機能します。詳細は、QoS ユーザーワークフローを確認します。 |
--dscp-mark <dscp-mark> | DSCP mark: 値 は 0、8 - 56 の偶数を指定できます (42、44、50、52、および 54 を除く)。 |
--min-kbps <min-kbps> | 確保される最小帯域幅 (kbps 単位) |
--ingress | プロジェクト視点からの受信トラフィックの方向 |
--egress | プロジェクト視点からの送信トラフィックの方向 |
表52.177 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.178 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.179 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.180 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.47. network qos rule delete
ネットワーク QoS ルールを削除します。
使用方法
openstack network qos rule delete [-h] <qos-policy> <rule-id>
表52.181 位置引数
値 | 概要 |
---|---|
<qos-policy> | ルールが含まれる QoS ポリシー (名前または id) |
<rule-id> | 削除するネットワーク qos ルール (id) |
表52.182 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.48. network qos rule list
ネットワーク QoS ルールをリスト表示します。
使用方法
openstack network qos rule list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <qos-policy>
表52.183 位置引数
値 | 概要 |
---|---|
<qos-policy> | ルールが含まれる QoS ポリシー (名前または id) |
表52.184 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.185 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.186 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.187 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.188 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.49. network qos rule set
ネットワーク QoS ルール属性を設定します。
使用方法
openstack network qos rule set [-h] [--max-kbps <max-kbps>] [--max-burst-kbits <max-burst-kbits>] [--dscp-mark <dscp-mark>] [--min-kbps <min-kbps>] [--ingress | --egress] <qos-policy> <rule-id>
表52.189 位置引数
値 | 概要 |
---|---|
<qos-policy> | ルールが含まれる QoS ポリシー (名前または id) |
<rule-id> | 削除するネットワーク qos ルール (id) |
表52.190 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--max-kbps <max-kbps> | 最大帯域幅 (kbps) |
--max-burst-kbits <max-burst-kbits> | キロビット単位の最大バースト。0 または指定しない場合は帯域幅の制限の 80% で、通常の TCP トラフィックで機能します。詳細は、QoS ユーザーワークフローを確認します。 |
--dscp-mark <dscp-mark> | DSCP mark: 値 は 0、8 - 56 の偶数を指定できます (42、44、50、52、および 54 を除く)。 |
--min-kbps <min-kbps> | 確保される最小帯域幅 (kbps 単位) |
--ingress | プロジェクト視点からの受信トラフィックの方向 |
--egress | プロジェクト視点からの送信トラフィックの方向 |
52.50. network qos rule show
ネットワーク QoS ルールの詳細を表示します。
使用方法
openstack network qos rule show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <qos-policy> <rule-id>
表52.191 位置引数
値 | 概要 |
---|---|
<qos-policy> | ルールが含まれる QoS ポリシー (名前または id) |
<rule-id> | 削除するネットワーク qos ルール (id) |
表52.192 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.193 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.194 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.195 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.196 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.51. network qos rule type list
QoS ルール種別のリストを表示します。
使用方法
openstack network qos rule type list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表52.197 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.198 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.199 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.200 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.201 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.52. network qos rule type show
サポート対象の QoS ルール種別の詳細を表示します。
使用方法
openstack network qos rule type show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <qos-rule-type-name>
表52.202 位置引数
値 | 概要 |
---|---|
<qos-rule-type-name> | qos ルール種別の名前 |
表52.203 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.204 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.205 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.206 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.207 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.53. network rbac create
ネットワーク RBAC ポリシーを作成します。
使用方法
openstack network rbac create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --type <type> --action <action> (--target-project <target-project> | --target-all-projects) [--target-project-domain <target-project-domain>] [--project <project>] [--project-domain <project-domain>] <rbac-object>
表52.208 位置引数
値 | 概要 |
---|---|
<rbac-object> | この rbac ポリシーが影響を及ぼすオブジェクト (名前または ID) |
表52.209 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--type <type> | rbac ポリシーが影響を及ぼすオブジェクトの種別 (security_group、qos_policy または network) |
--action <action> | rbac ポリシーの動作 ("access_as_external" または "access_as_shared") |
--target-project <target-project> | rbac ポリシーを適用するプロジェクト (名前または ID) |
--target-all-projects | すべてのプロジェクトの rbac ポリシーの作成を許可します。 |
--target-project-domain <target-project-domain> | ターゲットプロジェクトが属するドメイン (名前または id)プロジェクト名の競合が発生した場合に、使用できます。 |
--project <project> | 所有者プロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
表52.210 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.211 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.212 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.213 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.54. network rbac delete
ネットワーク RBAC ポリシーを削除します。
使用方法
openstack network rbac delete [-h] <rbac-policy> [<rbac-policy> ...]
表52.214 位置引数
値 | 概要 |
---|---|
<rbac-policy> | 削除する RBAC ポリシー (id のみ) |
表52.215 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.55. network rbac list
ネットワーク RBAC ポリシーをリスト表示します。
使用方法
openstack network rbac list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--type <type>] [--action <action>] [--long]
表52.216 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--type <type> | 指定されたオブジェクト種別 ("security_group"、"qos_policy"、または "network") に従って、ネットワーク rbac ポリシーをリスト表示します。 |
--action <action> | 指定されたアクション ("access_as_external" または "access_as_shared") に従って、ネットワーク rbac ポリシーをリスト表示します。 |
--long | 出力の追加フィールドをリスト表示します。 |
表52.217 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.218 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.219 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.220 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.56. network rbac set
ネットワーク RBAC ポリシー属性を設定します。
使用方法
openstack network rbac set [-h] [--target-project <target-project>] [--target-project-domain <target-project-domain>] <rbac-policy>
表52.221 位置引数
値 | 概要 |
---|---|
<rbac-policy> | 変更する RBAC ポリシー (id のみ) |
表52.222 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--target-project <target-project> | rbac ポリシーを適用するプロジェクト (名前または ID) |
--target-project-domain <target-project-domain> | ターゲットプロジェクトが属するドメイン (名前または id)プロジェクト名の競合が発生した場合に、使用できます。 |
52.57. network rbac show
ネットワーク RBAC ポリシーの詳細を表示します。
使用方法
openstack network rbac show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <rbac-policy>
表52.223 位置引数
値 | 概要 |
---|---|
<rbac-policy> | RBAC ポリシー (id のみ) |
表52.224 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.225 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.226 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.227 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.228 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.58. network segment create
新規ネットワークセグメントを作成します。
使用方法
openstack network segment create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--physical-network <physical-network>] [--segment <segment>] --network <network> --network-type <network-type> <name>
表52.229 位置引数
値 | 概要 |
---|---|
<name> | 新しいネットワークセグメント名 |
表52.230 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | ネットワークセグメントの説明 |
--physical-network <physical-network> | このネットワークセグメントの物理ネットワーク名 |
--segment <segment> | このネットワークセグメントのセグメント識別子。ネットワーク種別、vlan ネットワーク種別の VLAN ID、ならびに geneve、gre、および vxlan ネットワーク種別のトンネル ID に基づきます。 |
--network <network> | このネットワークセグメントが属するネットワーク (名前または id) |
--network-type <network-type> | このネットワークセグメントのネットワーク種別 (flat、geneve、gre、local、vlan、または vxlan) |
表52.231 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.232 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.233 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.234 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.59. network segment delete
ネットワークセグメントを削除します。
使用方法
openstack network segment delete [-h] <network-segment> [<network-segment> ...]
表52.235 位置引数
値 | 概要 |
---|---|
<network-segment> | 削除するネットワークセグメント (名前または ID) |
表52.236 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.60. network segment list
ネットワークセグメントのリストを表示します。
使用方法
openstack network segment list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--network <network>]
表52.237 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
--network <network> | このネットワークに属するネットワークセグメントをリスト表示します (名前または ID)。 |
表52.238 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.239 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.240 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.241 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.61. network segment range create
新規ネットワークセグメントの範囲を作成します。
使用方法
openstack network segment range create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--private | --shared] [--project <project>] [--project-domain <project-domain>] --network-type <network-type> [--physical-network <physical-network-name>] --minimum <minimum-segmentation-id> --maximum <maximum-segmentation-id> <name>
表52.242 位置引数
値 | 概要 |
---|---|
<name> | 新規ネットワークセグメント範囲の名前 |
表52.243 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--private | ネットワークセグメント範囲は特定のプロジェクトに割り当てられます。 |
--shared | ネットワークセグメント範囲は他のプロジェクトと共有されます。 |
--project <project> | ネットワークセグメント範囲の所有者 (名前または ID)。セグメント範囲が共有される場合は任意です。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--network-type <network-type> | このネットワークセグメント範囲のネットワーク種別 (geneve、gre、vlan、または vxlan) |
--physical-network <physical-network-name> | このネットワークセグメント範囲の物理ネットワーク名 |
--minimum <minimum-segmentation-id> | このネットワークセグメント範囲の最小セグメント識別子。ネットワーク種別、vlan ネットワーク種別の VLAN ID、ならびに geneve、gre、および vxlan ネットワーク種別のトンネル ID に基づきます。 |
--maximum <maximum-segmentation-id> | このネットワークセグメント範囲の最大セグメント識別子。ネットワーク種別、vlan ネットワーク種別の VLAN ID、ならびに geneve、gre、および vxlan ネットワーク種別のトンネル ID に基づきます。 |
表52.244 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.245 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.246 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.247 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.62. network segment range delete
ネットワークセグメント範囲を削除します。
使用方法
openstack network segment range delete [-h] <network-segment-range> [<network-segment-range> ...]
表52.248 位置引数
値 | 概要 |
---|---|
<network-segment-range> | 削除するネットワークセグメント範囲 (名前または ID) |
表52.249 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.63. network segment range list
ネットワークセグメント範囲をリスト表示します。
使用方法
openstack network segment range list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--used | --unused] [--available | --unavailable]
表52.250 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
--used | 使用中のセグメントを持つネットワークセグメント範囲をリスト表示します。 |
--unused | セグメントが使用されていないネットワークセグメント範囲をリスト表示します。 |
--available | 利用可能なセグメントがあるネットワークセグメント範囲をリスト表示します。 |
--unavailable | 利用可能なセグメントがないネットワークセグメント範囲をリスト表示します。 |
表52.251 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.252 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.253 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.254 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.64. network segment range set
ネットワークセグメント範囲の属性を設定します。
使用方法
openstack network segment range set [-h] [--name <name>] [--minimum <minimum-segmentation-id>] [--maximum <maximum-segmentation-id>] <network-segment-range>
表52.255 位置引数
値 | 概要 |
---|---|
<network-segment-range> | 変更するネットワークセグメント範囲 (名前または ID) |
表52.256 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | ネットワークセグメント名を設定します。 |
--minimum <minimum-segmentation-id> | ネットワークセグメント範囲の最小セグメント識別子を設定します。 |
--maximum <maximum-segmentation-id> | ネットワークセグメント範囲の最大セグメント識別子を設定します。 |
52.65. network segment range show
ネットワークセグメント範囲の詳細を表示します。
使用方法
openstack network segment range show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <network-segment-range>
表52.257 位置引数
値 | 概要 |
---|---|
<network-segment-range> | 表示するネットワークセグメント範囲 (名前または ID) |
表52.258 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.259 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.260 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.261 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.262 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.66. network segment set
ネットワークセグメントの属性を設定します。
使用方法
openstack network segment set [-h] [--description <description>] [--name <name>] <network-segment>
表52.263 位置引数
値 | 概要 |
---|---|
<network-segment> | 変更するネットワークセグメント (名前または ID) |
表52.264 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | ネットワークセグメントの説明を設定します。 |
--name <name> | ネットワークセグメント名を設定します。 |
52.67. network segment show
ネットワークセグメントの詳細を表示します。
使用方法
openstack network segment show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <network-segment>
表52.265 位置引数
値 | 概要 |
---|---|
<network-segment> | 表示するネットワークセグメント (名前または ID) |
表52.266 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.267 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.268 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.269 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.270 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.68. network service provider list
サービスプロバイダーをリスト表示します。
使用方法
openstack network service provider list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表52.271 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.272 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.273 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.274 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.275 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.69. network set
ネットワークの属性を設定します。
使用方法
openstack network set [-h] [--name <name>] [--enable | --disable] [--share | --no-share] [--description <description] [--mtu <mtu] [--enable-port-security | --disable-port-security] [--external | --internal] [--default | --no-default] [--qos-policy <qos-policy> | --no-qos-policy] [--tag <tag>] [--no-tag] [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] [--provider-segment <provider-segment>] [--dns-domain <dns-domain>] <network>
表52.276 位置引数
値 | 概要 |
---|---|
<network> | 変更するネットワーク (名前または ID) |
表52.277 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | ネットワーク名を設定します。 |
--enable | ネットワークを有効有効にします。 |
--disable | ネットワークを無効にします。 |
--share | プロジェクト間でネットワークを共有します。 |
--no-share | プロジェクト間でネットワークを共有しません。 |
--description <description | ネットワークの説明を設定します。 |
--mtu <mtu | ネットワークの mtu を設定します。 |
--enable-port-security | このネットワークで作成されたポートで、デフォルトでポートセキュリティーを有効にします。 |
--disable-port-security | このネットワークで作成されたポートで、デフォルトでポートセキュリティーを無効にします。 |
--external | このネットワークを外部ネットワークとして設定します (external-net 拡張機能が必要) |
--internal | このネットワークを内部ネットワークとして設定します。 |
--default | ネットワークをデフォルトの外部ネットワークとして設定します。 |
--no-default | ネットワークをデフォルトの外部ネットワークとして使用しません。 |
--qos-policy <qos-policy> | このネットワークにアタッチする QoS ポリシー (名前または ID) |
--no-qos-policy | このネットワークに割り当てられた qos ポリシーを削除します。 |
--tag <tag> | ネットワークに追加するタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--no-tag | ネットワークに関連付けられたタグをクリアします。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。 |
--provider-network-type <provider-network-type> | 仮想ネットワークが実装される物理メカニズム。例:flat、geneve、gre、local、vlan、vxlan |
--provider-physical-network <provider-physical-network> | 仮想ネットワークが実装される物理ネットワークの名前 |
--provider-segment <provider-segment> | vlan ネットワークの VLAN id、または GENEVE/GRE/VXLAN ネットワークのトンネル ID |
--dns-domain <dns-domain> | このネットワークに dns ドメインを設定します (dns 統合拡張が必要です)。 |
52.70. network show
ネットワーク情報を表示します。
使用方法
openstack network show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <network>
表52.278 位置引数
値 | 概要 |
---|---|
<network> | 表示するネットワーク (名前または ID) |
表52.279 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.280 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.281 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.282 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.283 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.71. network subport list
指定されたネットワークトランクのすべてのサブポートをリスト表示します。
使用方法
openstack network subport list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] --trunk <trunk>
表52.284 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--trunk <trunk> | このトランクに属するサブポートをリスト表示します (名前または id)。 |
表52.285 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.286 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.287 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.288 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.72. network trunk create
特定プロジェクトのネットワークトランクを作成します。
使用方法
openstack network trunk create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] --parent-port <parent-port> [--subport <port=,segmentation-type=,segmentation-id=>] [--enable | --disable] [--project <project>] [--project-domain <project-domain>] <name>
表52.289 位置引数
値 | 概要 |
---|---|
<name> | 作成するトランクの名前 |
表52.290 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | トランクの説明 |
--parent-port <parent-port> | このトランクに属する親ポート (名前または ID) |
--subport <port=,segmentation-type=,segmentation-id⇒ | 追加するサブポート。サブポートの形式は port=<name or ID>,segmentation-type=,segmentation-ID= で、(--subport) オプションは繰り返し使用できます。 |
--enable | トランクを有効にします (デフォルト)。 |
--disable | トランクを無効にします。 |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
表52.291 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.292 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.293 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.294 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.73. network trunk delete
指定されたネットワークトランクを削除します。
使用方法
openstack network trunk delete [-h] <trunk> [<trunk> ...]
表52.295 位置引数
値 | 概要 |
---|---|
<trunk> | 削除するトランク (名前または ID) |
表52.296 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
52.74. network trunk list
すべてのネットワークトランクをリスト表示します。
使用方法
openstack network trunk list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
表52.297 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
表52.298 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表52.299 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表52.300 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.301 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.75. network trunk set
ネットワークトランクの属性を設定します。
使用方法
openstack network trunk set [-h] [--name <name>] [--description <description>] [--subport <port=,segmentation-type=,segmentation-id=>] [--enable | --disable] <trunk>
表52.302 位置引数
値 | 概要 |
---|---|
<trunk> | 変更するトランク (名前または ID) |
表52.303 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | トランク名を設定します。 |
--description <description> | トランクの説明 |
--subport <port=,segmentation-type=,segmentation-id⇒ | 追加するサブポート。サブポートの形式は port=<name or ID>,segmentation-type=,segmentation-ID= で、(--subport) オプションは繰り返し使用できます。 |
--enable | トランクを有効にします。 |
--disable | トランクを無効にします。 |
52.76. network trunk show
指定されたネットワークトランクに関する情報を表示します。
使用方法
openstack network trunk show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <trunk>
表52.304 位置引数
値 | 概要 |
---|---|
<trunk> | 表示するトランク (名前または ID) |
表52.305 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表52.306 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表52.307 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表52.308 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表52.309 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
52.77. network trunk unset
指定されたネットワークトランクからサブポートの設定を解除します。
使用方法
openstack network trunk unset [-h] --subport <subport> <trunk>
表52.310 位置引数
値 | 概要 |
---|---|
<trunk> | このトランクからサブポートの設定を解除します (名前または id)。 |
表52.311 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--subport <subport> | 削除するサブポート (ポートの名前または ID)。(--subport) はオプションは繰り返し使用できます。 |
52.78. network unset
ネットワーク属性の設定を解除します。
使用方法
openstack network unset [-h] [--tag <tag> | --all-tag] <network>
表52.312 位置引数
値 | 概要 |
---|---|
<network> | 変更するネットワーク (名前または ID) |
表52.313 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--tag <tag> | ネットワークから削除するタグ (複数のタグを削除する場合はオプションを繰り返し使用します) |
--all-tag | ネットワークに関連付けられたすべてのタグをクリアします |
第53章 object
本章では、object
コマンドに含まれるコマンドについて説明します。
53.1. object create
オブジェクトをコンテナーにアップロードします。
使用方法
openstack object create [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name <name>] <container> <filename> [<filename> ...]
表53.1 位置引数
値 | 概要 |
---|---|
<container> | 新規オブジェクトのコンテナー |
<filename> | アップロードするローカルファイル名 |
表53.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | ファイルをアップロードして名前を変更します。単一オブジェクトのアップロード時にのみ使用できます。 |
表53.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表53.4 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表53.5 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表53.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
53.2. object delete
コンテナーからオブジェクトを削除します。
使用方法
openstack object delete [-h] <container> <object> [<object> ...]
表53.7 位置引数
値 | 概要 |
---|---|
<container> | <container> からオブジェクトを削除します。 |
<object> | 削除するオブジェクト |
表53.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
53.3. object list
オブジェクトをリスト表示します。
使用方法
openstack object list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--prefix <prefix>] [--delimiter <delimiter>] [--marker <marker>] [--end-marker <end-marker>] [--limit <num-objects>] [--long] [--all] <container>
表53.9 位置引数
値 | 概要 |
---|---|
<container> | リスト表示するコンテナー |
表53.10 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--prefix <prefix> | <prefix> を使用してリストをフィルタリングします |
--delimiter <delimiter> | <delimiter> でアイテムをロールアップします。 |
--marker <marker> | ページングのアンカー |
--end-marker <end-marker> | ページングの終了アンカー |
--limit <num-objects> | 返されるオブジェクト数を制限します。 |
--long | 出力の追加フィールドをリスト表示します。 |
--all | コンテナーのすべてのオブジェクトをリスト表示します (デフォルトは 10000)。 |
表53.11 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表53.12 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表53.13 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表53.14 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
53.4. object save
ローカルにオブジェクトを保存します。
使用方法
openstack object save [-h] [--file <filename>] <container> <object>
表53.15 位置引数
値 | 概要 |
---|---|
<container> | <container> から <object> をダウンロードします。 |
<object> | 保存するオブジェクト |
表53.16 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--file <filename> | 保存先ファイル名 (デフォルトはオブジェクト名)。ファイル名に-を使用すると、ファイルを標準出力に出力します。 |
53.5. object set
オブジェクトの属性を設定します。
使用方法
openstack object set [-h] --property <key=value> <container> <object>
表53.17 位置引数
値 | 概要 |
---|---|
<container> | <container> からの <object> を変更します。 |
<object> | 変更するオブジェクト |
表53.18 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--property <key=value> | このオブジェクトに属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します)。 |
53.6. object show
オブジェクトの詳細を表示します。
使用方法
openstack object show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <container> <object>
表53.19 位置引数
値 | 概要 |
---|---|
<container> | <container> からの <object> を表示します。 |
<object> | 表示するオブジェクト |
表53.20 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表53.21 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表53.22 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表53.23 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表53.24 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
53.7. object store account set
アカウントの属性を設定します。
使用方法
openstack object store account set [-h] --property <key=value>
表53.25 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--property <key=value> | このアカウントに属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します)。 |
53.8. object store account show
アカウントの詳細を表示します。
使用方法
openstack object store account show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
表53.26 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表53.27 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表53.28 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表53.29 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表53.30 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
53.9. object store account unset
アカウント属性の設定を解除します。
使用方法
openstack object store account unset [-h] --property <key>
表53.31 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--property <key> | アカウントから削除する属性 (複数の属性を削除する場合はオプションを繰り返し使用します) |
53.10. object unset
オブジェクト属性の設定を解除します。
使用方法
openstack object unset [-h] --property <key> <container> <object>
表53.32 位置引数
値 | 概要 |
---|---|
<container> | <container> からの <object> を変更します。 |
<object> | 変更するオブジェクト |
表53.33 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--property <key> | オブジェクトから削除する属性 (複数の属性を削除する場合はオプションを繰り返し使用します) |
第54章 orchestration
本章では、orchestration
コマンドに含まれるコマンドについて説明します。
54.1. orchestration build info
ビルド情報を取得します。
使用方法
openstack orchestration build info [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
表54.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表54.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表54.3 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表54.4 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表54.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
54.2. orchestration resource type list
リソース種別をリスト表示します。
使用方法
openstack orchestration resource type list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--filter <key=value>] [--long]
表54.6 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--filter <key=value> | 返されたリソース種別に適用するフィルターパラメーターこれは複数回指定できます。name、version、または support_status のいずれかになります。 |
--long | 対応する説明と共にリソース種別を表示します。 |
表54.7 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表54.8 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表54.9 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表54.10 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
54.3. orchestration resource type show
リソース種別の詳細を表示し、オプションとしてテンプレートを生成します。
使用方法
openstack orchestration resource type show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--template-type <template-type>] [--long] <resource-type>
表54.11 位置引数
値 | 概要 |
---|---|
<resource-type> | 詳細を表示するリソース種別 |
表54.12 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--template-type <template-type> | オプションとして生成するテンプレートの種別 (hot または cfn) |
--long | 対応する説明と共にリソース種別を表示します。 |
表54.13 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは yaml です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表54.14 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表54.15 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表54.16 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
54.4. orchestration service list
Heat エンジンをリスト表示します。
使用方法
openstack orchestration service list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表54.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表54.18 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表54.19 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表54.20 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表54.21 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
54.5. orchestration template function list
利用可能な関数をリスト表示します。
使用方法
openstack orchestration template function list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--with_conditions] <template-version>
表54.22 位置引数
値 | 概要 |
---|---|
<template-version> | 関数を取得するテンプレートのバージョン |
表54.23 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--with_conditions | テンプレートの条件関数を表示します。 |
表54.24 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表54.25 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表54.26 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表54.27 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
54.6. orchestration template validate
テンプレートを検証します。
使用方法
openstack orchestration template validate [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [-e <environment>] [--show-nested] [--parameter <key=value>] [--ignore-errors <error1,error2,...>] -t <template>
表54.28 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-e <environment>, --environment <environment> | 環境へのパス。複数回指定できます。 |
--show-nested | ネストされたテンプレートからのパラメーターも解決します。 |
--parameter <key=value> | スタックの作成に使用するパラメーター値。これは複数回指定できます。 |
--ignore-errors <error1,error2,…> | 無視する heat エラーのリスト |
-t <template>, --template <template> | テンプレートへのパス |
表54.29 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは yaml です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表54.30 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表54.31 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表54.32 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
54.7. orchestration template version list
利用可能なテンプレートバージョンをリスト表示します。
使用方法
openstack orchestration template version list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表54.33 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表54.34 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表54.35 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表54.36 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表54.37 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第55章 overcloud
本章では、overcloud
コマンドに含まれるコマンドについて説明します。
55.1. overcloud admin authorize
Mistral で必要な ssh キーをデプロイします。
使用方法
openstack overcloud admin authorize [-h] [--stack STACK] [--overcloud-ssh-user OVERCLOUD_SSH_USER] [--overcloud-ssh-key OVERCLOUD_SSH_KEY] [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK] [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT] [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]
表55.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--stack STACK | Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME) |
--overcloud-ssh-user OVERCLOUD_SSH_USER | オーバークラウドノードへの ssh アクセスのためのユーザー |
--overcloud-ssh-key OVERCLOUD_SSH_KEY | オーバークラウドノードへの ssh アクセスに使用する鍵のパス。未定義の場合、キーは自動検出されます。 |
--overcloud-ssh-network OVERCLOUD_SSH_NETWORK | オーバークラウドノードへの ssh アクセスに使用するネットワーク名。 |
--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT | ssh enable プロセスが完了するまでのタイムアウト。 |
--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT | ssh ポートがアクティブになるまで待機するタイムアウト。 |
55.2. overcloud backup
オーバークラウドのバックアップを作成します。
使用方法
openstack overcloud backup [--init [INIT]] [--setup-nfs] [--setup-rear] [--cron] [--inventory INVENTORY] [--storage-ip STORAGE_IP] [--extra-vars EXTRA_VARS]
表55.2 コマンド引数
値 | 概要 |
---|---|
--init [INIT] | rear または nfs を引数として使用し、バックアップの環境を初期化します。パッケージのインストールと設定された ReaR サーバーまたは NFS サーバーを確認します。デフォルトは rear です (例:--init rear)。警告: このフラグは非推奨となり、--setup-rear および --setup-nfs で置き換えられます。 |
--setup-nfs | ansible インベントリーのホストの BackupNode に必要なパッケージおよび設定をインストールするバックアップノードで、nfs サーバーを設定します。 |
--setup-rear | ReaR をインストールおよび設定するオーバークラウド コントローラー ホストに rear をセットアップします。 |
--cron | デフォルトで日曜日の午前 0 時にバックアップを実行する新しい cron ジョブをセットアップしますが、これは tripleo_backup_and_restore_cron extra-var を使用してカスタマイズできます。 |
--inventory INVENTORY | tripleo-ansible- inventory コマンドで生成された tripleo インベントリーファイル。デフォルトは /home/stack/tripleo- inventory.yaml です。 |
--storage-ip STORAGE_IP | storage ip は、ストレージサーバーの ip を指定することのできるオプションのパラメーターで、デフォルトのアンダークラウドを上書きします。警告: このフラグは非推奨となり、--extra-vars が優先されるため、この変数やその他の変数を渡すことができます。 |
--extra-vars EXTRA_VARS | 追加の変数を dict または JSON または YAML ファイルタイプの絶対パスとして設定します。例:--extra-vars {"key": "val", "key2": "val2"} 例: --extra-vars /path/to/my_vars.yaml 例: --extra-vars /path/to/my_vars.json渡すことのできる変数についての詳細は、https://opendev.org/openstack/tripleo-ansible/src/branch/master/tripleo_ansible/roles/backup_and_restore/def aults/main.yml を参照してください。 |
55.3. overcloud cell export
別のセルのインポートとして使用するセル情報をエクスポートします。
使用方法
openstack overcloud cell export [-h] [--control-plane-stack <control plane stack>] [--cell-stack <cell stack>] [--output-file <output file>] [--config-download-dir CONFIG_DOWNLOAD_DIR] [--force-overwrite]
表55.3 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--control-plane-stack <control plane stack> | 情報のエクスポート元となる環境のメイン heat スタックの名前 (デフォルト=Env: OVERCLOUD_STACK_NAME) |
--cell-stack <cell stack>, -e <cell stack> | 情報をエクスポートするコントローラーセル heat スタックの名前。コントロールプレーンスタック → セルコントローラースタック → 複数コンピュートスタックの場合に使用されます。 |
--output-file <output file>, -o <output file> | セルデータのエクスポートの出力ファイルの名前。デフォルトは "<name>.yaml" です。 |
--config-download-dir CONFIG_DOWNLOAD_DIR | config-download エクスポートデータを検索するディレクトリー。デフォルトは $HOME/config-download です。 |
--force-overwrite, -f | 出力ファイルが存在する場合は上書きします。 |
55.4. overcloud config download
オーバークラウドの設定をダウンロードします。
使用方法
openstack overcloud config download [-h] [--name NAME] [--config-dir CONFIG_DIR] [--config-type CONFIG_TYPE] [--no-preserve-config]
表55.4 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name NAME | プランの名前 (オブジェクトストレージコンテナー、ワークフロー環境、およびオーケストレーションスタック名に使用されます)。 |
--config-dir CONFIG_DIR | 設定ファイルがプッシュされるディレクトリー |
--config-type CONFIG_TYPE | デプロイメントから抽出されるオブジェクト設定の種別。デフォルトはすべてのキーです。 |
--no-preserve-config | これが指定されている場合は、--config- ディレクトリーがすでに存在する場合は、削除してから再作成されます。デフォルトでは、既存のディレクトリーの場所を使用し、ファイルを上書きします。--config-dir のファイルは、スタックからではなく、デフォルトでは保持されます。 |
55.5. overcloud container image build
kolla-build を使用してオーバークラウドのコンテナーイメージをビルドします。
使用方法
openstack overcloud container image build [-h] [--config-file <yaml config file>] --kolla-config-file <config file> [--list-images] [--list-dependencies] [--exclude <container-name>] [--use-buildah] [--work-dir <container builds directory>]
表55.5 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--config-file <yaml config file> | ビルドするイメージを指定する yaml 設定ファイル。複数回指定できます。順序は保持され、後のファイルは以前のファイルにある一部のオプションを上書きします。他のオプションは追加されます。指定しない場合、コンテナーのデフォルトセットがビルドされます。 |
--kolla-config-file <config file> | 使用する kolla 設定ファイルへのパス。複数の設定ファイルを指定できますが、後のファイルの値が優先されます。デフォルトでは、tripleo kolla 設定ファイル /usr/share/tripleo-common/container- images/tripleo_kolla_config_overrides.conf が追加されます。 |
--list-images | ビルドするのではなくビルドされるイメージを表示します。 |
--list-dependencies | イメージをビルドするのではなく、イメージビルドの依存関係を表示します。 |
--exclude <container-name> | ビルドをスキップするコンテナーのリストに対して一致するコンテナーの名前。複数回指定できます。 |
--use-buildah | docker の代わりに buildah を使用して、Kolla でイメージをビルドします。 |
--work-dir <container builds directory> | TripleO コンテナービルドディレクトリー。各イメージおよびその依存関係の設定およびログを保存します。 |
55.6. overcloud container image prepare
イメージ、タグ、およびレジストリーを定義するファイルを生成します。
使用方法
openstack overcloud container image prepare [-h] [--template-file <yaml template file>] [--push-destination <location>] [--tag <tag>] [--tag-from-label <image label>] [--namespace <namespace>] [--prefix <prefix>] [--suffix <suffix>] [--set <variable=value>] [--exclude <regex>] [--include <regex>] [--output-images-file <file path>] [--environment-file <file path>] [--environment-directory <HEAT ENVIRONMENT DIRECTORY>] [--output-env-file <file path>] [--roles-file ROLES_FILE] [--modify-role MODIFY_ROLE] [--modify-vars MODIFY_VARS]
表55.6 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--template-file <yaml template file> | イメージ設定ファイルがビルドされる yaml テンプレートファイル。デフォルト: /usr/share/tripleo-common/container- images/tripleo_containers.yaml.j2 |
--push-destination <location> | イメージのプッシュ先となるイメージレジストリーの場所。指定した場合、push_destination がすべてのイメージエントリーごとに設定されます。 |
--tag <tag> | デフォルトのタグの置換を上書きします。--tag-from-label が指定されている場合には、このタグを使用して検出を開始します。デフォルト: 16.2 |
--tag-from-label <image label> | 指定されたラベルの値を使用してタグを検出します。ラベルは、テンプレート形式で組み合わせることができます (例:{version}-{release})。 |
--namespace <namespace> | デフォルトの名前空間の置換を上書きします。デフォルト:registry.redhat.io/rhosp-rhel8 |
--prefix <prefix> | デフォルトの名前接頭辞の置換を上書きします。デフォルト:openstack- |
--suffix <suffix> | デフォルトの名前接尾辞の置換を上書きします。デフォルト: |
--set <variable=value> | --suffix などの専用の引数がない場合でも、テンプレートに変数の値を設定します。 |
--exclude <regex> | 結果のイメージ名のエントリーに対して照合して最終的な出力から除外するパターン。複数回指定できます。 |
--include <regex> | 結果のイメージ名のエントリーに対して照合して最終的な出力に含めるパターン。複数回指定できます。--include と一致するエントリーがない場合には実行されます。--include を使用する場合には、--exclude を無視します。 |
--output-images-file <file path> | stdout に加えて、結果のイメージエントリーを書き込むファイル。既存のファイルは上書きされます。 |
--environment-file <file path>, -e <file path> | コンテナー化されるサービスを指定する環境ファイル。エントリーは、コンテナー化されるサービスで使用されるイメージのみを含むようにフィルターされます。(複数回指定することが可能です。) |
--environment-directory <HEAT ENVIRONMENT DIRECTORY> | update コマンドに自動的に追加される環境ファイルディレクトリー。エントリーは、コンテナー化されるサービスで使用されるイメージのみを含むようにフィルターされます。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。 |
--output-env-file <file path> | すべてのイメージパラメーターを指定する heat 環境ファイルを書き込むファイル。既存のファイルは上書きされます。 |
--roles-file ROLES_FILE, -r ROLES_FILE | ロールファイル。デプロイメントに使用する t-h-t templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは templates ディレクトリーへの相対パスを指定できます。 |
--modify-role MODIFY_ROLE | すべてのイメージアップロードのプルおよびプッシュ間で実行する Ansible ロールの名前。 |
--modify-vars MODIFY_VARS | --modify-role ロールの呼び出し時に使用する変数を含む Ansible 変数ファイル。 |
55.7. overcloud container image tag discover
イメージのバージョンタグを検出します。
使用方法
openstack overcloud container image tag discover [-h] --image <container image> [--tag-from-label <image label>]
表55.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--image <container image> | タグを検出するイメージの完全修飾名 (レジストリーおよび安定したタグを含む)。 |
--tag-from-label <image label> | 指定されたラベルの値を使用してタグを検出します。ラベルは、テンプレート形式で組み合わせることができます (例:{version}-{release})。 |
55.8. overcloud container image upload
オーバークラウドのコンテナーイメージをレジストリーにプッシュします。
使用方法
openstack overcloud container image upload [-h] --config-file <yaml config file> [--cleanup <full, partial, none>]
表55.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--config-file <yaml config file> | イメージビルドを指定する yaml 設定ファイル。複数回指定できます。順序は保持され、後のファイルは以前のファイルにある一部のオプションを上書きします。他のオプションは追加されます。 |
--cleanup <full, partial, none> | アップロード後に残されたローカルイメージの動作をクリーンアップします。デフォルトの full は、すべてのローカルイメージの削除を試行します。partial は、このホストでのデプロイメントに必要なイメージを残します。noneは、クリーンアップを実行しません。 |
55.9. overcloud credentials
overcloudrc ファイルを作成します。
使用方法
openstack overcloud credentials [-h] [--directory [DIRECTORY]] plan
表55.9 位置引数
値 | summary |
---|---|
plan | rc ファイルを作成するプランの名前。 |
表55.10 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--directory [DIRECTORY] | rc ファイルを作成するディレクトリー。デフォルトは現在のディレクトリーです。 |
55.10. overcloud delete
オーバークラウドスタックおよびプランを削除します。
使用方法
openstack overcloud delete [-h] [-y] [-s] [stack]
表55.11 位置引数
値 | 概要 |
---|---|
stack | 削除する heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME) |
表55.12 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-y, --yes | yes/no プロンプトを省略します (yes を想定)。 |
-s, --skip-ipa-cleanup | FreeIPA からオーバークラウドホスト、サービス、および dns レコードを削除するのを省略します。これは、TLS に FreeIPA からの証明書を使用するデプロイメントに特に関係します。デフォルトでは、オーバークラウドホスト、サービス、および DNS レコードは、オーバークラウドを削除する前に FreeIPA から削除されます。このオプションを使用すると、後で FreeIPA を手動でクリーンアップする必要がある場合があります。 |
55.11. overcloud deploy
オーバークラウドをデプロイします。
使用方法
openstack overcloud deploy [--templates [TEMPLATES]] [--stack STACK] [--timeout <TIMEOUT>] [--control-scale CONTROL_SCALE] [--compute-scale COMPUTE_SCALE] [--ceph-storage-scale CEPH_STORAGE_SCALE] [--block-storage-scale BLOCK_STORAGE_SCALE] [--swift-storage-scale SWIFT_STORAGE_SCALE] [--control-flavor CONTROL_FLAVOR] [--compute-flavor COMPUTE_FLAVOR] [--ceph-storage-flavor CEPH_STORAGE_FLAVOR] [--block-storage-flavor BLOCK_STORAGE_FLAVOR] [--swift-storage-flavor SWIFT_STORAGE_FLAVOR] [--libvirt-type {kvm,qemu}] [--ntp-server NTP_SERVER] [--no-proxy NO_PROXY] [--overcloud-ssh-user OVERCLOUD_SSH_USER] [--overcloud-ssh-key OVERCLOUD_SSH_KEY] [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK] [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT] [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT] [--environment-file <HEAT ENVIRONMENT FILE>] [--environment-directory <HEAT ENVIRONMENT DIRECTORY>] [--roles-file ROLES_FILE] [--networks-file NETWORKS_FILE] [--plan-environment-file PLAN_ENVIRONMENT_FILE] [--no-cleanup] [--update-plan-only] [--validation-errors-nonfatal] [--validation-warnings-fatal] [--disable-validations] [--inflight-validations] [--dry-run] [--run-validations] [--skip-postconfig] [--force-postconfig] [--skip-deploy-identifier] [--answers-file ANSWERS_FILE] [--disable-password-generation] [--deployed-server] [--config-download] [--no-config-download] [--config-download-only] [--output-dir OUTPUT_DIR] [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG] [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT] [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER] [-b <baremetal_deployment.yaml>] [--limit LIMIT] [--tags TAGS] [--skip-tags SKIP_TAGS] [--ansible-forks ANSIBLE_FORKS]
表55.13 コマンド引数
値 | 概要 |
---|---|
--templates [TEMPLATES] | デプロイする Heat テンプレートが格納されているディレクトリー。 |
--stack STACK | 作成または更新するスタック名 |
--timeout <TIMEOUT>, -t <TIMEOUT> | デプロイメントのタイムアウト (分単位) |
--control-scale CONTROL_SCALE | 新しいコントロールノード数 (非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。このオプションは U リリースで削除されます)。 |
--compute-scale COMPUTE_SCALE | 新しいコンピュートノード数 (非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。このオプションは U リリースで削除されます)。 |
--ceph-storage-scale CEPH_STORAGE_SCALE | 新しい ceph ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--block-storage-scale BLOCK_STORAGE_SCALE | 新しい cinder ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--swift-storage-scale SWIFT_STORAGE_SCALE | 新しい swift ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--control-flavor CONTROL_FLAVOR | コントロールノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。このオプションは U リリースで削除されます)。 |
--compute-flavor COMPUTE_FLAVOR | コンピュートノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。このオプションは U リリースで削除されます)。 |
--ceph-storage-flavor CEPH_STORAGE_FLAVOR | ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--block-storage-flavor BLOCK_STORAGE_FLAVOR | cinder ストレージノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--swift-storage-flavor SWIFT_STORAGE_FLAVOR | swift ストレージノードに使用する nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--libvirt-type {kvm,qemu} | Libvirt ドメインの種別。 |
--ntp-server NTP_SERVER | オーバークラウドノードの ntp。 |
--no-proxy NO_PROXY | プロキシーされないホストのコンマ区切りリスト。 |
--overcloud-ssh-user OVERCLOUD_SSH_USER | オーバークラウドノードへの ssh アクセスのためのユーザー |
--overcloud-ssh-key OVERCLOUD_SSH_KEY | オーバークラウドノードへの ssh アクセスに使用する鍵のパス。未定義の場合、キーは自動検出されます。 |
--overcloud-ssh-network OVERCLOUD_SSH_NETWORK | オーバークラウドノードへの ssh アクセスに使用するネットワーク名。 |
--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT | ssh enable プロセスが完了するまでのタイムアウト。 |
--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT | ssh ポートがアクティブになるまで待機するタイムアウト。 |
--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE> | heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。) |
--environment-directory <HEAT ENVIRONMENT DIRECTORY> | heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。 |
--roles-file ROLES_FILE, -r ROLES_FILE | ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは --templates に対する相対パスを指定できます。 |
--networks-file NETWORKS_FILE, -n NETWORKS_FILE | ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。 |
--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE | プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。 |
--no-cleanup | 一時ファイルをクリーンアップせず、場所をログとして記録します。 |
--update-plan-only | プランの更新のみを行います。実際のデプロイメントは実行しません。注記: 今後のリリースでは、別のコマンドに移行します。 |
--validation-errors-nonfatal | 検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。 |
--validation-warnings-fatal | 設定の事前チェックで警告がある場合は終了します。 |
--disable-validations | 非推奨。デプロイメント前の検証を完全に無効にします。これらの検証は、組み込まれたデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。これらの検証は、tripleo-validations の外部検証により実行されるようになりました。 |
--inflight-validations | デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。 |
--dry-run | 検証のみを実行しますが、変更は適用されません。 |
--run-validations | tripleo-validations プロジェクトからの外部検証を実行します。 |
--skip-postconfig | オーバークラウドのデプロイ後の設定を省略します。 |
--force-postconfig | オーバークラウドのデプロイ後の設定を強制的に行います。 |
--skip-deploy-identifier | DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメント手順は、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。 |
--answers-file ANSWERS_FILE | 引数とパラメーターが記載された YAML ファイルへのパス。 |
--disable-password-generation | パスワードの生成を無効にします。 |
--deployed-server | 事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、および image サービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。 |
--config-download | config-download メカニズムを使用してデプロイメントを実行します。これは現在のデフォルトであり、この CLI のオプションは今後廃止される可能性があります。 |
--no-config-download, --stack-only | config-download ワークフローを無効にして、スタックと関連する OpenStack リソースのみを作成します。ソフトウェア設定は適用されません。 |
--config-download-only | スタックの作成/更新を無効にして、ソフトウェア設定を適用する config-download ワークフローのみを実行します。 |
--output-dir OUTPUT_DIR | config-download を使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値 (/var/lib/mistral/<execution id>) が使用されます。 |
--override-ansible-cfg OVERRIDE_ANSIBLE_CFG | Ansible 設定ファイルへのパス。ファイルの設定は、デフォルトで config-download が使用する設定を上書きします。 |
--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT | config-download の手順に使用するタイムアウト (分単位)。設定しなければ、スタック操作後の --timeout パラメーターの残り時間にかかわらず、デフォルトがその時間に設定されます。 |
--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER | デプロイメントアクションに使用する Python インタープリターへのパス。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。 |
-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml> | ベアメタルデプロイメントを記述する設定ファイル |
--limit LIMIT | config-download Ansible Playbook の実行を限定する単一ノードまたはコンマ区切りのノードリストを特定する文字列。例:--limit "compute-0,compute-1,compute-5" |
--tags TAGS | config-download ansible-playbook コマンドの実行時に使用するタグのリスト。 |
--skip-tags SKIP_TAGS | config- download ansible-playbook コマンドの実行時に省略するタグのリスト。 |
--ansible-forks ANSIBLE_FORKS | config- download ansible-playbook コマンドに使用する Ansible のフォークの数。 |
55.12. overcloud execute
サーバー上で Heat ソフトウェア設定を実行します。
使用方法
openstack overcloud execute [-h] [-s SERVER_NAME] [-g GROUP] file_in
表55.14 位置引数
値 | summary |
---|---|
file_in | None |
表55.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
-s SERVER_NAME, --server_name SERVER_NAME | 照合する nova server_name またはパーシャル名。 |
-g GROUP、--group GROUP | Heat ソフトウェア設定 "グループ" 種別。デフォルトは script です。 |
55.13. overcloud export ceph
別のスタックのインポートとして使用される Ceph 情報をエクスポートします。別のスタックの入力として使用するために、1 つまたは複数のスタックから Ceph 情報をエクスポートします。CephExternalMultiConfig パラメーターが設定された有効な YAML ファイルを作成します。
使用方法
openstack overcloud export ceph [-h] [--stack <stack>] [--cephx-key-client-name <cephx>] [--output-file <output file>] [--force-overwrite] [--config-download-dir CONFIG_DOWNLOAD_DIR]
表55.16 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--stack <stack> | ceph 情報をエクスポートするオーバークラウドスタックの名前。スタックのコンマ区切りリストが渡されると、すべてのスタックの Ceph 情報が単一ファイルにエクスポートされます (default=Env: OVERCLOUD_STACK_NAME)。 |
--cephx-key-client-name <cephx>, -k <cephx> | エクスポートする cephx クライアントキーの名前 (デフォルト=openstack)。 |
--output-file <output file>, -o <output file> | ceph データのエクスポートの出力ファイルの名前。1 つのスタックが指定されている場合、デフォルトは ceph-export-<STACK>.yaml です。N 個のスタックが指定されている場合は、デフォルトは ceph-export-<N>-stacks.yaml です。 |
--force-overwrite, -f | 出力ファイルが存在する場合は上書きします。 |
--config-download-dir CONFIG_DOWNLOAD_DIR | config-download エクスポートデータを検索するディレクトリー。デフォルトは /var/lib/mistral です。 |
55.14. overcloud export
別のスタックのインポートとして使用するスタック情報をエクスポートします。
使用方法
openstack overcloud export [-h] [--stack <stack>] [--output-file <output file>] [--force-overwrite] [--config-download-dir CONFIG_DOWNLOAD_DIR] [--no-password-excludes]
表55.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--stack <stack> | 情報のエクスポート元となる環境のメイン heat スタックの名前 (デフォルト=Env: OVERCLOUD_STACK_NAME) |
--output-file <output file>, -o <output file> | スタックデータのエクスポートの出力ファイルの名前。デフォルトは "<name>.yaml" です。 |
--force-overwrite, -f | 出力ファイルが存在する場合は上書きします。 |
--config-download-dir CONFIG_DOWNLOAD_DIR | config-download エクスポートデータを検索するディレクトリー。デフォルトは /var/lib/mistral/<stack> です。 |
--no-password-excludes | パスワードのエクスポートから特定のパスワードを除外しません。デフォルトは False で、特に必要のない一部のパスワードは除外されます。 |
55.15. overcloud external-update run
外部のマイナー更新 Ansible Playbook を実行します。この Playbook は、アンダークラウドからタスクを実行する、外部のマイナー更新 Ansible Playbook を実行します。overcloud update prepare コマンドの完了後に、更新 Playbook が利用可能になります。
使用方法
openstack overcloud external-update run [-h] [--static-inventory STATIC_INVENTORY] [--ssh-user SSH_USER] [--tags TAGS] [--skip-tags SKIP_TAGS] [--stack STACK] [-e EXTRA_VARS] [--no-workflow] [-y] [--limit LIMIT] [--ansible-forks ANSIBLE_FORKS]
表55.18 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--static-inventory STATIC_INVENTORY | 使用する既存の Ansible インベントリーへのパス。指定されていない場合は、~/tripleo-ansible- inventory.yaml に生成されます。 |
--ssh-user SSH_USER | 非推奨:tripleo-admin のみを ssh ユーザーとして使用する必要があります。 |
--tags TAGS | ansible-playbook に --tags として渡すタグまたはタグのコンマ区切りリストを指定する文字列。 |
--skip-tags SKIP_TAGS | ansible-playbook に --skip-tags として渡すタグまたはタグのコンマ区切りリストを指定する文字列。 |
--stack STACK | Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME) |
-e EXTRA_VARS, --extra-vars EXTRA_VARS | 追加の変数を key=value または yaml/json として設定します。 |
--no-workflow | TripleO mistral ワークフローを介して Ansible を実行するのではなく、システムコマンド経由で ansible-playbook を直接実行します。 |
-y、--yes | アップグレード操作の前に必要な確認をスキップするには、-y または --yes を使用します。注意して使用してください。 |
--limit LIMIT | config-download Ansible Playbook の実行を限定する単一ノードまたはコンマ区切りのノードリストを特定する文字列。例:--limit "compute-0,compute-1,compute-5" |
--ansible-forks ANSIBLE_FORKS | config- download ansible-playbook コマンドに使用する Ansible のフォークの数。 |
55.16. overcloud external-upgrade run
外部のメジャーアップグレード Ansible Playbook を実行します。この Playbook は、アンダークラウドからタスクを実行する、外部のメジャーアップグレード Ansible Playbook を実行します。overcloud upgrade prepare コマンドの完了後に、アップグレード Playbook が利用可能になります。
使用方法
openstack overcloud external-upgrade run [-h] [--static-inventory STATIC_INVENTORY] [--ssh-user SSH_USER] [--tags TAGS] [--skip-tags SKIP_TAGS] [--stack STACK] [-e EXTRA_VARS] [--no-workflow] [-y] [--limit LIMIT] [--ansible-forks ANSIBLE_FORKS]
表55.19 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--static-inventory STATIC_INVENTORY | 使用する既存の Ansible インベントリーへのパス。指定されていない場合は、~/tripleo-ansible- inventory.yaml に生成されます。 |
--ssh-user SSH_USER | 非推奨:tripleo-admin のみを ssh ユーザーとして使用する必要があります。 |
--tags TAGS | ansible-playbook に --tags として渡すタグまたはタグのコンマ区切りリストを指定する文字列。 |
--skip-tags SKIP_TAGS | ansible-playbook に --skip-tags として渡すタグまたはタグのコンマ区切りリストを指定する文字列。 |
--stack STACK | Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME) |
-e EXTRA_VARS, --extra-vars EXTRA_VARS | 追加の変数を key=value または yaml/json として設定します。 |
--no-workflow | TripleO mistral ワークフローを介して Ansible を実行するのではなく、システムコマンド経由で ansible-playbook を直接実行します。 |
-y、--yes | アップグレード操作の前に必要な確認をスキップするには、-y または --yes を使用します。注意して使用してください。 |
--limit LIMIT | config-download Ansible Playbook の実行を限定する単一ノードまたはコンマ区切りのノードリストを特定する文字列。例:--limit "compute-0,compute-1,compute-5" |
--ansible-forks ANSIBLE_FORKS | config- download ansible-playbook コマンドに使用する Ansible のフォークの数。 |
55.17. overcloud failures
デプロイメントの失敗を取得します。
使用方法
openstack overcloud failures [-h] [--plan PLAN]
表55.20 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--plan PLAN、--stack PLAN | スタック/プラン の名前 (デフォルト:overcloud) |
55.18. overcloud generate fencing
フェンシングパラメーターを生成します。
使用方法
openstack overcloud generate fencing [-h] [-a FENCE_ACTION] [--delay DELAY] [--ipmi-lanplus] [--ipmi-no-lanplus] [--ipmi-cipher IPMI_CIPHER] [--ipmi-level IPMI_LEVEL] [--output OUTPUT] instackenv
表55.21 位置引数
値 | 概要 |
---|---|
instackenv | なし |
表55.22 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-a FENCE_ACTION、--action FENCE_ACTION | 非推奨: このオプションは無視されます。 |
--delay DELAY | フェンシングが開始するまで遅延の秒数を待機します。 |
--ipmi-lanplus | 非推奨: これがデフォルトです。 |
--ipmi-no-lanplus | lanplus を使用しません。デフォルトは false です。 |
--ipmi-cipher IPMI_CIPHER | 使用する暗号スイート (ipmitool -c パラメーターと同じ)。 |
--ipmi-level IPMI_LEVEL | ipmi デバイスの権限レベル。有効なレベル: callback、user、operator、administrator |
--output OUTPUT | ファイルにパラメーターを書き込みます。 |
55.19. overcloud image build
オーバークラウドのイメージをビルドします。
使用方法
openstack overcloud image build [-h] [--config-file <yaml config file>] [--image-name <image name>] [--no-skip] [--output-directory OUTPUT_DIRECTORY] [--temp-dir TEMP_DIR]
表55.23 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--config-file <yaml config file> | イメージビルドを指定する yaml 設定ファイル。複数回指定できます。順序は保持され、後のファイルは以前のファイルにある一部のオプションを上書きします。他のオプションは追加されます。 |
--image-name <image name> | ビルドするイメージの名前。複数回指定できます。指定されていない場合は、指定の YAML ファイルのすべてのイメージがビルドされます。 |
--no-skip | キャッシュされたイメージが存在する場合はビルドを省略します。 |
--output-directory OUTPUT_DIRECTORY | イメージのアウトプットディレクトリー。デフォルトは $TRIPLEO_ROOT で、未設定の場合は現在のディレクトリーです。 |
--temp-dir TEMP_DIR | イメージのビルド時に使用する一時ディレクトリーデフォルトは $TMPDIR で、未設定の場合は現在のディレクトリーです。 |
55.20. overcloud image upload
オーバークラウドデプロイメント用に、既存のイメージファイルを利用できるようにします。
使用方法
openstack overcloud image upload [-h] [--image-path IMAGE_PATH] [--os-image-name OS_IMAGE_NAME] [--ironic-python-agent-name IPA_NAME] [--http-boot HTTP_BOOT] [--update-existing] [--whole-disk] [--architecture ARCHITECTURE] [--platform PLATFORM] [--image-type {os,ironic-python-agent}] [--progress] [--local] [--local-path LOCAL_PATH]
表55.24 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--image-path IMAGE_PATH | イメージファイルが含まれるディレクトリーへのパス |
--os-image-name OS_IMAGE_NAME | Openstack ディスクイメージのファイル名 |
--ironic-python-agent-name IPA_NAME | Openstack ironic-python-agent (agent) イメージのファイル名 |
--http-boot HTTP_BOOT | ironic-python-agent イメージのルートディレクトリー。複数のアーキテクチャー/プラットフォームのイメージをアップロードしている場合は、アーキテクチャー/プラットフォームごとに異なるディレクトリーが作成されるように、この引数を変更します。 |
--update-existing | イメージがすでに存在する場合は更新します。 |
--whole-disk | これを設定すると、アップロードされる overcloud-full イメージが完全なディスクのイメージとみなされます。 |
--architecture ARCHITECTURE | これらのイメージのアーキテクチャー種別。x86_64、i386、および ppc64le は共通オプションです。このオプションは、instackenv.json の少なくとも 1 つの arch 値と一致している必要があります。 |
--platform PLATFORM | これらのイメージのプラットフォーム種別。platform はアーキテクチャーのサブカテゴリーです。たとえば、x86_64 の汎用イメージがありますが、SNB (SandyBridge) に固有のイメージを提供することができます。 |
--image-type {os,ironic-python-agent} | 指定した場合には、アップロードするイメージ種別を制限できます (オーバークラウドイメージ用の os または ironic-python-agent の場合は ironic-python- agent)。 |
--progress | ファイルのアップロードアクション用に進捗バーを表示します。 |
--local | イメージサービスのエンドポイントがある場合でも、ローカルにファイルをコピーします。 |
--local-path LOCAL_PATH | イメージのエンドポイントがない場合、または --local が指定されている場合、イメージファイルのコピー先のルートディレクトリー |
55.21. overcloud netenv validate
ネットワークの環境ファイルを検証します。
使用方法
openstack overcloud netenv validate [-h] [-f NETENV]
表55.25 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-f NETENV、--file NETENV | ネットワーク環境ファイルへのパス |
55.22. overcloud node bios configure
指定のノードに BIOS 設定を適用します。
使用方法
openstack overcloud node bios configure [-h] [--all-manageable] [--configuration <configuration>] [<node_uuid> [<node_uuid> ...]]
表55.26 位置引数
値 | 概要 |
---|---|
<node_uuid> | bios を設定するノードのベアメタルノードの uuid |
表55.27 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-manageable | 現在 manageable の状態にあるすべてのノードに bios を設定します。 |
--configuration <configuration> | BIOS 設定 (yaml/json 文字列またはファイル名) |
55.23. overcloud node bios reset
BIOS 設定を出荷時のデフォルトにリセットします。
使用方法
openstack overcloud node bios reset [-h] [--all-manageable] [<node_uuid> [<node_uuid> ...]]
表55.28 位置引数
値 | 概要 |
---|---|
<node_uuid> | bios をリセットするノードのベアメタルノードの uuid |
表55.29 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-manageable | 現在 manageable の状態にあるすべてのノードの BIOS をリセットします。 |
55.24. overcloud node clean
クリーニングを使用してノードを実行します。
使用方法
openstack overcloud node clean [-h] [--all-manageable] [--provide] [<node_uuid> [<node_uuid> ...]]
表55.30 位置引数
値 | 概要 |
---|---|
<node_uuid> | クリーニングするノードのベアメタルノード uuid |
表55.31 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-manageable | 現在 manageable の状態にあるノードを消去します。 |
--provide | ノードのクリーニング後に指定 (利用可能に) します。 |
55.25. overcloud node configure
ノードのブートオプションを設定します。
使用方法
openstack overcloud node configure [-h] [--all-manageable] [--deploy-kernel DEPLOY_KERNEL] [--deploy-ramdisk DEPLOY_RAMDISK] [--instance-boot-option {local,netboot}] [--root-device ROOT_DEVICE] [--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE] [--overwrite-root-device-hints] [<node_uuid> [<node_uuid> ...]]
表55.32 位置引数
値 | 概要 |
---|---|
<node_uuid> | 設定するノードのベアメタルノード uuid |
表55.33 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-manageable | 現在 manageable の状態にあるノードを設定します。 |
--deploy-kernel DEPLOY_KERNEL | デプロイカーネルのあるイメージ。 |
--deploy-ramdisk DEPLOY_RAMDISK | デプロイ ramdisk のあるイメージ |
--instance-boot-option {local,netboot} | インスタンスをローカルのハードドライブ (local) またはネットワーク (netboot) から起動するかどうかを設定します。 |
--root-device ROOT_DEVICE | ノードのルートデバイスを定義します。選択元となるデバイス名のリスト (/dev を省く)、または 2 つのストラテジー (最大または最小) のいずれかを選択できます。機能するには、イントロスペクション後にこのコマンドを実行する必要があります。 |
--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE | 検出されるルートデバイスの最小サイズ (gib 単位)。--root-device と併用します。 |
--overwrite-root-device-hints | --root-device が使用されたときに既存のルートデバイスヒントを上書きするかどうか。 |
55.26. overcloud node delete
オーバークラウドノードを削除します。
使用方法
openstack overcloud node delete [-h] [-b <BAREMETAL DEPLOYMENT FILE>] [--stack STACK] [--templates [TEMPLATES]] [-e <HEAT ENVIRONMENT FILE>] [--timeout <TIMEOUT>] [-y] [<node> [<node> ...]]
表55.34 位置引数
値 | 概要 |
---|---|
<node> | 削除するノード ID(そうでなけれは、--baremetal-deployment ファイルで指定) |
表55.35 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-b <BAREMETAL DEPLOYMENT FILE>, --baremetal-deployment <BAREMETAL DEPLOYMENT FILE> | ベアメタルデプロイメントを記述する設定ファイル |
--stack STACK | スケーリングする heat スタックの名前または ID(デフォルト=env: OVERCLOUD_STACK_NAME) |
--templates [TEMPLATES] | デプロイする Heat テンプレートが格納されているディレクトリー。この引数は非推奨です。このコマンドはデプロイメントプランを活用しています。プランは、このコマンドを実行する前に更新する必要があります。それ以外の場合は、この引数は警告なしで無視されます。 |
-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE> | heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。) この引数は非推奨です。このコマンドはデプロイメントプランを活用しています。プランは、このコマンドを実行する前に更新する必要があります。それ以外の場合は、この引数は警告なしで無視されます。 |
--timeout <TIMEOUT> | ノードが削除されるまで待機するタイムアウト (分単位)。keystone セッション時間により、タイムアウトに 4 時間の上限がある点に注意してください。 |
-y、--yes | yes/no プロンプトを省略します (yes を想定)。 |
55.27. overcloud node discover
BMC をポーリングしてオーバークラウドノードを検出します。
使用方法
openstack overcloud node discover [-h] (--ip <ips> | --range <range>) --credentials <key:value> [--port <ports>] [--introspect] [--run-validations] [--provide] [--no-deploy-image] [--instance-boot-option {local,netboot}] [--concurrency CONCURRENCY]
表55.36 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--ip <ips> | プローブする IP アドレス |
--range <range> | プローブまでの IP 範囲 |
--credentials <key:value> | 使用できる認証情報のキー/値のペア |
--port <ports> | プローブする BMC ポート |
--introspect | インポートしたノードをイントロスペクションします。 |
--run-validations | デプロイメント前の検証を実行します。これらの外部検証は TripleO Validations プロジェクトからのものです。 |
--provide | ノードを指定 (利用可能に) します。 |
--no-deploy-image | デプロイカーネルおよび ramdisk の設定を省略します。 |
--instance-boot-option {local,netboot} | インスタンスをローカルのハードドライブ (local) またはネットワーク (netboot) から起動するかどうかを設定します。 |
--concurrency CONCURRENCY | 一度にイントロスペクションするノードの最大数。 |
55.28. overcloud node import
JSON、YAML または CSV ファイルからベアメタルノードをインポートします。ノードのステータスはデフォルトで manageable に設定されます。
使用方法
openstack overcloud node import [-h] [--introspect] [--run-validations] [--validate-only] [--provide] [--no-deploy-image] [--instance-boot-option {local,netboot}] [--http-boot HTTP_BOOT] [--concurrency CONCURRENCY] env_file
表55.37 位置引数
値 | 概要 |
---|---|
env_file | なし |
表55.38 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--introspect | インポートしたノードをイントロスペクションします。 |
--run-validations | デプロイメント前の検証を実行します。これらの外部検証は TripleO Validations プロジェクトからのものです。 |
--validate-only | env_file を検証し、実際にノードをインポートせずに終了します。 |
--provide | ノードを指定 (利用可能に) します。 |
--no-deploy-image | デプロイカーネルおよび ramdisk の設定を省略します。 |
--instance-boot-option {local,netboot} | インスタンスをローカルのハードドライブ (local) またはネットワーク (netboot) から起動するかどうかを設定します。 |
--http-boot HTTP_BOOT | ironic-python-agent イメージのルートディレクトリー |
--concurrency CONCURRENCY | 一度にイントロスペクションするノードの最大数。 |
55.29. overcloud node introspect
manageable の状態にある、指定のノードまたはすべてのノードをイントロスペクションします。
使用方法
openstack overcloud node introspect [-h] [--all-manageable] [--provide] [--run-validations] [--concurrency CONCURRENCY] [<node_uuid> [<node_uuid> ...]]
表55.39 位置引数
値 | 概要 |
---|---|
<node_uuid> | イントロスペクションするノードのベアメタルノード uuid |
表55.40 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-manageable | 現在 manageable の状態にある全ノードをイントロスペクションします。 |
--provide | ノードのイントロスペクション後に指定 (利用可能に) します。 |
--run-validations | デプロイメント前の検証を実行します。これらの外部検証は TripleO Validations プロジェクトからのものです。 |
--concurrency CONCURRENCY | 一度にイントロスペクションするノードの最大数。 |
55.30. overcloud node provide
UUID または現在の manageable の状態をもとに、ノードを利用可能とマークします。
使用方法
openstack overcloud node provide [-h] [--all-manageable] [<node_uuid> [<node_uuid> ...]]
表55.41 位置引数
値 | 概要 |
---|---|
<node_uuid> | 指定するノードのベアメタルノード uuid |
表55.42 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-manageable | 現在 manageable の状態にあるノードをすべて提供します。 |
55.31. overcloud node provision
Ironic を使用して新規ノードをプロビジョニングします。
使用方法
openstack overcloud node provision [-h] [-o OUTPUT] [--stack STACK] [--overcloud-ssh-user OVERCLOUD_SSH_USER] [--overcloud-ssh-key OVERCLOUD_SSH_KEY] [--concurrency CONCURRENCY] [--timeout TIMEOUT] <baremetal_deployment.yaml>
表55.43 位置引数
値 | 概要 |
---|---|
<baremetal_deployment.yaml> | ベアメタルデプロイメントを記述する設定ファイル |
表55.44 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-o OUTPUT、--output OUTPUT | 出力環境ファイルへのパス |
--stack STACK | Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME) |
--overcloud-ssh-user OVERCLOUD_SSH_USER | 新たにデプロイされたノードに ssh アクセスするためのユーザー |
--overcloud-ssh-key OVERCLOUD_SSH_KEY | オーバークラウドノードへの ssh アクセスのキーパス。未定義の場合、キーが自動検出されます。 |
--concurrency CONCURRENCY | 一度にプロビジョニングするノード数 (デフォルトは 20) |
--timeout TIMEOUT | ノードのプロビジョニングが完了するまで待機する秒数 (デフォルト=3600) |
55.32. overcloud node unprovision
Ironic を使用したノードのプロビジョニングを解除します。
使用方法
openstack overcloud node unprovision [-h] [--stack STACK] [--all] [-y] <baremetal_deployment.yaml>
表55.45 位置引数
値 | 概要 |
---|---|
<baremetal_deployment.yaml> | ベアメタルデプロイメントを記述する設定ファイル |
表55.46 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--stack STACK | Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME) |
--all | デプロイメント内のすべてのインスタンスのプロビジョニングを解除します。 |
-y, --yes | yes/no プロンプトを省略します (yes と仮定)。 |
55.33. overcloud parameters set
プランのパラメーターを設定します。
使用方法
openstack overcloud parameters set [-h] name file_in
表55.47 位置引数
値 | 概要 |
---|---|
name | プランの名前 (swift コンテナー、Mistral 環境、および Heat スタック名に使用されます)。 |
file_in | None |
表55.48 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
55.34. overcloud plan create
デプロイメントプランを作成します。
使用方法
openstack overcloud plan create [-h] [--templates TEMPLATES] [--plan-environment-file PLAN_ENVIRONMENT_FILE] [--disable-password-generation] [--source-url SOURCE_URL] name
表55.49 位置引数
値 | 概要 |
---|---|
name | プランの名前 (オブジェクトストレージコンテナー、ワークフロー環境、およびオーケストレーションスタック名に使用されます)。 |
表55.50 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
--templates TEMPLATES | デプロイする Heat テンプレートが格納されているディレクトリー。このオプションまたは --source_url を指定しないと、アンダークラウドにパッケージ化されたテンプレートが使用されます。 |
--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE | プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。 |
--disable-password-generation | パスワードの生成を無効にします。 |
--source-url SOURCE_URL | デプロイする Heat テンプレートが格納されている git リポジトリーの url。このオプションまたは --templates を指定しないと、アンダークラウドにパッケージ化されたテンプレートが使用されます。 |
55.35. overcloud plan delete
オーバークラウドデプロイメントプランを削除します。同じ名前のスタックが存在する場合には、プランは削除されません。
使用方法
openstack overcloud plan delete [-h] <name> [<name> ...]
表55.51 位置引数
値 | 概要 |
---|---|
<name> | 削除するプランの名前 |
表55.52 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
55.36. overcloud plan deploy
デプロイメントプランをデプロイします。
使用方法
openstack overcloud plan deploy [-h] [--timeout <TIMEOUT>] [--run-validations] name
表55.53 位置引数
値 | 概要 |
---|---|
name | デプロイするプランの名前。 |
表55.54 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
--timeout <TIMEOUT>, -t <TIMEOUT> | デプロイメントのタイムアウト (分単位) |
--run-validations | デプロイメント前の検証を実行します。これらの外部検証は TripleO Validations プロジェクトからのものです。 |
55.37. overcloud plan export
デプロイメントプランをエクスポートします。
使用方法
openstack overcloud plan export [-h] [--output-file <output file>] [--force-overwrite] <name>
表55.55 位置引数
値 | 概要 |
---|---|
<name> | エクスポートするプランの名前。 |
表55.56 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
--output-file <output file>, -o <output file> | エクスポート用の出力ファイルの名前。デフォルトは "<name>.tar.gz" です。 |
--force-overwrite, -f | 出力ファイルが存在する場合は上書きします。 |
55.38. overcloud plan list
オーバークラウドデプロイメントプランをリスト表示します。
使用方法
openstack overcloud plan list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表55.57 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表55.58 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表55.59 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表55.60 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表55.61 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
55.39. overcloud profiles list
オーバークラウドノードのプロファイルをリスト表示します。
使用方法
openstack overcloud profiles list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--all] [--control-scale CONTROL_SCALE] [--compute-scale COMPUTE_SCALE] [--ceph-storage-scale CEPH_STORAGE_SCALE] [--block-storage-scale BLOCK_STORAGE_SCALE] [--swift-storage-scale SWIFT_STORAGE_SCALE] [--control-flavor CONTROL_FLAVOR] [--compute-flavor COMPUTE_FLAVOR] [--ceph-storage-flavor CEPH_STORAGE_FLAVOR] [--block-storage-flavor BLOCK_STORAGE_FLAVOR] [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
表55.62 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all | nova で利用できないノードであっても、すべてのノードをリスト表示します。 |
--control-scale CONTROL_SCALE | 新しいコントロールノード数。 |
--compute-scale COMPUTE_SCALE | 新しいコンピュートノード数。 |
--ceph-storage-scale CEPH_STORAGE_SCALE | 新しい ceph ストレージノード数。 |
--block-storage-scale BLOCK_STORAGE_SCALE | 新しい cinder ストレージノード数。 |
--swift-storage-scale SWIFT_STORAGE_SCALE | 新しい swift ストレージノード数。 |
--control-flavor CONTROL_FLAVOR | コントロールノードに使用する nova フレーバー。 |
--compute-flavor COMPUTE_FLAVOR | コンピュートノードに使用する nova フレーバー。 |
--ceph-storage-flavor CEPH_STORAGE_FLAVOR | ceph ストレージノードに使用する nova フレーバー。 |
--block-storage-flavor BLOCK_STORAGE_FLAVOR | cinder ストレージノードに使用する Nova フレーバー |
--swift-storage-flavor SWIFT_STORAGE_FLAVOR | swift ストレージノードに使用する nova フレーバー |
表55.63 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表55.64 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表55.65 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表55.66 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
55.40. overcloud profiles match
ノード上のプロファイルを割り当ておよび検証します。
使用方法
openstack overcloud profiles match [-h] [--dry-run] [--control-scale CONTROL_SCALE] [--compute-scale COMPUTE_SCALE] [--ceph-storage-scale CEPH_STORAGE_SCALE] [--block-storage-scale BLOCK_STORAGE_SCALE] [--swift-storage-scale SWIFT_STORAGE_SCALE] [--control-flavor CONTROL_FLAVOR] [--compute-flavor COMPUTE_FLAVOR] [--ceph-storage-flavor CEPH_STORAGE_FLAVOR] [--block-storage-flavor BLOCK_STORAGE_FLAVOR] [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
表55.67 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--dry-run | 検証のみを実行しますが、変更は適用されません。 |
--control-scale CONTROL_SCALE | 新しいコントロールノード数。 |
--compute-scale COMPUTE_SCALE | 新しいコンピュートノード数。 |
--ceph-storage-scale CEPH_STORAGE_SCALE | 新しい ceph ストレージノード数。 |
--block-storage-scale BLOCK_STORAGE_SCALE | 新しい cinder ストレージノード数。 |
--swift-storage-scale SWIFT_STORAGE_SCALE | 新しい swift ストレージノード数。 |
--control-flavor CONTROL_FLAVOR | コントロールノードに使用する nova フレーバー。 |
--compute-flavor COMPUTE_FLAVOR | コンピュートノードに使用する nova フレーバー。 |
--ceph-storage-flavor CEPH_STORAGE_FLAVOR | ceph ストレージノードに使用する nova フレーバー。 |
--block-storage-flavor BLOCK_STORAGE_FLAVOR | cinder ストレージノードに使用する Nova フレーバー |
--swift-storage-flavor SWIFT_STORAGE_FLAVOR | swift ストレージノードに使用する nova フレーバー |
55.41. overcloud raid create
指定のノードに RAID を作成します。
使用方法
openstack overcloud raid create [-h] --node NODE configuration
表55.68 位置引数
値 | 概要 |
---|---|
configuration | RAID 設定 (yaml/json 文字列またはファイル名) |
表55.69 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--node NODE | RAID を作成するノード (状態が manageable でなければなりません)。複数回指定できます。 |
55.42. overcloud role list
利用可能なロールをリスト表示します (非推奨)。代わりに openstack overcloud roles list を使用してください。
使用方法
openstack overcloud role list [-h] [--roles-path <roles directory>]
表55.70 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--roles-path <roles directory> | ロールの yaml ファイルが含されるファイルシステムパス。デフォルトでは /usr/share/openstack-tripleo-heat- templates/roles です。 |
55.43. overcloud role show
指定のロールに関する情報を表示します (非推奨)。代わりに openstack overcloud roles show を使用してください。
使用方法
openstack overcloud role show [-h] [--roles-path <roles directory>] <role>
表55.71 位置引数
値 | 概要 |
---|---|
<role> | 詳細情報を表示するロール。 |
表55.72 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--roles-path <roles directory> | ロールの yaml ファイルが含されるファイルシステムパス。デフォルトでは /usr/share/openstack-tripleo-heat- templates/roles です。 |
55.44. overcloud roles generate
roles_data.yaml ファイルを生成します。
使用方法
openstack overcloud roles generate [-h] [--roles-path <roles directory>] [-o <output file>] [--skip-validate] <role> [<role> ...]
表55.73 位置引数
値 | 概要 |
---|---|
<role> | デプロイメントの roles_data.yaml ファイルを生成するために使用するロールのリスト。注記: ロールに primary および controller タグがない場合は、順序が重要になります。ロールがタグ付けされない場合、最初にリスト表示されるロールはプライマリーロールとみなされます。これは通常、Controller ロールです。 |
表55.74 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--roles-path <roles directory> | ロールの yaml ファイルが含されるファイルシステムパス。デフォルトでは /usr/share/openstack-tripleo-heat- templates/roles です。 |
-o <output file>, --output-file <output file> | roles_data.yaml など、すべての出力をキャプチャーするためのファイル。 |
--skip-validate | roles_data.yaml を生成する際に、ロールのメタデータ種別の検証をスキップします。 |
55.45. overcloud roles list
指定のプランの現在および利用可能なロールをリスト表示します。
使用方法
openstack overcloud roles list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name NAME] [--detail] [--current]
表55.75 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name NAME | プランの名前 (オブジェクトストレージコンテナー、ワークフロー環境、およびオーケストレーションスタック名に使用されます)。 |
--detail | 各ロールの詳細を含めます。 |
--current | プランで現在有効なロールの情報のみを表示します。 |
表55.76 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表55.77 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表55.78 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表55.79 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
55.46. overcloud roles show
プランを指定して、特定のロールの詳細を表示します。
使用方法
openstack overcloud roles show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name NAME] <role>
表55.80 位置引数
値 | 概要 |
---|---|
<role> | 検索するロール名 |
表55.81 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name NAME | プランの名前 (オブジェクトストレージコンテナー、ワークフロー環境、およびオーケストレーションスタック名に使用されます)。 |
表55.82 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表55.83 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表55.84 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表55.85 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
55.47. overcloud status
デプロイメントのステータスを取得します。
使用方法
openstack overcloud status [-h] [--plan PLAN]
表55.86 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--plan PLAN、--stack PLAN | スタック/プラン の名前 (デフォルト:overcloud) |
55.48. overcloud support report collect
選択したサーバーで sosreport を実行します。
使用方法
openstack overcloud support report collect [-h] [-c] [-o DESTINATION] [--stack STACK] [--skip-container-delete] [-t TIMEOUT] [-n CONCURRENCY] [--collect-only | --download-only] [-v VERBOSITY] server_name
表55.87 位置引数
値 | 概要 |
---|---|
server_name | 一致するサーバー名、グループ名、または名前の一部。たとえば、"Controller" は環境のすべてのコントローラーに一致します。 |
表55.88 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-c, --containers | 非推奨:ログを保存する swift コンテナー |
-o DESTINATION, --output DESTINATION | レポートの出力ディレクトリー |
--stack STACK | ログ収集に使用するスタック名。 |
--skip-container-delete | ファイルがダウンロードされた後にコンテナーを削除しません。--collect-only または --download- only が指定されている場合は無視されます。 |
-t TIMEOUT, --timeout TIMEOUT | ログの収集およびコンテナーの削除ワークフローが完了するまでの最大待機時間。 |
-n CONCURRENCY、--concurrency CONCURRENCY | 実行する並列ログコレクションおよびオブジェクトの削除タスクの数。 |
--collect-only | 非推奨:ログのダウンロードを省略し、ログの収集とコンテナーへの配置のみを行います。 |
--download-only | 非推奨:生成は省略され、提供されるコンテナーからのみダウンロードされます。 |
-V VERBOSITY、--verbose VERBOSITY | None |
55.49. overcloud update converge
オーバークラウドノードで更新を収束します。これによりプランおよびスタックが復元され、通常のデプロイメントワークフローに戻されます。
使用方法
openstack overcloud update converge [--templates [TEMPLATES]] [--stack STACK] [--timeout <TIMEOUT>] [--control-scale CONTROL_SCALE] [--compute-scale COMPUTE_SCALE] [--ceph-storage-scale CEPH_STORAGE_SCALE] [--block-storage-scale BLOCK_STORAGE_SCALE] [--swift-storage-scale SWIFT_STORAGE_SCALE] [--control-flavor CONTROL_FLAVOR] [--compute-flavor COMPUTE_FLAVOR] [--ceph-storage-flavor CEPH_STORAGE_FLAVOR] [--block-storage-flavor BLOCK_STORAGE_FLAVOR] [--swift-storage-flavor SWIFT_STORAGE_FLAVOR] [--libvirt-type {kvm,qemu}] [--ntp-server NTP_SERVER] [--no-proxy NO_PROXY] [--overcloud-ssh-user OVERCLOUD_SSH_USER] [--overcloud-ssh-key OVERCLOUD_SSH_KEY] [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK] [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT] [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT] [--environment-file <HEAT ENVIRONMENT FILE>] [--environment-directory <HEAT ENVIRONMENT DIRECTORY>] [--roles-file ROLES_FILE] [--networks-file NETWORKS_FILE] [--plan-environment-file PLAN_ENVIRONMENT_FILE] [--no-cleanup] [--update-plan-only] [--validation-errors-nonfatal] [--validation-warnings-fatal] [--disable-validations] [--inflight-validations] [--dry-run] [--run-validations] [--skip-postconfig] [--force-postconfig] [--skip-deploy-identifier] [--answers-file ANSWERS_FILE] [--disable-password-generation] [--deployed-server] [--config-download] [--no-config-download] [--config-download-only] [--output-dir OUTPUT_DIR] [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG] [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT] [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER] [-b <baremetal_deployment.yaml>] [--limit LIMIT] [--tags TAGS] [--skip-tags SKIP_TAGS] [--ansible-forks ANSIBLE_FORKS] [-y]
表55.89 コマンド引数
値 | 概要 |
---|---|
--templates [TEMPLATES] | デプロイする Heat テンプレートが格納されているディレクトリー。 |
--stack STACK | 作成または更新するスタック名 |
--timeout <TIMEOUT>, -t <TIMEOUT> | デプロイメントのタイムアウト (分単位) |
--control-scale CONTROL_SCALE | 新しいコントロールノード数 (非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。このオプションは U リリースで削除されます)。 |
--compute-scale COMPUTE_SCALE | 新しいコンピュートノード数 (非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。このオプションは U リリースで削除されます)。 |
--ceph-storage-scale CEPH_STORAGE_SCALE | 新しい ceph ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--block-storage-scale BLOCK_STORAGE_SCALE | 新しい cinder ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--swift-storage-scale SWIFT_STORAGE_SCALE | 新しい swift ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--control-flavor CONTROL_FLAVOR | コントロールノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。このオプションは U リリースで削除されます)。 |
--compute-flavor COMPUTE_FLAVOR | コンピュートノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。このオプションは U リリースで削除されます)。 |
--ceph-storage-flavor CEPH_STORAGE_FLAVOR | ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--block-storage-flavor BLOCK_STORAGE_FLAVOR | cinder ストレージノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--swift-storage-flavor SWIFT_STORAGE_FLAVOR | swift ストレージノードに使用する nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--libvirt-type {kvm,qemu} | Libvirt ドメインの種別。 |
--ntp-server NTP_SERVER | オーバークラウドノードの ntp。 |
--no-proxy NO_PROXY | プロキシーされないホストのコンマ区切りリスト。 |
--overcloud-ssh-user OVERCLOUD_SSH_USER | オーバークラウドノードへの ssh アクセスのためのユーザー |
--overcloud-ssh-key OVERCLOUD_SSH_KEY | オーバークラウドノードへの ssh アクセスに使用する鍵のパス。未定義の場合、キーは自動検出されます。 |
--overcloud-ssh-network OVERCLOUD_SSH_NETWORK | オーバークラウドノードへの ssh アクセスに使用するネットワーク名。 |
--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT | ssh enable プロセスが完了するまでのタイムアウト。 |
--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT | ssh ポートがアクティブになるまで待機するタイムアウト。 |
--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE> | heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。) |
--environment-directory <HEAT ENVIRONMENT DIRECTORY> | heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。 |
--roles-file ROLES_FILE, -r ROLES_FILE | ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは --templates に対する相対パスを指定できます。 |
--networks-file NETWORKS_FILE, -n NETWORKS_FILE | ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。 |
--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE | プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。 |
--no-cleanup | 一時ファイルをクリーンアップせず、場所をログとして記録します。 |
--update-plan-only | プランの更新のみを行います。実際のデプロイメントは実行しません。注記: 今後のリリースでは、別のコマンドに移行します。 |
--validation-errors-nonfatal | 検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。 |
--validation-warnings-fatal | 設定の事前チェックで警告がある場合は終了します。 |
--disable-validations | 非推奨。デプロイメント前の検証を完全に無効にします。これらの検証は、組み込まれたデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。これらの検証は、tripleo-validations の外部検証により実行されるようになりました。 |
--inflight-validations | デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。 |
--dry-run | 検証のみを実行しますが、変更は適用されません。 |
--run-validations | tripleo-validations プロジェクトからの外部検証を実行します。 |
--skip-postconfig | オーバークラウドのデプロイ後の設定を省略します。 |
--force-postconfig | オーバークラウドのデプロイ後の設定を強制的に行います。 |
--skip-deploy-identifier | DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメント手順は、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。 |
--answers-file ANSWERS_FILE | 引数とパラメーターが記載された YAML ファイルへのパス。 |
--disable-password-generation | パスワードの生成を無効にします。 |
--deployed-server | 事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、および image サービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。 |
--config-download | config-download メカニズムを使用してデプロイメントを実行します。これは現在のデフォルトであり、この CLI のオプションは今後廃止される可能性があります。 |
--no-config-download, --stack-only | config-download ワークフローを無効にして、スタックと関連する OpenStack リソースのみを作成します。ソフトウェア設定は適用されません。 |
--config-download-only | スタックの作成/更新を無効にして、ソフトウェア設定を適用する config-download ワークフローのみを実行します。 |
--output-dir OUTPUT_DIR | config-download を使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値 (/var/lib/mistral/<execution id>) が使用されます。 |
--override-ansible-cfg OVERRIDE_ANSIBLE_CFG | Ansible 設定ファイルへのパス。ファイルの設定は、デフォルトで config-download が使用する設定を上書きします。 |
--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT | config-download の手順に使用するタイムアウト (分単位)。設定しなければ、スタック操作後の --timeout パラメーターの残り時間にかかわらず、デフォルトがその時間に設定されます。 |
--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER | デプロイメントアクションに使用する Python インタープリターへのパス。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。 |
-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml> | ベアメタルデプロイメントを記述する設定ファイル |
--limit LIMIT | config-download Ansible Playbook の実行を限定する単一ノードまたはコンマ区切りのノードリストを特定する文字列。例:--limit "compute-0,compute-1,compute-5" |
--tags TAGS | config-download ansible-playbook コマンドの実行時に使用するタグのリスト。 |
--skip-tags SKIP_TAGS | config- download ansible-playbook コマンドの実行時に省略するタグのリスト。 |
--ansible-forks ANSIBLE_FORKS | config- download ansible-playbook コマンドに使用する Ansible のフォークの数。 |
-y、--yes | 更新操作の前に必要な確認をスキップするには、-y または --yes を使用します。注意して使用してください。 |
55.50. overcloud update prepare
オーバークラウドノードの heat スタックの更新を実行して、heat stack の出力を更新します。heat スタックの出力は、後でマイナー更新のワークフローを提供する Ansible Playbook を生成するのに使用されます。これは、オーバークラウドのマイナー更新の最初のステップとして使用されます。
使用方法
openstack overcloud update prepare [--templates [TEMPLATES]] [--stack STACK] [--timeout <TIMEOUT>] [--control-scale CONTROL_SCALE] [--compute-scale COMPUTE_SCALE] [--ceph-storage-scale CEPH_STORAGE_SCALE] [--block-storage-scale BLOCK_STORAGE_SCALE] [--swift-storage-scale SWIFT_STORAGE_SCALE] [--control-flavor CONTROL_FLAVOR] [--compute-flavor COMPUTE_FLAVOR] [--ceph-storage-flavor CEPH_STORAGE_FLAVOR] [--block-storage-flavor BLOCK_STORAGE_FLAVOR] [--swift-storage-flavor SWIFT_STORAGE_FLAVOR] [--libvirt-type {kvm,qemu}] [--ntp-server NTP_SERVER] [--no-proxy NO_PROXY] [--overcloud-ssh-user OVERCLOUD_SSH_USER] [--overcloud-ssh-key OVERCLOUD_SSH_KEY] [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK] [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT] [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT] [--environment-file <HEAT ENVIRONMENT FILE>] [--environment-directory <HEAT ENVIRONMENT DIRECTORY>] [--roles-file ROLES_FILE] [--networks-file NETWORKS_FILE] [--plan-environment-file PLAN_ENVIRONMENT_FILE] [--no-cleanup] [--update-plan-only] [--validation-errors-nonfatal] [--validation-warnings-fatal] [--disable-validations] [--inflight-validations] [--dry-run] [--run-validations] [--skip-postconfig] [--force-postconfig] [--skip-deploy-identifier] [--answers-file ANSWERS_FILE] [--disable-password-generation] [--deployed-server] [--config-download] [--no-config-download] [--config-download-only] [--output-dir OUTPUT_DIR] [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG] [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT] [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER] [-b <baremetal_deployment.yaml>] [--limit LIMIT] [--tags TAGS] [--skip-tags SKIP_TAGS] [--ansible-forks ANSIBLE_FORKS] [-y]
表55.90 コマンド引数
値 | 概要 |
---|---|
--templates [TEMPLATES] | デプロイする Heat テンプレートが格納されているディレクトリー。 |
--stack STACK | 作成または更新するスタック名 |
--timeout <TIMEOUT>, -t <TIMEOUT> | デプロイメントのタイムアウト (分単位) |
--control-scale CONTROL_SCALE | 新しいコントロールノード数 (非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。このオプションは U リリースで削除されます)。 |
--compute-scale COMPUTE_SCALE | 新しいコンピュートノード数 (非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。このオプションは U リリースで削除されます)。 |
--ceph-storage-scale CEPH_STORAGE_SCALE | 新しい ceph ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--block-storage-scale BLOCK_STORAGE_SCALE | 新しい cinder ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--swift-storage-scale SWIFT_STORAGE_SCALE | 新しい swift ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--control-flavor CONTROL_FLAVOR | コントロールノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。このオプションは U リリースで削除されます)。 |
--compute-flavor COMPUTE_FLAVOR | コンピュートノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。このオプションは U リリースで削除されます)。 |
--ceph-storage-flavor CEPH_STORAGE_FLAVOR | ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--block-storage-flavor BLOCK_STORAGE_FLAVOR | cinder ストレージノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--swift-storage-flavor SWIFT_STORAGE_FLAVOR | swift ストレージノードに使用する nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--libvirt-type {kvm,qemu} | Libvirt ドメインの種別。 |
--ntp-server NTP_SERVER | オーバークラウドノードの ntp。 |
--no-proxy NO_PROXY | プロキシーされないホストのコンマ区切りリスト。 |
--overcloud-ssh-user OVERCLOUD_SSH_USER | オーバークラウドノードへの ssh アクセスのためのユーザー |
--overcloud-ssh-key OVERCLOUD_SSH_KEY | オーバークラウドノードへの ssh アクセスに使用する鍵のパス。未定義の場合、キーは自動検出されます。 |
--overcloud-ssh-network OVERCLOUD_SSH_NETWORK | オーバークラウドノードへの ssh アクセスに使用するネットワーク名。 |
--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT | ssh enable プロセスが完了するまでのタイムアウト。 |
--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT | ssh ポートがアクティブになるまで待機するタイムアウト。 |
--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE> | heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。) |
--environment-directory <HEAT ENVIRONMENT DIRECTORY> | heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。 |
--roles-file ROLES_FILE, -r ROLES_FILE | ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは --templates に対する相対パスを指定できます。 |
--networks-file NETWORKS_FILE, -n NETWORKS_FILE | ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。 |
--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE | プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。 |
--no-cleanup | 一時ファイルをクリーンアップせず、場所をログとして記録します。 |
--update-plan-only | プランの更新のみを行います。実際のデプロイメントは実行しません。注記: 今後のリリースでは、別のコマンドに移行します。 |
--validation-errors-nonfatal | 検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。 |
--validation-warnings-fatal | 設定の事前チェックで警告がある場合は終了します。 |
--disable-validations | 非推奨。デプロイメント前の検証を完全に無効にします。これらの検証は、組み込まれたデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。これらの検証は、tripleo-validations の外部検証により実行されるようになりました。 |
--inflight-validations | デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。 |
--dry-run | 検証のみを実行しますが、変更は適用されません。 |
--run-validations | tripleo-validations プロジェクトからの外部検証を実行します。 |
--skip-postconfig | オーバークラウドのデプロイ後の設定を省略します。 |
--force-postconfig | オーバークラウドのデプロイ後の設定を強制的に行います。 |
--skip-deploy-identifier | DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメント手順は、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。 |
--answers-file ANSWERS_FILE | 引数とパラメーターが記載された YAML ファイルへのパス。 |
--disable-password-generation | パスワードの生成を無効にします。 |
--deployed-server | 事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、および image サービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。 |
--config-download | config-download メカニズムを使用してデプロイメントを実行します。これは現在のデフォルトであり、この CLI のオプションは今後廃止される可能性があります。 |
--no-config-download, --stack-only | config-download ワークフローを無効にして、スタックと関連する OpenStack リソースのみを作成します。ソフトウェア設定は適用されません。 |
--config-download-only | スタックの作成/更新を無効にして、ソフトウェア設定を適用する config-download ワークフローのみを実行します。 |
--output-dir OUTPUT_DIR | config-download を使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値 (/var/lib/mistral/<execution id>) が使用されます。 |
--override-ansible-cfg OVERRIDE_ANSIBLE_CFG | Ansible 設定ファイルへのパス。ファイルの設定は、デフォルトで config-download が使用する設定を上書きします。 |
--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT | config-download の手順に使用するタイムアウト (分単位)。設定しなければ、スタック操作後の --timeout パラメーターの残り時間にかかわらず、デフォルトがその時間に設定されます。 |
--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER | デプロイメントアクションに使用する Python インタープリターへのパス。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。 |
-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml> | ベアメタルデプロイメントを記述する設定ファイル |
--limit LIMIT | config-download Ansible Playbook の実行を限定する単一ノードまたはコンマ区切りのノードリストを特定する文字列。例:--limit "compute-0,compute-1,compute-5" |
--tags TAGS | config-download ansible-playbook コマンドの実行時に使用するタグのリスト。 |
--skip-tags SKIP_TAGS | config- download ansible-playbook コマンドの実行時に省略するタグのリスト。 |
--ansible-forks ANSIBLE_FORKS | config- download ansible-playbook コマンドに使用する Ansible のフォークの数。 |
-y、--yes | 更新操作の前に必要な確認をスキップするには、-y または --yes を使用します。注意して使用してください。 |
55.51. overcloud update run
オーバークラウドノードでマイナー更新 Ansible Playbook を実行します。
使用方法
openstack overcloud update run [-h] --limit LIMIT [--playbook PLAYBOOK] [--ssh-user SSH_USER] [--static-inventory STATIC_INVENTORY] [--stack STACK] [--no-workflow] [--tags TAGS] [--skip-tags SKIP_TAGS] [-y] [--ansible-forks ANSIBLE_FORKS]
表55.91 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit LIMIT | config-download Ansible Playbook の実行を限定する単一ノードまたはコンマ区切りのノードリストを特定する文字列。例:--limit "compute-0,compute-1,compute-5" |
--playbook PLAYBOOK | マイナー更新に使用する Ansible Playbook。デフォルトは特殊な値 all で、すべての更新 Playbook が実行されます。これは、update_steps_playbook.yaml、次に deploy_steps_playbook.yaml です。手動で実行したい場合は、このコマンドの連続した呼び出しで、これを各 Playbook に設定します。注記: すべてのサービスが更新され、ターゲットバージョンの設定で実行されるように、これらの Playbook の両方を必ず実行してください。 |
--ssh-user SSH_USER | 非推奨:tripleo-admin のみを ssh ユーザーとして使用する必要があります。 |
--static-inventory STATIC_INVENTORY | 使用する既存の Ansible インベントリーへのパス。指定されていない場合は、~/tripleo-ansible- inventory.yaml に生成されます。 |
--stack STACK | Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME) |
--no-workflow | TripleO mistral ワークフローを介して Ansible を実行するのではなく、システムコマンド経由で ansible-playbook を直接実行します。 |
--tags TAGS | config-download ansible-playbook コマンドの実行時に使用するタグのリスト。 |
--skip-tags SKIP_TAGS | config- download ansible-playbook コマンドの実行時に省略するタグのリスト。 |
-y、--yes | 更新操作の前に必要な確認をスキップするには、-y または --yes を使用します。注意して使用してください。 |
--ansible-forks ANSIBLE_FORKS | config- download ansible-playbook コマンドに使用する Ansible のフォークの数。 |
55.52. overcloud upgrade converge
メジャーアップグレードの収束: 保存したプランの Heat リソースをリセットします。これは、オーバークラウドのメジャーアップグレードを完了するための最後の手順です。主なタスクは、プランおよびスタックを更新して、将来のスタック更新のブロックを解除します。メジャーアップグレードのワークフローでは、一部のスタック Heat リソースに特定の値を設定しています。これにより、それらの設定をデフォルト値に戻します。
使用方法
openstack overcloud upgrade converge [--templates [TEMPLATES]] [--stack STACK] [--timeout <TIMEOUT>] [--control-scale CONTROL_SCALE] [--compute-scale COMPUTE_SCALE] [--ceph-storage-scale CEPH_STORAGE_SCALE] [--block-storage-scale BLOCK_STORAGE_SCALE] [--swift-storage-scale SWIFT_STORAGE_SCALE] [--control-flavor CONTROL_FLAVOR] [--compute-flavor COMPUTE_FLAVOR] [--ceph-storage-flavor CEPH_STORAGE_FLAVOR] [--block-storage-flavor BLOCK_STORAGE_FLAVOR] [--swift-storage-flavor SWIFT_STORAGE_FLAVOR] [--libvirt-type {kvm,qemu}] [--ntp-server NTP_SERVER] [--no-proxy NO_PROXY] [--overcloud-ssh-user OVERCLOUD_SSH_USER] [--overcloud-ssh-key OVERCLOUD_SSH_KEY] [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK] [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT] [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT] [--environment-file <HEAT ENVIRONMENT FILE>] [--environment-directory <HEAT ENVIRONMENT DIRECTORY>] [--roles-file ROLES_FILE] [--networks-file NETWORKS_FILE] [--plan-environment-file PLAN_ENVIRONMENT_FILE] [--no-cleanup] [--update-plan-only] [--validation-errors-nonfatal] [--validation-warnings-fatal] [--disable-validations] [--inflight-validations] [--dry-run] [--run-validations] [--skip-postconfig] [--force-postconfig] [--skip-deploy-identifier] [--answers-file ANSWERS_FILE] [--disable-password-generation] [--deployed-server] [--config-download] [--no-config-download] [--config-download-only] [--output-dir OUTPUT_DIR] [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG] [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT] [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER] [-b <baremetal_deployment.yaml>] [--limit LIMIT] [--tags TAGS] [--skip-tags SKIP_TAGS] [--ansible-forks ANSIBLE_FORKS] [-y]
表55.92 コマンド引数
値 | 概要 |
---|---|
--templates [TEMPLATES] | デプロイする Heat テンプレートが格納されているディレクトリー。 |
--stack STACK | 作成または更新するスタック名 |
--timeout <TIMEOUT>, -t <TIMEOUT> | デプロイメントのタイムアウト (分単位) |
--control-scale CONTROL_SCALE | 新しいコントロールノード数 (非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。このオプションは U リリースで削除されます)。 |
--compute-scale COMPUTE_SCALE | 新しいコンピュートノード数 (非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。このオプションは U リリースで削除されます)。 |
--ceph-storage-scale CEPH_STORAGE_SCALE | 新しい ceph ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--block-storage-scale BLOCK_STORAGE_SCALE | 新しい cinder ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--swift-storage-scale SWIFT_STORAGE_SCALE | 新しい swift ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--control-flavor CONTROL_FLAVOR | コントロールノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。このオプションは U リリースで削除されます)。 |
--compute-flavor COMPUTE_FLAVOR | コンピュートノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。このオプションは U リリースで削除されます)。 |
--ceph-storage-flavor CEPH_STORAGE_FLAVOR | ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--block-storage-flavor BLOCK_STORAGE_FLAVOR | cinder ストレージノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--swift-storage-flavor SWIFT_STORAGE_FLAVOR | swift ストレージノードに使用する nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--libvirt-type {kvm,qemu} | Libvirt ドメインの種別。 |
--ntp-server NTP_SERVER | オーバークラウドノードの ntp。 |
--no-proxy NO_PROXY | プロキシーされないホストのコンマ区切りリスト。 |
--overcloud-ssh-user OVERCLOUD_SSH_USER | オーバークラウドノードへの ssh アクセスのためのユーザー |
--overcloud-ssh-key OVERCLOUD_SSH_KEY | オーバークラウドノードへの ssh アクセスに使用する鍵のパス。未定義の場合、キーは自動検出されます。 |
--overcloud-ssh-network OVERCLOUD_SSH_NETWORK | オーバークラウドノードへの ssh アクセスに使用するネットワーク名。 |
--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT | ssh enable プロセスが完了するまでのタイムアウト。 |
--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT | ssh ポートがアクティブになるまで待機するタイムアウト。 |
--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE> | heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。) |
--environment-directory <HEAT ENVIRONMENT DIRECTORY> | heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。 |
--roles-file ROLES_FILE, -r ROLES_FILE | ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは --templates に対する相対パスを指定できます。 |
--networks-file NETWORKS_FILE, -n NETWORKS_FILE | ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。 |
--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE | プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。 |
--no-cleanup | 一時ファイルをクリーンアップせず、場所をログとして記録します。 |
--update-plan-only | プランの更新のみを行います。実際のデプロイメントは実行しません。注記: 今後のリリースでは、別のコマンドに移行します。 |
--validation-errors-nonfatal | 検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。 |
--validation-warnings-fatal | 設定の事前チェックで警告がある場合は終了します。 |
--disable-validations | 非推奨。デプロイメント前の検証を完全に無効にします。これらの検証は、組み込まれたデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。これらの検証は、tripleo-validations の外部検証により実行されるようになりました。 |
--inflight-validations | デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。 |
--dry-run | 検証のみを実行しますが、変更は適用されません。 |
--run-validations | tripleo-validations プロジェクトからの外部検証を実行します。 |
--skip-postconfig | オーバークラウドのデプロイ後の設定を省略します。 |
--force-postconfig | オーバークラウドのデプロイ後の設定を強制的に行います。 |
--skip-deploy-identifier | DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメント手順は、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。 |
--answers-file ANSWERS_FILE | 引数とパラメーターが記載された YAML ファイルへのパス。 |
--disable-password-generation | パスワードの生成を無効にします。 |
--deployed-server | 事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、および image サービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。 |
--config-download | config-download メカニズムを使用してデプロイメントを実行します。これは現在のデフォルトであり、この CLI のオプションは今後廃止される可能性があります。 |
--no-config-download, --stack-only | config-download ワークフローを無効にして、スタックと関連する OpenStack リソースのみを作成します。ソフトウェア設定は適用されません。 |
--config-download-only | スタックの作成/更新を無効にして、ソフトウェア設定を適用する config-download ワークフローのみを実行します。 |
--output-dir OUTPUT_DIR | config-download を使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値 (/var/lib/mistral/<execution id>) が使用されます。 |
--override-ansible-cfg OVERRIDE_ANSIBLE_CFG | Ansible 設定ファイルへのパス。ファイルの設定は、デフォルトで config-download が使用する設定を上書きします。 |
--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT | config-download の手順に使用するタイムアウト (分単位)。設定しなければ、スタック操作後の --timeout パラメーターの残り時間にかかわらず、デフォルトがその時間に設定されます。 |
--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER | デプロイメントアクションに使用する Python インタープリターへのパス。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。 |
-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml> | ベアメタルデプロイメントを記述する設定ファイル |
--limit LIMIT | config-download Ansible Playbook の実行を限定する単一ノードまたはコンマ区切りのノードリストを特定する文字列。例:--limit "compute-0,compute-1,compute-5" |
--tags TAGS | config-download ansible-playbook コマンドの実行時に使用するタグのリスト。 |
--skip-tags SKIP_TAGS | config- download ansible-playbook コマンドの実行時に省略するタグのリスト。 |
--ansible-forks ANSIBLE_FORKS | config- download ansible-playbook コマンドに使用する Ansible のフォークの数。 |
-y、--yes | アップグレード操作の前に必要な確認をスキップするには、-y または --yes を使用します。注意して使用してください。 |
55.53. overcloud upgrade prepare
オーバークラウドノードの heat スタックの更新を実行して、heat stack の出力を更新します。heat スタックの出力は、後でメジャーアップグレードのワークフローを提供する Ansible Playbook を生成するのに使用されます。これは、オーバークラウドのメジャーアップグレードの最初の手順として使用されます。
使用方法
openstack overcloud upgrade prepare [--templates [TEMPLATES]] [--stack STACK] [--timeout <TIMEOUT>] [--control-scale CONTROL_SCALE] [--compute-scale COMPUTE_SCALE] [--ceph-storage-scale CEPH_STORAGE_SCALE] [--block-storage-scale BLOCK_STORAGE_SCALE] [--swift-storage-scale SWIFT_STORAGE_SCALE] [--control-flavor CONTROL_FLAVOR] [--compute-flavor COMPUTE_FLAVOR] [--ceph-storage-flavor CEPH_STORAGE_FLAVOR] [--block-storage-flavor BLOCK_STORAGE_FLAVOR] [--swift-storage-flavor SWIFT_STORAGE_FLAVOR] [--libvirt-type {kvm,qemu}] [--ntp-server NTP_SERVER] [--no-proxy NO_PROXY] [--overcloud-ssh-user OVERCLOUD_SSH_USER] [--overcloud-ssh-key OVERCLOUD_SSH_KEY] [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK] [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT] [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT] [--environment-file <HEAT ENVIRONMENT FILE>] [--environment-directory <HEAT ENVIRONMENT DIRECTORY>] [--roles-file ROLES_FILE] [--networks-file NETWORKS_FILE] [--plan-environment-file PLAN_ENVIRONMENT_FILE] [--no-cleanup] [--update-plan-only] [--validation-errors-nonfatal] [--validation-warnings-fatal] [--disable-validations] [--inflight-validations] [--dry-run] [--run-validations] [--skip-postconfig] [--force-postconfig] [--skip-deploy-identifier] [--answers-file ANSWERS_FILE] [--disable-password-generation] [--deployed-server] [--config-download] [--no-config-download] [--config-download-only] [--output-dir OUTPUT_DIR] [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG] [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT] [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER] [-b <baremetal_deployment.yaml>] [--limit LIMIT] [--tags TAGS] [--skip-tags SKIP_TAGS] [--ansible-forks ANSIBLE_FORKS] [-y]
表55.93 コマンド引数
値 | 概要 |
---|---|
--templates [TEMPLATES] | デプロイする Heat テンプレートが格納されているディレクトリー。 |
--stack STACK | 作成または更新するスタック名 |
--timeout <TIMEOUT>, -t <TIMEOUT> | デプロイメントのタイムアウト (分単位) |
--control-scale CONTROL_SCALE | 新しいコントロールノード数 (非推奨。環境ファイルを使用して、パラメーター ControllerCount を設定します。このオプションは U リリースで削除されます)。 |
--compute-scale COMPUTE_SCALE | 新しいコンピュートノード数 (非推奨。環境ファイルを使用して、パラメーター ComputeCount を設定します。このオプションは U リリースで削除されます)。 |
--ceph-storage-scale CEPH_STORAGE_SCALE | 新しい ceph ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター CephStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--block-storage-scale BLOCK_STORAGE_SCALE | 新しい cinder ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター BlockStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--swift-storage-scale SWIFT_STORAGE_SCALE | 新しい swift ストレージノード数 (非推奨。環境ファイルを使用して、パラメーター ObjectStorageCount を設定します。このオプションは U リリースで削除されます)。 |
--control-flavor CONTROL_FLAVOR | コントロールノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudControlFlavor を設定します。このオプションは U リリースで削除されます)。 |
--compute-flavor COMPUTE_FLAVOR | コンピュートノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudComputeFlavor を設定します。このオプションは U リリースで削除されます)。 |
--ceph-storage-flavor CEPH_STORAGE_FLAVOR | ceph ストレージノードに使用する nova フレーバー。(非推奨。環境ファイルを使用して、パラメーター OvercloudCephStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--block-storage-flavor BLOCK_STORAGE_FLAVOR | cinder ストレージノードに使用する Nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudBlockStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--swift-storage-flavor SWIFT_STORAGE_FLAVOR | swift ストレージノードに使用する nova フレーバー (非推奨。環境ファイルを使用して、パラメーター OvercloudSwiftStorageFlavor を設定します。このオプションは U リリースで削除されます)。 |
--libvirt-type {kvm,qemu} | Libvirt ドメインの種別。 |
--ntp-server NTP_SERVER | オーバークラウドノードの ntp。 |
--no-proxy NO_PROXY | プロキシーされないホストのコンマ区切りリスト。 |
--overcloud-ssh-user OVERCLOUD_SSH_USER | オーバークラウドノードへの ssh アクセスのためのユーザー |
--overcloud-ssh-key OVERCLOUD_SSH_KEY | オーバークラウドノードへの ssh アクセスに使用する鍵のパス。未定義の場合、キーは自動検出されます。 |
--overcloud-ssh-network OVERCLOUD_SSH_NETWORK | オーバークラウドノードへの ssh アクセスに使用するネットワーク名。 |
--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT | ssh enable プロセスが完了するまでのタイムアウト。 |
--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT | ssh ポートがアクティブになるまで待機するタイムアウト。 |
--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE> | heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。) |
--environment-directory <HEAT ENVIRONMENT DIRECTORY> | heat stack-create または heat stack-update コマンドに自動的に追加される環境ファイルディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。 |
--roles-file ROLES_FILE, -r ROLES_FILE | ロールファイル。--templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは --templates に対する相対パスを指定できます。 |
--networks-file NETWORKS_FILE, -n NETWORKS_FILE | ネットワークファイル。--templates ディレクトリーのデフォルトの network_data.yaml を上書きします。 |
--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE | プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。 |
--no-cleanup | 一時ファイルをクリーンアップせず、場所をログとして記録します。 |
--update-plan-only | プランの更新のみを行います。実際のデプロイメントは実行しません。注記: 今後のリリースでは、別のコマンドに移行します。 |
--validation-errors-nonfatal | 検証エラーが発生しても、デプロイメントを継続できます。エラーが存在するのにデプロイメントを試みると、失敗する可能性があることに注意してください。 |
--validation-warnings-fatal | 設定の事前チェックで警告がある場合は終了します。 |
--disable-validations | 非推奨。デプロイメント前の検証を完全に無効にします。これらの検証は、組み込まれたデプロイメント前の検証です。Tripleo-validations からの外部検証を有効にするには、--run-validations フラグを使用します。これらの検証は、tripleo-validations の外部検証により実行されるようになりました。 |
--inflight-validations | デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。 |
--dry-run | 検証のみを実行しますが、変更は適用されません。 |
--run-validations | tripleo-validations プロジェクトからの外部検証を実行します。 |
--skip-postconfig | オーバークラウドのデプロイ後の設定を省略します。 |
--force-postconfig | オーバークラウドのデプロイ後の設定を強制的に行います。 |
--skip-deploy-identifier | DeployIdentifier パラメーターの一意の ID 生成を省略します。ソフトウェア設定のデプロイメント手順は、実際に設定が変更された場合にしか実行されません。このオプションの使用には注意が必要です。特定のロールをスケールアウトする時など、ソフトウェア設定を実行する必要がないことが確かな場合にのみ、このオプションを使用してください。 |
--answers-file ANSWERS_FILE | 引数とパラメーターが記載された YAML ファイルへのパス。 |
--disable-password-generation | パスワードの生成を無効にします。 |
--deployed-server | 事前にプロビジョニングされたオーバークラウドノードを使用します。アンダークラウドノードから、baremetal、compute、および image サービスの要件を削除します。これは--disable-validations とだけ使用する必要があります。 |
--config-download | config-download メカニズムを使用してデプロイメントを実行します。これは現在のデフォルトであり、この CLI のオプションは今後廃止される可能性があります。 |
--no-config-download, --stack-only | config-download ワークフローを無効にして、スタックと関連する OpenStack リソースのみを作成します。ソフトウェア設定は適用されません。 |
--config-download-only | スタックの作成/更新を無効にして、ソフトウェア設定を適用する config-download ワークフローのみを実行します。 |
--output-dir OUTPUT_DIR | config-download を使用する際、保存した出力に使用するディレクトリー。ディレクトリーは mistral ユーザーが書き込み可能でなければなりません。指定しない場合、デフォルトのサーバー側の値 (/var/lib/mistral/<execution id>) が使用されます。 |
--override-ansible-cfg OVERRIDE_ANSIBLE_CFG | Ansible 設定ファイルへのパス。ファイルの設定は、デフォルトで config-download が使用する設定を上書きします。 |
--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT | config-download の手順に使用するタイムアウト (分単位)。設定しなければ、スタック操作後の --timeout パラメーターの残り時間にかかわらず、デフォルトがその時間に設定されます。 |
--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER | デプロイメントアクションに使用する Python インタープリターへのパス。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。 |
-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml> | ベアメタルデプロイメントを記述する設定ファイル |
--limit LIMIT | config-download Ansible Playbook の実行を限定する単一ノードまたはコンマ区切りのノードリストを特定する文字列。例:--limit "compute-0,compute-1,compute-5" |
--tags TAGS | config-download ansible-playbook コマンドの実行時に使用するタグのリスト。 |
--skip-tags SKIP_TAGS | config- download ansible-playbook コマンドの実行時に省略するタグのリスト。 |
--ansible-forks ANSIBLE_FORKS | config- download ansible-playbook コマンドに使用する Ansible のフォークの数。 |
-y、--yes | アップグレード操作の前に必要な確認をスキップするには、-y または --yes を使用します。注意して使用してください。 |
55.54. overcloud upgrade run
オーバークラウドノードでメジャーアップグレード Ansible Playbook を実行します。この Playbook は、オーバークラウドでメジャーアップグレード Ansible Playbook を実行します。デフォルトでは、すべての Playbook が実行されます。つまり、upgrade_steps_playbook.yaml、続いて deploy_steps_playbook.yaml、続いて post_upgrade_steps_playbook.yaml が実行されます。overcloud upgrade prepare コマンドの完了後に、アップグレード Playbook が利用可能になります。この overcloud upgrade run コマンドは、メジャーアップグレードのワークフローの 2 番目の手順です。
使用方法
openstack overcloud upgrade run [-h] --limit LIMIT [--playbook PLAYBOOK] [--static-inventory STATIC_INVENTORY] [--ssh-user SSH_USER] [--tags TAGS] [--skip-tags SKIP_TAGS] [--stack STACK] [--no-workflow] [-y] [--ansible-forks ANSIBLE_FORKS]
表55.94 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit LIMIT | config-download Ansible Playbook の実行を限定する単一ノードまたはコンマ区切りのノードリストを特定する文字列。例:--limit "compute-0,compute-1,compute-5" |
--playbook PLAYBOOK | メジャーアップグレードに使用する Ansible Playbook。デフォルトは特殊な値 all で、すべてのアップグレード Playbook が実行されます。つまり、upgrade_steps_playbook.yaml、続いて deploy_steps_playbook.yaml、続いて post_upgrade_steps_playbook.yaml が実行されます。手動で実行したい場合は、このコマンドの連続した呼び出しで、これを各 Playbook に設定します。注記: すべてのサービスがアップグレードされ、ターゲットバージョンの設定で実行されるように、これらの Playbook のすべてを実行しなければならない場合があります。 |
--static-inventory STATIC_INVENTORY | 使用する既存の Ansible インベントリーへのパス。指定されていない場合は、~/tripleo-ansible- inventory.yaml に生成されます。 |
--ssh-user SSH_USER | 非推奨:tripleo-admin のみを ssh ユーザーとして使用する必要があります。 |
--tags TAGS | ansible-playbook に --tags として渡すタグまたはタグのコンマ区切りリストを指定する文字列。 |
--skip-tags SKIP_TAGS | ansible-playbook に --skip-tags として渡すタグまたはタグのコンマ区切りリストを指定する文字列。現在サポートされている値は validation および pre-upgrade です。特に、validationは、アップグレードに失敗した後に再実行する必要があり、一部のサービスが起動できない場合に有用です。 |
--stack STACK | Heat スタックの名前または ID (デフォルト=env: OVERCLOUD_STACK_NAME) |
--no-workflow | TripleO mistral ワークフローを介して Ansible を実行するのではなく、システムコマンド経由で ansible-playbook を直接実行します。 |
-y、--yes | アップグレード操作の前に必要な確認をスキップするには、-y または --yes を使用します。注意して使用してください。 |
--ansible-forks ANSIBLE_FORKS | config- download ansible-playbook コマンドに使用する Ansible のフォークの数。 |
第56章 policy
本章では、policy
コマンドに含まれるコマンドについて説明します。
56.1. policy create
新規ポリシーを作成します。
使用方法
openstack policy create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--type <type>] <filename>
表56.1 位置引数
値 | 概要 |
---|---|
<filename> | 新しいシリアライズされたポリシールールファイル |
表56.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--type <type> | ポリシールールファイルの新しい mime タイプ (デフォルトは application/json) |
表56.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表56.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表56.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表56.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
56.2. policy delete
ポリシーを削除します。
使用方法
openstack policy delete [-h] <policy> [<policy> ...]
表56.7 位置引数
値 | 概要 |
---|---|
<policy> | 削除するポリシー |
表56.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
56.3. policy list
ポリシーのリストを表示します。
使用方法
openstack policy list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
表56.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
表56.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表56.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表56.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表56.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
56.4. policy set
ポリシーの属性を設定します。
使用方法
openstack policy set [-h] [--type <type>] [--rules <filename>] <policy>
表56.14 位置引数
値 | 概要 |
---|---|
<policy> | 変更するポリシー |
表56.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--type <type> | ポリシールールファイルの新しい mime タイプ |
--rules <filename> | 新しいシリアライズされたポリシールールファイル |
56.5. policy show
ポリシーの詳細を表示します。
使用方法
openstack policy show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <policy>
表56.16 位置引数
値 | 概要 |
---|---|
<policy> | 表示するポリシー |
表56.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表56.18 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表56.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表56.20 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表56.21 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第57章 port
本章では、port
コマンドに含まれるコマンドについて説明します。
57.1. port create
新規ポートの作成
使用方法
openstack port create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --network <network> [--description <description>] [--device <device-id>] [--mac-address <mac-address>] [--device-owner <device-owner>] [--vnic-type <vnic-type>] [--host <host-id>] [--dns-domain dns-domain] [--dns-name <dns-name>] [--fixed-ip subnet=<subnet>,ip-address=<ip-address> | --no-fixed-ip] [--binding-profile <binding-profile>] [--enable | --disable] [--enable-uplink-status-propagation | --disable-uplink-status-propagation] [--project <project>] [--project-domain <project-domain>] [--extra-dhcp-option name=<name>[,value=<value>,ip-version={4,6}]] [--security-group <security-group> | --no-security-group] [--qos-policy <qos-policy>] [--enable-port-security | --disable-port-security] [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]] [--tag <tag> | --no-tag] <name>
表57.1 位置引数
値 | 概要 |
---|---|
<name> | このポートの名前 |
表57.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--network <network> | このポートが属するネットワーク (名前または id) |
--description <description> | このポートの説明 |
--device <device-id> | ポートデバイス ID |
--mac-address <mac-address> | このポートの MAC アドレス (管理者のみ) |
--device-owner <device-owner> | このポートのデバイス所有者。これは、ポートを使用するエンティティーです (例:network:dhcp)。 |
--vnic-type <vnic-type> | このポートの vNIC 種別 (direct | direct-physical | macvtap | normal | baremetal | virtio-forwarder、デフォルト: normal) |
--host <host-id> | ホスト <host-id>でポートを割り当てます (id のみ)。 |
--dns-domain dns-domain | dns ドメインをこのポートに設定します (ポートに dns_domain 拡張が必要) |
--dns-name <dns-name> | このポートの dns 名を設定します (dns 統合拡張が必要です)。 |
--fixed-ip subnet=<subnet>,ip-address=<ip-address> | このポートに必要な ip やサブネット (名前または id): subnet=<subnet>,ip-address=<ip-address>(複数の Fixed IP アドレスを設定する場合はオプションを繰り返し使用します) |
--no-fixed-ip | このポートには ip または subnet を設定しません。 |
--binding-profile <binding-profile> | binding:profile として渡されるカスタムデータ。データは <key>=<value> または JSON として渡されることがあります (複数の binding:profile データを設定する場合はオプションを繰り返し使用します)。 |
--enable | ポートを有効にします (デフォルト)。 |
--disable | ポートを無効にします。 |
--enable-uplink-status-propagation | アップリンクステータス伝播を有効にします。 |
--disable-uplink-status-propagation | アップリンクステータス伝播を無効にします (デフォルト)。 |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--extra-dhcp-option name=<name>[,value=<value>,ip-version={4,6}] | このポートに割り当てる追加の dhcp オプション:name=<name>[,value=<value>,ip-version={4,6}](複数の追加 DHCP オプションを設定する場合はオプションを繰り返し使用します) |
--security-group <security-group> | このポートに関連付けるセキュリティーグループ (名前または ID)(複数のセキュリティーグループを設定する場合はオプションを繰り返し使用します) |
--no-security-group | このポートとはどのセキュリティーグループも関連付けません。 |
--qos-policy <qos-policy> | このポートに qos ポリシーを割り当てます (名前または id)。 |
--enable-port-security | このポートのポートセキュリティーを有効にします (デフォルト)。 |
--disable-port-security | このポートのポートセキュリティーを無効にします。 |
--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>] | このポートに関連付けられる許可アドレスペアを追加します:ip-address=<ip-address>[,mac-address=<mac-address>](複数の許可アドレスペアを設定する場合はオプションを繰り返し使用します) |
--tag <tag> | ポートに追加されるタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--no-tag | ポートにタグを関連付けません。 |
表57.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表57.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表57.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表57.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
57.2. port delete
ポートを削除します。
使用方法
openstack port delete [-h] <port> [<port> ...]
表57.7 位置引数
値 | 概要 |
---|---|
<port> | 削除するポート (名前または ID) |
表57.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
57.3. port list
ポートのリストを表示します。
使用方法
openstack port list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--device-owner <device-owner>] [--network <network>] [--router <router> | --server <server> | --device-id <device-id>] [--mac-address <mac-address>] [--long] [--project <project>] [--project-domain <project-domain>] [--fixed-ip subnet=<subnet>,ip-address=<ip-address>,ip-substring=<ip-substring>] [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]] [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]]
表57.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--device-owner <device-owner> | 指定したデバイス所有者のポートのみをリスト表示します。これは、ポートを使用するエンティティーです (例:network:dhcp)。 |
--network <network> | このネットワークに接続されたポートのみをリスト表示します (名前または ID)。 |
--router <router> | このルーターに割り当てられたポートのみをリスト表示します (名前または ID)。 |
--server <server> | このサーバーに割り当てられているポートのみをリスト表示します (名前または ID)。 |
--device-id <device-id> | 指定されたデバイス ID を持つポートのみをリスト表示します。 |
--mac-address <mac-address> | この mac アドレスを持つポートのみをリスト表示します。 |
--long | 出力の追加フィールドをリスト表示します。 |
--project <project> | プロジェクトに従ってポートをリスト表示します (名前または ID)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--fixed-ip subnet=<subnet>,ip-address=<ip-address>,ip-substring=<ip-substring> | ポートの絞り込みに必要な ip やサブネット (名前または id): subnet=<subnet>,ip-address=<ip-address>,ip- substring=<ip-substring>(複数の Fixed IP アドレスを設定する場合はオプションを繰り返し使用します) |
--tags <tag>[,<tag>,…] | 指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたポートをリスト表示します。 |
--any-tags <tag>[,<tag>,…] | 指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたポートをリスト表示します。 |
--not-tags <tag>[,<tag>,…] | 指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたポートを除外します。 |
--not-any-tags <tag>[,<tag>,…] | 指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたポートを除外します。 |
表57.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表57.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表57.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表57.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
57.4. port set
ポートの属性を設定します。
使用方法
openstack port set [-h] [--description <description>] [--device <device-id>] [--mac-address <mac-address>] [--device-owner <device-owner>] [--vnic-type <vnic-type>] [--host <host-id>] [--dns-domain dns-domain] [--dns-name <dns-name>] [--enable | --disable] [--name <name>] [--fixed-ip subnet=<subnet>,ip-address=<ip-address>] [--no-fixed-ip] [--binding-profile <binding-profile>] [--no-binding-profile] [--qos-policy <qos-policy>] [--security-group <security-group>] [--no-security-group] [--enable-port-security | --disable-port-security] [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]] [--no-allowed-address] [--data-plane-status <status>] [--tag <tag>] [--no-tag] <port>
表57.14 位置引数
値 | 概要 |
---|---|
<port> | 変更するポート (名前または ID) |
表57.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | このポートの説明 |
--device <device-id> | ポートデバイス ID |
--mac-address <mac-address> | このポートの MAC アドレス (管理者のみ) |
--device-owner <device-owner> | このポートのデバイス所有者。これは、ポートを使用するエンティティーです (例:network:dhcp)。 |
--vnic-type <vnic-type> | このポートの vNIC 種別 (direct | direct-physical | macvtap | normal | baremetal | virtio-forwarder、デフォルト: normal) |
--host <host-id> | ホスト <host-id>でポートを割り当てます (id のみ)。 |
--dns-domain dns-domain | dns ドメインをこのポートに設定します (ポートに dns_domain 拡張が必要) |
--dns-name <dns-name> | このポートの dns 名を設定します (dns 統合拡張が必要です)。 |
--enable | ポートを有効にします。 |
--disable | ポートを無効にします。 |
--name <name> | ポート名を設定します。 |
--fixed-ip subnet=<subnet>,ip-address=<ip-address> | このポートに必要な ip やサブネット (名前または id): subnet=<subnet>,ip-address=<ip-address>(複数の Fixed IP アドレスを設定する場合はオプションを繰り返し使用します) |
--no-fixed-ip | 固定 IP アドレスの既存情報をクリアします。現在の固定 IP アドレスを上書きするには、--fixed-ip と --no-fixed-ip の両方を指定します。 |
--binding-profile <binding-profile> | binding:profile として渡されるカスタムデータ。データは <key>=<value> または JSON として渡されることがあります (複数の binding:profile データを設定する場合はオプションを繰り返し使用します)。 |
--no-binding-profile | binding:profile の既存情報をクリアします。現在の binding:profile 情報を上書きするには、--binding-profile および --no-binding-profile の両方を指定します。 |
--qos-policy <qos-policy> | このポートに qos ポリシーを割り当てます (名前または id)。 |
--security-group <security-group> | このポートに関連付けるセキュリティーグループ (名前または ID)(複数のセキュリティーグループを設定する場合はオプションを繰り返し使用します) |
--no-security-group | このポートに関連付けられた既存のセキュリティーグループをクリアします |
--enable-port-security | このポートのポートセキュリティーを有効にします。 |
--disable-port-security | このポートのポートセキュリティーを無効にします。 |
--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>] | このポートに関連付けられる許可アドレスペアを追加します:ip-address=<ip-address>[,mac-address=<mac-address>](複数の許可アドレスペアを設定する場合はオプションを繰り返し使用します) |
--no-allowed-address | このポートに関連付けられる既存の allowed-address のペアをクリアします。(現在の許可アドレスのペアを上書きするには、--allowed-address と --no- allowed-address の両方を指定します) |
--data-plane-status <status> | このポートのデータプレーンステータスを設定します (active | down)。port unset コマンドを使用してこれを None に設定解除します (データプレーンのステータス拡張機能が必要) |
--tag <tag> | ポートに追加されるタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--no-tag | ポートに関連付けられたタグをクリアします。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。 |
57.5. port show
ポートの詳細を表示します。
使用方法
openstack port show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <port>
表57.16 位置引数
値 | 概要 |
---|---|
<port> | 表示するポート (名前または ID) |
表57.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表57.18 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表57.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表57.20 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表57.21 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
57.6. port unset
ポート属性の設定を解除します。
使用方法
openstack port unset [-h] [--fixed-ip subnet=<subnet>,ip-address=<ip-address>] [--binding-profile <binding-profile-key>] [--security-group <security-group>] [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]] [--qos-policy] [--data-plane-status] [--tag <tag> | --all-tag] <port>
表57.22 位置引数
値 | 概要 |
---|---|
<port> | 変更するポート (名前または ID) |
表57.23 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--fixed-ip subnet=<subnet>,ip-address=<ip-address> | このポート (名前または id) から削除する必要のある ip やサブネット: subnet=<subnet>,ip- address=<ip-address>(複数の Fixed IP アドレスの設定を解除する場合はオプションを繰り返し使用します) |
--binding-profile <binding-profile-key> | binding:profile から削除される必要のあるキー (複数の binding:profile データの設定を解除する場合はオプションを繰り返し使用します) |
--security-group <security-group> | このポートから削除する必要のあるセキュリティーグループ (名前または ID)(複数のセキュリティーグループの設定を解除する場合はオプションを繰り返し使用します) |
--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>] | このポートから削除する必要のある許可アドレスペア:ip-address=<ip-address>[,mac- address=<mac-address>](複数の許可アドレスペアの設定を解除する場合はオプションを繰り返し使用します) |
--qos-policy | ポートに割り当てられた qos ポリシーを削除します。 |
--data-plane-status | データプレーンステータスの既存情報を消去します。 |
--tag <tag> | ポートから削除するタグ (複数のタグを削除する場合はオプションを繰り返し使用します) |
--all-tag | ポートに関連付けられたすべてのタグをクリアします |
第58章 project
本章では、project
コマンドに含まれるコマンドについて説明します。
58.1. project create
新規プロジェクトを作成します。
使用方法
openstack project create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--domain <domain>] [--parent <project>] [--description <description>] [--enable | --disable] [--property <key=value>] [--or-show] [--tag <tag>] <project-name>
表58.1 位置引数
値 | 概要 |
---|---|
<project-name> | 新規プロジェクト名 |
表58.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | プロジェクトを所有するドメイン (名前または ID) |
--parent <project> | プロジェクトの親 (名前または ID) |
--description <description> | プロジェクトの説明 |
--enable | プロジェクトを有効にします。 |
--disable | プロジェクトを無効にします。 |
--property <key=value> | <name> に属性を追加します (複数の属性を設定する場合はオプションを繰り返し使用します) |
--or-show | 既存のプロジェクトを返します。 |
--tag <tag> | プロジェクトに追加されるタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
表58.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表58.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表58.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表58.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
58.2. project delete
プロジェクトを削除します。
使用方法
openstack project delete [-h] [--domain <domain>] <project> [<project> ...]
表58.7 位置引数
値 | 概要 |
---|---|
<project> | 削除するプロジェクト (名前または ID) |
表58.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | <project> を所有するドメイン (名前または ID) |
58.3. project list
プロジェクトをリスト表示します。
使用方法
openstack project list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--domain <domain>] [--user <user>] [--my-projects] [--long] [--sort <key>[:<direction>]] [--tags <tag>[,<tag>,...]] [--tags-any <tag>[,<tag>,...]] [--not-tags <tag>[,<tag>,...]] [--not-tags-any <tag>[,<tag>,...]]
表58.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | <domain>でプロジェクトをフィルターします (名前または id)。 |
--user <user> | <user>でプロジェクトをフィルターします (名前または id)。 |
--my-projects | 認証されたユーザーのプロジェクトをリスト表示します。他のフィルターよりも優先されます。 |
--long | 出力の追加フィールドをリスト表示します。 |
--sort <key>[:<direction>] | 選択した鍵と方向 (asc または desc) で出力をソートします (デフォルト:asc)。複数のキーと方向を指定する場合はこのオプションを繰り返し使用します。 |
--tags <tag>[,<tag>,…] | 指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたプロジェクトをリスト表示します。 |
--tags-any <tag>[,<tag>,…] | 指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたプロジェクトをリスト表示します。 |
--not-tags <tag>[,<tag>,…] | 指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたプロジェクトを除外します。 |
--not-tags-any <tag>[,<tag>,…] | 指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたプロジェクトを除外します。 |
表58.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表58.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表58.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表58.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
58.4. project purge
プロジェクトに関連付けられたリソースをクリーンアップします。
使用方法
openstack project purge [-h] [--dry-run] [--keep-project] (--auth-project | --project <project>) [--project-domain <project-domain>]
表58.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--dry-run | プロジェクトのリソースをリスト表示します。 |
--keep-project | プロジェクトのリソースをクリーンアップしますが、プロジェクトは削除しません。 |
--auth-project | 認証に使用するプロジェクトのリソースを削除します。 |
--project <project> | クリーンアップするプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
58.5. project set
プロジェクトの属性を設定します。
使用方法
openstack project set [-h] [--name <name>] [--domain <domain>] [--description <description>] [--enable | --disable] [--property <key=value>] [--tag <tag>] [--clear-tags] [--remove-tag <tag>] <project>
表58.15 位置引数
値 | 概要 |
---|---|
<project> | 変更するプロジェクト (名前または ID) |
表58.16 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | プロジェクト名を設定します。 |
--domain <domain> | <project> を所有するドメイン (名前または ID) |
--description <description> | プロジェクトの説明を設定します。 |
--enable | プロジェクトを有効にします。 |
--disable | プロジェクトを無効にします。 |
--property <key=value> | <project> に属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します)。 |
--tag <tag> | プロジェクトに追加されるタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--clear-tags | プロジェクトに関連付けられたタグをクリアします。現在のタグを上書きするには、--tag と --clear-tags の両方を指定します。 |
--remove-tag <tag> | プロジェクトから削除するタグ (複数のタグを削除する場合はオプションを繰り返し使用します) |
58.6. project show
プロジェクトの詳細を表示します。
使用方法
openstack project show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--domain <domain>] [--parents] [--children] <project>
表58.17 位置引数
値 | 概要 |
---|---|
<project> | 表示するプロジェクト (名前または ID) |
表58.18 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | <project> を所有するドメイン (名前または ID) |
--parents | プロジェクトの親をリストとして表示します。 |
--children | プロジェクトのサブツリー (子) をリストとして表示します。 |
表58.19 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表58.20 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表58.21 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表58.22 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第59章 ptr
本章では、ptr
コマンドに含まれるコマンドについて説明します。
59.1. ptr record list
floatingip ptr レコードをリスト表示します。
使用方法
openstack ptr record list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
表59.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表59.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表59.3 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表59.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表59.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
59.2. ptr record set
floatingip ptr レコードを設定します。
使用方法
openstack ptr record set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description DESCRIPTION | --no-description] [--ttl TTL | --no-ttl] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] floatingip_id ptrdname
表59.6 位置引数
値 | 概要 |
---|---|
floatingip_id | region:floatingip_id 形式の Floating IP id |
ptrdname | Ptrd 名 |
表59.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description DESCRIPTION | 説明 |
--no-description—ttl TTL | Ttl |
--no-ttl—all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表59.8 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表59.9 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表59.10 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表59.11 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
59.3. ptr record show
floatingip ptr レコードの詳細を表示します。
使用方法
openstack ptr record show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] floatingip_id
表59.12 位置引数
値 | 概要 |
---|---|
floatingip_id | region:floatingip_id 形式の Floating IP id |
表59.13 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表59.14 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表59.15 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表59.16 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表59.17 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
59.4. ptr record unset
floatingip ptr レコードの設定を解除します。
使用方法
openstack ptr record unset [-h] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] floatingip_id
表59.18 位置引数
値 | 概要 |
---|---|
floatingip_id | region:floatingip_id 形式の Floating IP id |
表59.19 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
第60章 quota
本章では、quota
コマンドに含まれるコマンドについて説明します。
60.1. quota list
デフォルト以外のクォータ値を持つすべてのプロジェクトのクォータをリスト表示します。または、要求されるプロジェクトの詳細なクォータ情報をリスト表示します。
使用方法
openstack quota list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--project <project>] [--detail] (--compute | --volume | --network)
表60.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | このプロジェクト <project>のクォータをリスト表示します (名前または id)。 |
--detail | クォータの使用状況についての詳細を表示します。 |
--compute | コンピュートクォータをリスト表示します。 |
--volume | ボリュームクォータをリスト表示します。 |
--network | ネットワーククォータをリスト表示します。 |
表60.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表60.3 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表60.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表60.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
60.2. quota set
プロジェクトまたはクラスのクォータを設定します。
使用方法
openstack quota set [-h] [--class] [--cores <cores>] [--fixed-ips <fixed-ips>] [--injected-file-size <injected-file-size>] [--injected-path-size <injected-path-size>] [--injected-files <injected-files>] [--instances <instances>] [--key-pairs <key-pairs>] [--properties <properties>] [--ram <ram>] [--server-groups <server-groups>] [--server-group-members <server-group-members>] [--backups <backups>] [--backup-gigabytes <backup-gigabytes>] [--gigabytes <gigabytes>] [--per-volume-gigabytes <per-volume-gigabytes>] [--snapshots <snapshots>] [--volumes <volumes>] [--floating-ips <floating-ips>] [--secgroup-rules <secgroup-rules>] [--secgroups <secgroups>] [--networks <networks>] [--subnets <subnets>] [--ports <ports>] [--routers <routers>] [--rbac-policies <rbac-policies>] [--subnetpools <subnetpools>] [--volume-type <volume-type>] <project/class>
表60.6 位置引数
値 | 概要 |
---|---|
<project/class> | このプロジェクトまたはクラスのクォータを設定します (名前/id)。 |
表60.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--class | <class> のクォータを設定します。 |
--cores <cores> | cores クォータの新しい値 |
--fixed-ips <fixed-ips> | fixed-ips クォータの新しい値 |
--injected-file-size <injected-file-size> | injected-file-size クォータの新しい値 |
--injected-path-size <injected-path-size> | injected-path-size クォータの新しい値 |
--injected-files <injected-files> | injected-files クォータの新しい値 |
--instances <instances> | instances クォータの新しい値 |
--key-pairs <key-pairs> | key-pairs クォータの新しい値 |
--properties <properties> | properties クォータの新しい値 |
--ram <ram> | ram クォータの新しい値 |
--server-groups <server-groups> | server-groups クォータの新しい値 |
--server-group-members <server-group-members> | server-group-members クォータの新しい値 |
--backups <backups> | backups クォータの新しい値 |
--backup-gigabytes <backup-gigabytes> | backup-gigabytes クォータの新しい値 |
--gigabytes <gigabytes> | gigabytes クォータの新しい値 |
--per-volume-gigabytes <per-volume-gigabytes> | per-volume-gigabytes クォータの新しい値 |
--snapshots <snapshots> | snapshots クォータの新しい値 |
--volumes <volumes> | volumes クォータの新しい値 |
--floating-ips <floating-ips> | floating-ips クォータの新しい値 |
--secgroup-rules <secgroup-rules> | secgroup-rules クォータの新しい値 |
--secgroups <secgroups> | secgroups クォータの新しい値 |
--networks <networks> | networks クォータの新しい値 |
--subnets <subnets> | subnets クォータの新しい値 |
--ports <ports> | ports クォータの新しい値 |
--routers <routers> | routers クォータの新しい値 |
--rbac-policies <rbac-policies> | rbac-policies クォータの新しい値 |
--subnetpools <subnetpools> | subnetpools クォータの新しい値 |
--volume-type <volume-type> | 特定の <volume-type> のクォータを設定します。 |
60.3. quota show
プロジェクトまたはクラスのクォータを表示します。指定されたクォータクラスの ''server-groups'' および ''server-group-members'' の出力を表示するには、''--os-compute-api-version 2.50'' 以上を指定します。
使用方法
openstack quota show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--class | --default] [<project/class>]
表60.8 位置引数
値 | 概要 |
---|---|
<project/class> | このプロジェクトまたはクラスのクォータを表示します (名前または id)。 |
表60.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--class | <class> のクォータを表示します。 |
--default | <project> のデフォルトクォータを表示します。 |
表60.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表60.11 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表60.12 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表60.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第61章 recordset
本章では、recordset
コマンドに含まれるコマンドについて説明します。
61.1. recordset create
新規レコードセットを作成します
使用方法
openstack recordset create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --record RECORD --type TYPE [--ttl TTL] [--description DESCRIPTION] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] zone_id name
表61.1 位置引数
値 | 概要 |
---|---|
zone_id | ゾーンの id |
name | レコードセット名 |
表61.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--record RECORD | レコードセットレコード (必要な場合は繰り返します) |
--type TYPE | レコードセットの種別 |
--ttl TTL | 存続期間 (秒) |
--description DESCRIPTION | 説明 |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表61.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表61.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表61.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表61.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
61.2. recordset delete
レコードセットを削除します。
使用方法
openstack recordset delete [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] zone_id id
表61.7 位置引数
値 | 概要 |
---|---|
zone_id | ゾーンの id |
id | レコードセットの id |
表61.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表61.9 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表61.10 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表61.11 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表61.12 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
61.3. recordset list
レコードセットをリスト表示します。
使用方法
openstack recordset list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name NAME] [--type TYPE] [--data DATA] [--ttl TTL] [--description DESCRIPTION] [--status STATUS] [--action ACTION] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] zone_id
表61.13 位置引数
値 | 概要 |
---|---|
zone_id | ゾーンの id。(全レコードセットをリスト表示するには、all を指定します) |
表61.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name NAME | レコードセット名 |
--type TYPE | レコードセットの種別 |
--data DATA | レコードセットレコードデータ |
--ttl TTL | 存続期間 (秒) |
--description DESCRIPTION | 説明 |
--status STATUS | レコードセットステータス |
--action ACTION | レコードセットアクション |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表61.15 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表61.16 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表61.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表61.18 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
61.4. recordset set
レコードセットの属性を設定します。
使用方法
openstack recordset set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--record RECORD] [--description DESCRIPTION | --no-description] [--ttl TTL | --no-ttl] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] zone_id id
表61.19 位置引数
値 | 概要 |
---|---|
zone_id | ゾーンの id |
id | レコードセットの id |
表61.20 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--record RECORD | レコードセットレコード (必要な場合は繰り返します) |
--description DESCRIPTION | 説明 |
--no-description—ttl TTL | Ttl |
--no-ttl—all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表61.21 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表61.22 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表61.23 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表61.24 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
61.5. recordset show
レコードセットの詳細を表示します。
使用方法
openstack recordset show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] zone_id id
表61.25 位置引数
値 | 概要 |
---|---|
zone_id | ゾーンの id |
id | レコードセットの id |
表61.26 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表61.27 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表61.28 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表61.29 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表61.30 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第62章 region
本章では、region
コマンドに含まれるコマンドについて説明します。
62.1. region create
新規リージョンを作成します。
使用方法
openstack region create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--parent-region <region-id>] [--description <description>] <region-id>
表62.1 位置引数
値 | 概要 |
---|---|
<region-id> | 新規リージョン ID |
表62.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--parent-region <region-id> | 親リージョン ID |
--description <description> | 新規リージョンの説明 |
表62.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表62.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表62.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表62.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
62.2. region delete
リージョンを削除します。
使用方法
openstack region delete [-h] <region-id> [<region-id> ...]
表62.7 位置引数
値 | 概要 |
---|---|
<region-id> | 削除するリージョン ID |
表62.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
62.3. region list
リージョンをリスト表示します。
使用方法
openstack region list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--parent-region <region-id>]
表62.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--parent-region <region-id> | 親リージョン ID でフィルタリングします |
表62.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表62.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表62.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表62.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
62.4. region set
リージョンの属性を設定します。
使用方法
openstack region set [-h] [--parent-region <region-id>] [--description <description>] <region-id>
表62.14 位置引数
値 | 概要 |
---|---|
<region-id> | 変更するリージョン |
表62.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--parent-region <region-id> | 新規親リージョン ID |
--description <description> | 新規リージョンの説明 |
62.5. region show
リージョンの詳細を表示します。
使用方法
openstack region show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <region-id>
表62.16 位置引数
値 | 概要 |
---|---|
<region-id> | 表示するリージョン |
表62.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表62.18 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表62.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表62.20 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表62.21 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第63章 registered
本章では、registered
コマンドに含まれるコマンドについて説明します。
63.1. registered limit create
登録された制限を作成します。
使用方法
openstack registered limit create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--region <region>] --service <service> --default-limit <default-limit> <resource-name>
表63.1 位置引数
値 | 概要 |
---|---|
<resource-name> | 制限するリソースの名前 |
表63.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | 登録された制限の説明 |
--region <region> | 影響する登録された制限のリージョン |
--service <service> | 制限するリソースに対応するサービス (必須) |
--default-limit <default-limit> | 想定するリソースのデフォルトの制限 (必須) |
表63.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表63.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表63.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表63.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
63.2. registered limit delete
登録された制限を削除します。
使用方法
openstack registered limit delete [-h] <registered-limit-id> [<registered-limit-id> ...]
表63.7 位置引数
値 | 概要 |
---|---|
<registered-limit-id> | 削除する登録された制限 (id) |
表63.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
63.3. registered limit list
登録された制限をリスト表示します。
使用方法
openstack registered limit list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--service <service>] [--resource-name <resource-name>] [--region <region>]
表63.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--service <service> | 制限するリソースに関するサービス |
--resource-name <resource-name> | 制限するリソースの名前 |
--region <region> | 影響する制限のリージョン。 |
表63.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表63.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表63.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表63.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
63.4. registered limit set
登録された制限に関する情報を更新します。
使用方法
openstack registered limit set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--service <service>] [--resource-name <resource-name>] [--default-limit <default-limit>] [--description <description>] [--region <region>] <registered-limit-id>
表63.14 位置引数
値 | 概要 |
---|---|
<registered-limit-id> | 更新する登録された制限 (id) |
表63.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--service <service> | 制限するリソースに対応する更新するサービス--service、--resource-name、または --region のいずれかは既存の値とは異なる値である必要があります。そうでないと、重複したエントリーになります。 |
--resource-name <resource-name> | 制限するリソースに対応する更新するリソース--service、--resource-name、または --region のいずれかは既存の値とは異なる値である必要があります。そうでないと、重複したエントリーになります。 |
--default-limit <default-limit> | 想定するリソースのデフォルトの制限 |
--description <description> | 登録された制限に関する更新する説明 |
--region <region> | 影響する登録された制限のリージョン。--service、--resource-name、または --region のいずれかは既存の値とは異なる値である必要があります。そうでないと、重複したエントリーになります。 |
表63.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表63.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表63.18 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表63.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
63.5. registered limit show
登録された制限の詳細を表示します。
使用方法
openstack registered limit show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <registered-limit-id>
表63.20 位置引数
値 | 概要 |
---|---|
<registered-limit-id> | 表示する登録された制限 (id) |
表63.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表63.22 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表63.23 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表63.24 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表63.25 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第64章 request
本章では、request
コマンドに含まれるコマンドについて説明します。
64.1. request token authorize
リクエストトークンを承認します。
使用方法
openstack request token authorize [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --request-key <request-key> --role <role>
表64.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--request-key <request-key> | 承認するリクエストトークン (id のみ)(必須) |
--role <role> | 承認するロール (名前または ID) (複数の値を設定する場合はオプションを繰り返し使用します)(必須) |
表64.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表64.3 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表64.4 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表64.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
64.2. request token create
リクエストトークンを作成します。
使用方法
openstack request token create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --consumer-key <consumer-key> --consumer-secret <consumer-secret> --project <project> [--domain <domain>]
表64.6 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--consumer-key <consumer-key> | コンシューマーキー (必須) |
--consumer-secret <consumer-secret> | コンシューマーシークレット (必須) |
--project <project> | コンシューマーがアクセスするプロジェクト (名前または ID)(必須) |
--domain <domain> | <project> を所有するドメイン (名前または ID) |
表64.7 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表64.8 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表64.9 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表64.10 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第65章 resource
本章では、resource
コマンドに含まれるコマンドについて説明します。
65.1. resource member create
別のテナントとリソースを共有します。
使用方法
openstack resource member create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] resource_id resource_type member_id
表65.1 位置引数
値 | 概要 |
---|---|
resource_id | 共有されるリソース ID。 |
resource_type | リソースタイプ。 |
member_id | リソースを共有するプロジェクト ID。 |
表65.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表65.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表65.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表65.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表65.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
65.2. resource member delete
リソース共有の関係を削除します。
使用方法
openstack resource member delete [-h] resource resource_type member_id
表65.7 位置引数
値 | 概要 |
---|---|
resource | 共有されるリソース ID。 |
resource_type | リソースタイプ。 |
member_id | リソースを共有するプロジェクト ID。 |
表65.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
65.3. resource member list
すべてのメンバーをリスト表示します。
使用方法
openstack resource member list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS] resource_id resource_type
表65.9 位置引数
値 | 概要 |
---|---|
resource_id | 共有されるリソース ID。 |
resource_type | リソースタイプ。 |
表65.10 コマンド引数
値 | 概要 |
---|---|
-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 | フィルター。繰り返し使用できます。 |
表65.11 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表65.12 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表65.13 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表65.14 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
65.4. resource member show
特定のメンバーの情報を表示します。
使用方法
openstack resource member show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [-m MEMBER_ID] resource resource_type
表65.15 位置引数
値 | 概要 |
---|---|
resource | 共有されるリソース ID。 |
resource_type | リソースタイプ。 |
表65.16 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-m MEMBER_ID, --member-id MEMBER_ID | リソースを共有するプロジェクト ID。リソースメンバーの場合には、このパラメーターを指定する必要はありません。 |
表65.17 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表65.18 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表65.19 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表65.20 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
65.5. resource member update
リソース共有のステータスを更新します。
使用方法
openstack resource member update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [-m MEMBER_ID] [-s {pending,accepted,rejected}] resource_id resource_type
表65.21 位置引数
値 | 概要 |
---|---|
resource_id | 共有されるリソース ID。 |
resource_type | リソースタイプ。 |
表65.22 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-m MEMBER_ID, --member-id MEMBER_ID | リソースを共有するプロジェクト ID。リソースメンバーの場合には、このパラメーターを指定する必要はありません。 |
-s {pending,accepted,rejected}, --status {pending,accepted,rejected} | 共有のステータス。 |
表65.23 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表65.24 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表65.25 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表65.26 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第66章 role
本章では、role
コマンドに含まれるコマンドについて説明します。
66.1. role add
システム、ドメイン、またはプロジェクトのユーザーまたはグループにロール割り当てを追加します。
使用方法
openstack role add [-h] [--system <system> | --domain <domain> | --project <project>] [--user <user> | --group <group>] [--group-domain <group-domain>] [--project-domain <project-domain>] [--user-domain <user-domain>] [--inherited] [--role-domain <role-domain>] <role>
表66.1 位置引数
値 | 概要 |
---|---|
<role> | <user>に追加するロール (名前または ID) |
表66.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--system <system> | <system>(すべて) を含めます。 |
--domain <domain> | <domain>を含めます (名前または ID)。 |
--project <project> | <project>を含めます (名前または ID)。 |
--user <user> | <user>を含めます (名前または ID)。 |
--group=GROUP | <group>を含めます (名前または ID)。 |
--group-domain <group-domain> | グループが所属するドメイン (名前または ID)。グループ名の競合が発生した場合に、使用できます。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--user-domain <user-domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
--inherited | ロールの付与がサブプロジェクトに継承できるかどうかを指定します。 |
--role-domain <role-domain> | ロールが属するドメイン (名前または ID)。これは、ドメイン固有のロール名が使用される場合に指定する必要があります。 |
66.2. role assignment list
ロールの割り当てをリスト表示します。
使用方法
openstack role assignment list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--effective] [--role <role>] [--role-domain <role-domain>] [--names] [--user <user>] [--user-domain <user-domain>] [--group <group>] [--group-domain <group-domain>] [--domain <domain> | --project <project> | --system <system>] [--project-domain <project-domain>] [--inherited] [--auth-user] [--auth-project]
表66.3 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--effective | 有効なロール割り当てのみを返します。 |
--role <role> | フィルターするロール (名前または ID) |
--role-domain <role-domain> | ロールが属するドメイン (名前または ID)。これは、ドメイン固有のロール名が使用される場合に指定する必要があります。 |
--names | id ではなく名前を表示します。 |
--user <user> | フィルターするユーザー (名前または ID) |
--user-domain <user-domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
--group=GROUP | フィルターするグループ (名前または ID) |
--group-domain <group-domain> | グループが所属するドメイン (名前または ID)。グループ名の競合が発生した場合に、使用できます。 |
--domain <domain> | フィルターするドメイン (名前または ID) |
--project <project> | フィルターするプロジェクト (名前または ID) |
--system <system> | システムロールの割り当てに基づいてフィルタリングします |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--inherited | ロールの付与がサブプロジェクトに継承できるかどうかを指定します。 |
--auth-user | 認証済みユーザーの割り当てのみをリスト表示します。 |
--auth-project | 認証されたユーザーのトークンがスコープ設定されているプロジェクトの割り当てのみをリスト表示します。 |
表66.4 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表66.5 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表66.6 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表66.7 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
66.3. role create
新規ロールを作成します。
使用方法
openstack role create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--domain <domain>] [--or-show] <role-name>
表66.8 位置引数
値 | 概要 |
---|---|
<role-name> | 新しいロール名 |
表66.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | ロールが属するドメイン (名前または id) |
--or-show | 既存のロールを返します。 |
表66.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表66.11 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表66.12 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表66.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
66.4. role delete
ロールを削除します。
使用方法
openstack role delete [-h] [--domain <domain>] <role> [<role> ...]
表66.14 位置引数
値 | 概要 |
---|---|
<role> | 削除するロール (名前または ID) |
表66.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | ロールが属するドメイン (名前または id) |
66.5. role list
ロールをリスト表示します。
使用方法
openstack role list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--domain <domain>]
表66.16 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | <domain>を含めます (名前または ID)。 |
表66.17 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表66.18 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表66.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表66.20 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
66.6. role remove
システム/ドメイン/プロジェクトからロールの割り当て (ユーザー/グループ) を削除します。
使用方法
openstack role remove [-h] [--system <system> | --domain <domain> | --project <project>] [--user <user> | --group <group>] [--group-domain <group-domain>] [--project-domain <project-domain>] [--user-domain <user-domain>] [--inherited] [--role-domain <role-domain>] <role>
表66.21 位置引数
値 | 概要 |
---|---|
<role> | 削除するロール (名前または ID) |
表66.22 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--system <system> | <system>(すべて) を含めます。 |
--domain <domain> | <domain>を含めます (名前または ID)。 |
--project <project> | <project>を含めます (名前または ID)。 |
--user <user> | <user>を含めます (名前または ID)。 |
--group=GROUP | <group>を含めます (名前または ID)。 |
--group-domain <group-domain> | グループが所属するドメイン (名前または ID)。グループ名の競合が発生した場合に、使用できます。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--user-domain <user-domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
--inherited | ロールの付与がサブプロジェクトに継承できるかどうかを指定します。 |
--role-domain <role-domain> | ロールが属するドメイン (名前または ID)。これは、ドメイン固有のロール名が使用される場合に指定する必要があります。 |
66.7. role set
ロールの属性を設定します。
使用方法
openstack role set [-h] [--domain <domain>] [--name <name>] <role>
表66.23 位置引数
値 | 概要 |
---|---|
<role> | 変更するロール (名前または ID) |
表66.24 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | ロールが属するドメイン (名前または id) |
--name <name> | ロール名を設定します。 |
66.8. role show
ロールの詳細を表示します。
使用方法
openstack role show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--domain <domain>] <role>
表66.25 位置引数
値 | 概要 |
---|---|
<role> | 表示するロール (名前または ID) |
表66.26 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | ロールが属するドメイン (名前または id) |
表66.27 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表66.28 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表66.29 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表66.30 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第67章 ルーター
本章では、router
コマンドに含まれるコマンドについて説明します。
67.1. router add port
ルーターにポートを追加します。
使用方法
openstack router add port [-h] <router> <port>
表67.1 位置引数
値 | 概要 |
---|---|
<router> | ポートが追加されるルーター (名前または ID) |
<port> | 追加するポート (名前または ID) |
表67.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
67.2. router add subnet
ルーターにサブネットを追加します。
使用方法
openstack router add subnet [-h] <router> <subnet>
表67.3 位置引数
値 | 概要 |
---|---|
<router> | サブネットを追加するルーター (名前または ID) |
<subnet> | 追加するサブネット (名前または ID) |
表67.4 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
67.3. router create
新規ルーターを作成します。
使用方法
openstack router create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--enable | --disable] [--distributed | --centralized] [--ha | --no-ha] [--description <description>] [--project <project>] [--project-domain <project-domain>] [--availability-zone-hint <availability-zone>] [--tag <tag> | --no-tag] <name>
表67.5 位置引数
値 | 概要 |
---|---|
<name> | 新しいルーター名 |
表67.6 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--enable | ルーターを有効にします (デフォルト)。 |
--disable | ルーターを無効にします。 |
--distributed | 分散ルーターを作成します。 |
--centralized | 集中ルーターを作成します。 |
--ha | 高可用性ルーターを作成します。 |
--no-ha | レガシーのルーターを作成します。 |
--description <description> | ルーターの説明を設定します。 |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--availability-zone-hint <availability-zone> | このルーターを作成するアベイラビリティーゾーン (Router Availability Zone 拡張機能が必要、複数のアベイラビリティーゾーンに設定するには、オプションを繰り返し使用します) |
--tag <tag> | ルーターに追加するタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--no-tag | ルーターにタグを関連付けません。 |
表67.7 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表67.8 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表67.9 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表67.10 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
67.4. router delete
ルーターを削除します。
使用方法
openstack router delete [-h] <router> [<router> ...]
表67.11 位置引数
値 | 概要 |
---|---|
<router> | 削除するルーター (名前または ID) |
表67.12 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
67.5. router list
ルーターをリスト表示します。
使用方法
openstack router list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name <name>] [--enable | --disable] [--long] [--project <project>] [--project-domain <project-domain>] [--agent <agent-id>] [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]] [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]]
表67.13 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 名前に従ってルーターをリスト表示します。 |
--enable | 有効なルーターをリスト表示します。 |
--disable | 無効なルーターをリスト表示します。 |
--long | 出力の追加フィールドをリスト表示します。 |
--project <project> | プロジェクトに従ってルーターをリスト表示します (名前または ID)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--agent <agent-id> | エージェントがホストする ルーターをリスト表示します (ID のみ) |
--tags <tag>[,<tag>,…] | 指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたルーターをリスト表示します。 |
--any-tags <tag>[,<tag>,…] | 指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたルーターをリスト表示します。 |
--not-tags <tag>[,<tag>,…] | 指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたルーターを除外します。 |
--not-any-tags <tag>[,<tag>,…] | 指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたルーターを除外します。 |
表67.14 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表67.15 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表67.16 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表67.17 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
67.6. router remove port
ルーターからポートを削除します。
使用方法
openstack router remove port [-h] <router> <port>
表67.18 位置引数
値 | 概要 |
---|---|
<router> | ポートを削除するルーター (名前または ID) |
<port> | 削除および削除されるポート (名前または ID) |
表67.19 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
67.7. router remove subnet
ルーターからサブネットを削除します。
使用方法
openstack router remove subnet [-h] <router> <subnet>
表67.20 位置引数
値 | 概要 |
---|---|
<router> | サブネットが削除されるルーター (名前または ID) |
<subnet> | 削除するサブネット (名前または ID) |
表67.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
67.8. router set
ルーターの属性を設定します。
使用方法
openstack router set [-h] [--name <name>] [--description <description>] [--enable | --disable] [--distributed | --centralized] [--route destination=<subnet>,gateway=<ip-address>] [--no-route] [--ha | --no-ha] [--external-gateway <network>] [--fixed-ip subnet=<subnet>,ip-address=<ip-address>] [--enable-snat | --disable-snat] [--qos-policy <qos-policy> | --no-qos-policy] [--tag <tag>] [--no-tag] <router>
表67.22 位置引数
値 | 概要 |
---|---|
<router> | 変更するルーター (名前または ID) |
表67.23 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | ルーター名を設定します。 |
--description <description> | ルーターの説明を設定します。 |
--enable | ルーターを有効にします。 |
--disable | ルーターを無効にします。 |
--distributed | ルーターを分散モードに設定します (無効なルーターのみ)。 |
--centralized | ルーターを集中モードに設定します (無効なルーターのみ)。 |
--route destination=<subnet>,gateway=<ip-address> | ルーターの宛先に関連付けられたルート: 宛先サブネット (CIDR 表記) ゲートウェイ:nexthop IP アドレス (複数のルートを設定する場合はオプションを繰り返し使用します) |
--no-route | ルーターに関連付けられたルートを消去します。ルートの現在の値を上書きするには、--route と --no-route の両方を指定します。 |
--ha | ルーターを高可用性として設定します (無効なルーターのみ)。 |
--no-ha | ルーターの高可用性属性をクリアします (無効化されたルーターのみ) |
--external-gateway <network> | ルーターのゲートウェイとして使用する外部ネットワーク (名前または ID) |
--fixed-ip subnet=<subnet>,ip-address=<ip-address> | 外部ゲートウェイの必要な ip やサブネット (名前または id): subnet=<subnet>,ip-address=<ip-address>(複数の Fixed IP アドレスを設定する場合はオプションを繰り返し使用します) |
--enable-snat | 外部ゲートウェイでソース nat を有効にします。 |
--disable-snat | 外部ゲートウェイでソース nat を無効にします。 |
--qos-policy <qos-policy> | qos ポリシーをルーターゲートウェイ IP に割り当てます。 |
--no-qos-policy | ルーターゲートウェイ ip から qos ポリシーを削除します。 |
--tag <tag> | ルーターに追加するタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--no-tag | ルーターに関連付けられたタグをクリアします。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。 |
67.9. router show
ルーターの詳細を表示します。
使用方法
openstack router show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <router>
表67.24 位置引数
値 | 概要 |
---|---|
<router> | 表示するルーター (名前または ID) |
表67.25 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表67.26 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表67.27 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表67.28 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表67.29 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
67.10. router unset
ルーター属性の設定を解除します。
使用方法
openstack router unset [-h] [--route destination=<subnet>,gateway=<ip-address>] [--external-gateway] [--qos-policy] [--tag <tag> | --all-tag] <router>
表67.30 位置引数
値 | 概要 |
---|---|
<router> | 変更するルーター (名前または ID) |
表67.31 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--route destination=<subnet>,gateway=<ip-address> | ルーターの宛先から削除されるルート: 宛先サブネット (CIDR 表記) ゲートウェイ:nexthop IP アドレス (複数ルートの設定を解除する場合はオプションを繰り返し使用します) |
--external-gateway | ルーターから外部ゲートウェイ情報を削除します。 |
--qos-policy | ルーターゲートウェイ ip から qos ポリシーを削除します。 |
--tag <tag> | ルーターから削除するタグ (複数のタグを削除する場合はオプションを繰り返し使用します) |
--all-tag | ルーターに関連付けられたすべてのタグをクリアします |
第68章 secret
本章では、secret
コマンドに含まれるコマンドについて説明します。
68.1. secret container create
Barbican にコンテナーを保存します。
使用方法
openstack secret container create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name NAME] [--type TYPE] [--secret SECRET]
表68.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name NAME, -n NAME | 人間に分かりやすい名前。 |
--type TYPE | 作成するコンテナーの種別 (デフォルト:generic)。 |
--secret SECRET, -s SECRET | コンテナーに保存する 1 つのシークレット (複数回設定できます)。例:--secret "private_key=https://url.test/v1/secrets/1-2-3-4" |
表68.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表68.3 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表68.4 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表68.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
68.2. secret container delete
href を指定してコンテナーを削除します。
使用方法
openstack secret container delete [-h] URI
表68.6 位置引数
値 | 概要 |
---|---|
URI | コンテナーの uri 参照 |
表68.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
68.3. secret container get
URI を指定してコンテナーを取得します。
使用方法
openstack secret container get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] URI
表68.8 位置引数
値 | 概要 |
---|---|
URI | コンテナーの uri 参照。 |
表68.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表68.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表68.11 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表68.12 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表68.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
68.4. secret container list
コンテナーをリスト表示します。
使用方法
openstack secret container list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--limit LIMIT] [--offset OFFSET] [--name NAME] [--type TYPE]
表68.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit LIMIT, -l LIMIT | ページごとに表示する項目数に制限を指定します (デフォルト:10、最大: 100)。 |
--offset OFFSET, -o OFFSET | ページのオフセットを指定します (デフォルト:0)。 |
--name NAME, -n NAME | コンテナー名を指定します (デフォルト:none)。 |
--type TYPE、-t TYPE | リストのタイプフィルターを指定します (デフォルト:none)。 |
表68.15 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表68.16 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表68.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表68.18 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
68.5. secret delete
URI を指定してシークレットを削除します。
使用方法
openstack secret delete [-h] URI
表68.19 位置引数
値 | 概要 |
---|---|
URI | シークレットの uri 参照 |
表68.20 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
68.6. secret get
URI を指定してシークレットを取得します。
使用方法
openstack secret get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--decrypt | --payload | --file <filename>] [--payload_content_type PAYLOAD_CONTENT_TYPE] URI
表68.21 位置引数
値 | 概要 |
---|---|
URI | シークレットの uri 参照。 |
表68.22 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--decrypt, -d | 指定されている場合、暗号化されていないシークレットデータを取得します。 |
--payload, -p | 指定されている場合、暗号化されていないシークレットデータを取得します。 |
--file <filename>、-F <filename> | 指定した場合は、指定したファイル名で新しいファイルにペイロードを保存します。 |
--payload_content_type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE | 復号化されたシークレットのコンテンツ種別 (デフォルト:text/plain)。 |
表68.23 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表68.24 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表68.25 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表68.26 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
68.7. secret list
シークレットをリスト表示します。
使用方法
openstack secret list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--limit LIMIT] [--offset OFFSET] [--name NAME] [--algorithm ALGORITHM] [--bit-length BIT_LENGTH] [--mode MODE] [--secret-type SECRET_TYPE]
表68.27 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit LIMIT, -l LIMIT | ページごとに表示する項目数に制限を指定します (デフォルト:10、最大: 100)。 |
--offset OFFSET, -o OFFSET | ページのオフセットを指定します (デフォルト:0)。 |
--name NAME, -n NAME | シークレット名を指定します (デフォルト: none) |
--algorithm ALGORITHM、-a ALGORITHM | リストのアルゴリズムフィルター (デフォルト: none) |
--bit-length BIT_LENGTH, -b BIT_LENGTH | リストのビット長フィルター (デフォルト:0)。 |
--mode MODE、-m MODE | リストのアルゴリズムモードフィルター (デフォルト:None)。 |
--secret-type SECRET_TYPE, -s SECRET_TYPE | シークレットの種別を指定します (デフォルト: none)。 |
表68.28 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表68.29 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表68.30 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表68.31 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
68.8. secret order create
新しい順序を作成します。
使用方法
openstack secret order create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name NAME] [--algorithm ALGORITHM] [--bit-length BIT_LENGTH] [--mode MODE] [--payload-content-type PAYLOAD_CONTENT_TYPE] [--expiration EXPIRATION] [--request-type REQUEST_TYPE] [--subject-dn SUBJECT_DN] [--source-container-ref SOURCE_CONTAINER_REF] [--ca-id CA_ID] [--profile PROFILE] [--request-file REQUEST_FILE] type
表68.32 位置引数
値 | 概要 |
---|---|
type | 作成する順序の種別 (鍵、非対称、証明書)。 |
表68.33 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name NAME, -n NAME | 人間に分かりやすい名前。 |
--algorithm ALGORITHM、-a ALGORITHM | 要求されたキーで使用されるアルゴリズム (デフォルト:aes) |
--bit-length BIT_LENGTH, -b BIT_LENGTH | 要求されるシークレットキーのビット長 (デフォルト:256)。 |
--mode MODE、-m MODE | 要求されたキーで使用されるアルゴリズムモード (デフォルト:cbc) |
--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE | 生成されるシークレットの種別/形式 (デフォルト:application/octet-stream)。 |
--expiration EXPIRATION、-x EXPIRATION | iso 8601 形式のシークレットの有効期限 |
--request-type REQUEST_TYPE | 証明書要求の種別。 |
--subject-dn SUBJECT_DN | 証明書のサブジェクト。 |
--source-container-ref SOURCE_CONTAINER_REF | stored-key 要求を使用する際の証明書のソース。 |
--ca-id CA_ID | 証明書要求に使用する ca の識別子。 |
--profile PROFILE | 使用する証明書のプロファイル。 |
--request-file REQUEST_FILE | csr が含まれるファイル。 |
表68.34 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表68.35 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表68.36 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表68.37 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
68.9. secret order delete
href を指定して順序を削除します。
使用方法
openstack secret order delete [-h] URI
表68.38 位置引数
値 | 概要 |
---|---|
URI | 順序の URI 参照 |
表68.39 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
68.10. secret order get
URI を指定して順序を取得します。
使用方法
openstack secret order get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] URI
表68.40 位置引数
値 | 概要 |
---|---|
URI | uri 参照の順序。 |
表68.41 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表68.42 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表68.43 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表68.44 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表68.45 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
68.11. secret order list
順序をリスト表示します。
使用方法
openstack secret order list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--limit LIMIT] [--offset OFFSET]
表68.46 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit LIMIT, -l LIMIT | ページごとに表示する項目数に制限を指定します (デフォルト:10、最大: 100)。 |
--offset OFFSET, -o OFFSET | ページのオフセットを指定します (デフォルト:0)。 |
表68.47 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表68.48 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表68.49 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表68.50 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
68.12. secret store
Barbican にシークレットを保存します。
使用方法
openstack secret store [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name NAME] [--secret-type SECRET_TYPE] [--payload-content-type PAYLOAD_CONTENT_TYPE] [--payload-content-encoding PAYLOAD_CONTENT_ENCODING] [--algorithm ALGORITHM] [--bit-length BIT_LENGTH] [--mode MODE] [--expiration EXPIRATION] [--payload PAYLOAD | --file <filename>]
表68.51 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name NAME, -n NAME | 人間に分かりやすい名前。 |
--secret-type SECRET_TYPE, -s SECRET_TYPE | シークレットの種別。symmetric、public、private、certificate、passphrase、opaque (デフォルト) のいずれかでなければなりません。 |
--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE | 提供されたシークレットデータの種別/フォーマット。"text/plain" は UTF-8 であると想定されます。--payload が指定されている場合は必須です。 |
--payload-content-encoding PAYLOAD_CONTENT_ENCODING, -e PAYLOAD_CONTENT_ENCODING | --payload-content-type が "application/octet-stream" の場合は必須です。 |
--algorithm ALGORITHM、-a ALGORITHM | アルゴリズム (デフォルト:aes) |
--bit-length BIT_LENGTH, -b BIT_LENGTH | ビットの長さ (デフォルト:256)。 |
--mode MODE、-m MODE | アルゴリズムモード。参照用にのみ使用されます (デフォルト:cbc) |
--expiration EXPIRATION、-x EXPIRATION | iso 8601 形式のシークレットの有効期限 |
--payload PAYLOAD、-p PAYLOAD | 暗号化されていないシークレットデータ。 |
--file <filename>、-F <filename> | シークレットペイロードが含まれるファイル |
表68.52 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表68.53 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表68.54 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表68.55 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
68.13. secret update
Barbican のペイロードなしでシークレットを更新します。
使用方法
openstack secret update [-h] URI payload
表68.56 位置引数
値 | 概要 |
---|---|
URI | シークレットの uri 参照。 |
payload | 暗号化されていないシークレット |
表68.57 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
第69章 security
本章では、security
コマンドに含まれるコマンドについて説明します。
69.1. security group create
新しいセキュリティーグループを作成します。
使用方法
openstack security group create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--project <project>] [--project-domain <project-domain>] [--tag <tag> | --no-tag] <name>
表69.1 位置引数
値 | 概要 |
---|---|
<name> | 新しいセキュリティーグループ名 |
表69.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | セキュリティーグループの説明 |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--tag <tag> | セキュリティーグループに追加するタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--no-tag | セキュリティーグループにタグを関連付けません。 |
表69.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表69.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表69.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表69.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
69.2. security group delete
セキュリティーグループを削除します。
使用方法
openstack security group delete [-h] <group> [<group> ...]
表69.7 位置引数
値 | 概要 |
---|---|
<group> | 削除するセキュリティーグループ (名前または ID) |
表69.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
69.3. security group list
セキュリティーグループをリスト表示します。
使用方法
openstack security group list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--project <project>] [--project-domain <project-domain>] [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]] [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]]
表69.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | プロジェクトに従ってセキュリティーグループをリスト表示します (名前または ID)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--tags <tag>[,<tag>,…] | 指定されたタグ (タグのコンマ区切りリスト) がすべて割り当てられたセキュリティーグループをリスト表示します。 |
--any-tags <tag>[,<tag>,…] | 指定されたタグ (タグのコンマ区切りリスト) のいずれかが割り当てられたセキュリティーグループをリスト表示します。 |
--not-tags <tag>[,<tag>,…] | 指定されたタグ (タグのコンマ区切りリスト) がすべて割り当てられたセキュリティーグループを除外します。 |
--not-any-tags <tag>[,<tag>,…] | 指定されたタグ (タグのコンマ区切りリスト) のいずれかが割り当てられたセキュリティーグループを除外します。 |
表69.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表69.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表69.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表69.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
69.4. security group rule create
新しいセキュリティーグループルールを作成します。
使用方法
openstack security group rule create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--remote-ip <ip-address> | --remote-group <group>] [--description <description>] [--dst-port <port-range>] [--icmp-type <icmp-type>] [--icmp-code <icmp-code>] [--protocol <protocol>] [--ingress | --egress] [--ethertype <ethertype>] [--project <project>] [--project-domain <project-domain>] <group>
表69.14 位置引数
値 | 概要 |
---|---|
<group> | このセキュリティーグループにルールを作成します (名前または ID)。 |
表69.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--remote-ip <ip-address> | リモート IP アドレスブロック (cidr 表記を使用することができます。IPv4 ルールのデフォルト:0.0.0.0/0、IPv6 ルールのデフォルト:::/0) |
--remote-group <group> | リモートセキュリティーグループ (名前または ID) |
--description <description> | セキュリティーグループルールの説明を設定します。 |
--dst-port <port-range> | 宛先ポート。単一ポートまたはポート範囲の始点および終点を指定できます: 137:139IP プロトコル TCP および UDP に必須です。ICMP IP プロトコルでは無視されます。 |
--icmp-type <icmp-type> | icmp ip プロトコルの ICMP 種別 |
--icmp-code <icmp-code> | icmp ip プロトコルの ICMP コード |
--protocol <protocol> | IP プロトコル (ah、dccp、egp、esp、gre、icmp、igmp、ipv6-encap、ipv6-frag、ipv6-icmp、ipv6-nonxt、ipv6-opts、ipv6-route、ospf、pgm、rsvp、sctp、tcp、udp、udplite、vrrp、および integer 表現 [0-255] または any。デフォルト: any (すべてのプロトコル)) |
--ingress | 受信ネットワークトラフィックに適用されるルール (デフォルト) |
--egress | 送信ネットワークトラフィックに適用されるルール |
--ethertype <ethertype> | ネットワークトラフィックの ethertype(ipv4、ipv6。デフォルト: IP プロトコルに基づく) |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
表69.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表69.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表69.18 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表69.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
69.5. security group rule delete
セキュリティーグループルールを削除します。
使用方法
openstack security group rule delete [-h] <rule> [<rule> ...]
表69.20 位置引数
値 | 概要 |
---|---|
<rule> | 削除するセキュリティーグループルール (id のみ) |
表69.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
69.6. security group rule list
セキュリティーグループルールをリスト表示します。
使用方法
openstack security group rule list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--protocol <protocol>] [--ethertype <ethertype>] [--ingress | --egress] [--long] [<group>]
表69.22 位置引数
値 | 概要 |
---|---|
<group> | このセキュリティーグループのすべてのルールをリスト表示します (名前または ID)。 |
表69.23 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--protocol <protocol> | IP プロトコル (ah、dccp、egp、esp、gre、icmp、igmp、ipv6-encap、ipv6-frag、ipv6-icmp、ipv6-nonxt、ipv6-opts、ipv6-route、ospf、pgm、rsvp、sctp、tcp、udp、udplite、vrrp、および integer 表現 [0-255] または any。デフォルト: any (すべてのプロトコル)) でルールをリスト表示します。 |
--ethertype <ethertype> | ethertype(ipv4 または ipv6) でルールをリスト表示します。 |
--ingress | 受信ネットワークトラフィックに適用されるルールをリスト表示します。 |
--egress | 発信ネットワークトラフィックに適用されるルールをリスト表示します。 |
--long | 出力の追加フィールドをリスト表示します。 |
表69.24 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表69.25 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表69.26 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表69.27 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
69.7. security group rule show
セキュリティーグループルールの詳細を表示します。
使用方法
openstack security group rule show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <rule>
表69.28 位置引数
値 | 概要 |
---|---|
<rule> | 表示するセキュリティーグループルール (id のみ) |
表69.29 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表69.30 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表69.31 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表69.32 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表69.33 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
69.8. security group set
セキュリティーグループの属性を設定します。
使用方法
openstack security group set [-h] [--name <new-name>] [--description <description>] [--tag <tag>] [--no-tag] <group>
表69.34 位置引数
値 | 概要 |
---|---|
<group> | 変更するセキュリティーグループ (名前または ID) |
表69.35 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <new-name> | 新しいセキュリティーグループ名 |
--description <description> | 新しいセキュリティーグループの説明 |
--tag <tag> | セキュリティーグループに追加するタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--no-tag | セキュリティーグループに関連付けられたタグをクリアします。現在のタグを上書きするには、--tag と --no-tag の両方を指定します |
69.9. security group show
セキュリティーグループの詳細を表示します。
使用方法
openstack security group show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <group>
表69.36 位置引数
値 | 概要 |
---|---|
<group> | 表示するセキュリティーグループ (名前または ID) |
表69.37 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表69.38 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表69.39 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表69.40 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表69.41 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
69.10. security group unset
セキュリティーグループ属性の設定を解除します。
使用方法
openstack security group unset [-h] [--tag <tag> | --all-tag] <group>
表69.42 位置引数
値 | 概要 |
---|---|
<group> | 変更するセキュリティーグループ (名前または ID) |
表69.43 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--tag <tag> | セキュリティーグループから削除するタグ (複数のタグを削除する場合はオプションを繰り返し使用します) |
--all-tag | セキュリティーグループに関連付けられたすべてのタグをクリアします |
第70章 server
本章では、server
コマンドに含まれるコマンドについて説明します。
70.1. server add fixed ip
Fixed IP アドレスをサーバーに追加します。
使用方法
openstack server add fixed ip [-h] [--fixed-ip-address <ip-address>] <server> <network>
表70.1 位置引数
値 | 概要 |
---|---|
<server> | Fixed IP アドレスを受信するサーバー (名前または ID) |
<network> | Fixed IP アドレスの割り当て元となるネットワーク (名前または ID) |
表70.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--fixed-ip-address <ip-address> | 要求された Fixed IP アドレス |
70.2. server add floating ip
サーバーに Floating IP アドレスを追加します。
使用方法
openstack server add floating ip [-h] [--fixed-ip-address <ip-address>] <server> <ip-address>
表70.3 位置引数
値 | 概要 |
---|---|
<server> | Floating IP アドレスを受信するサーバー (名前または ID) |
<ip-address> | 最初に利用可能なサーバーポートに割り当てる Floating IP アドレス (IP のみ) |
表70.4 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--fixed-ip-address <ip-address> | この Floating IP アドレスに関連付ける Fixed IP アドレスFixed IP アドレスが含まれる最初のサーバーポートが使用されます。 |
70.3. server add network
サーバーにネットワークを追加します。
使用方法
openstack server add network [-h] <server> <network>
表70.5 位置引数
値 | 概要 |
---|---|
<server> | ネットワークを追加するサーバー (名前または ID) |
<network> | サーバーに追加するネットワーク (名前または ID) |
表70.6 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
70.4. server add port
サーバーにポートを追加します。
使用方法
openstack server add port [-h] <server> <port>
表70.7 位置引数
値 | 概要 |
---|---|
<server> | ポートを追加するサーバー (名前または ID) |
<port> | サーバーに追加するポート (名前または ID) |
表70.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
70.5. server add security group
セキュリティーグループをサーバーに追加します。
使用方法
openstack server add security group [-h] <server> <group>
表70.9 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
<group> | 追加するセキュリティーグループ (名前または ID) |
表70.10 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.6. server add volume
サーバーにボリュームを追加します。ステータスが``SHELVED`` または ``SHELVED_OFFLOADED``のサーバーにボリュームを追加するには、``--os-compute-api-version 2.20``以上を指定します。
使用方法
openstack server add volume [-h] [--device <device>] <server> <volume>
表70.11 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
<volume> | 追加するボリューム (名前または ID) |
表70.12 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--device <device> | ボリュームのサーバーの内部デバイス名 |
70.7. server backup create
サーバーのバックアップイメージを作成します。
使用方法
openstack server backup create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <image-name>] [--type <backup-type>] [--rotate <count>] [--wait] <server>
表70.13 位置引数
値 | 概要 |
---|---|
<server> | バックアップを作成するサーバー (名前または ID) |
表70.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <image-name> | バックアップイメージの名前 (デフォルト: サーバー名) |
--type <backup-type> | バックアップイメージの backup_type 属性の設定に使用 (デフォルト: 空欄) |
--rotate <count> | 保持するバックアップ数 (デフォルト:1) |
--wait | バックアップイメージの作成が完了するのを待ちます。 |
表70.15 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表70.16 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表70.17 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表70.18 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
70.8. server create
新しいサーバーを作成します。
使用方法
openstack server create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] (--image <image> | --image-property <key=value> | --volume <volume>) --flavor <flavor> [--security-group <security-group>] [--key-name <key-name>] [--property <key=value>] [--file <dest-filename=source-filename>] [--user-data <user-data>] [--description <description>] [--availability-zone <zone-name>] [--host <host>] [--hypervisor-hostname <hypervisor-hostname>] [--boot-from-volume <volume-size>] [--block-device-mapping <dev-name=mapping>] [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none>] [--network <network>] [--port <port>] [--hint <key=value>] [--config-drive <config-drive-volume>|True] [--min <count>] [--max <count>] [--wait] <server-name>
表70.19 位置引数
値 | 概要 |
---|---|
<server-name> | 新しいサーバー名 |
表70.20 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--image <image> | このイメージからサーバーのブートディスクを作成します (名前または ID)。 |
--image-property <key=value> | 照合されるイメージ属性 |
--volume <volume> | このボリュームをブートディスクとして使用してサーバーを作成します (名前または ID)。このオプションは、ブートインデックス 0 でブロックデバイスマッピングを自動的に作成します。多くのハイパーバイザー (libvirt/kvm など) で、これはデバイス vda になります。--block-device- mapping を使用して、このデバイスに重複したマッピングを作成しないでください。 |
--flavor <flavor> | このフレーバーを使用してサーバーを作成します (名前または ID)。 |
--security-group <security-group> | このサーバーに割り当てるセキュリティーグループ (名前または ID)(複数のグループを設定する場合はオプションを繰り返し使用します) |
--key-name <key-name> | このサーバーに挿入するキーペア (任意の拡張) |
--property <key=value> | このサーバーに属性を設定します (複数の値を設定する場合はオプションを繰り返し使用します)。 |
--file <dest-filename=source-filename> | ブート前にイメージに挿入するファイル (複数のファイルを設定する場合はオプションを繰り返し使用します) |
--user-data <user-data> | メタデータサーバーから提供されるユーザーデータファイル |
--description <description> | サーバーの説明を設定します (--os- compute-api-version 2.19 以降でサポート) |
--availability-zone <zone-name> | サーバーのアベイラビリティーゾーンを選択します。 |
--host <host> | サーバーを作成するために要求されたホスト。デフォルトでは管理者のみが対象です (--os-compute-api-version 2.74 以上でサポートされます)。 |
--hypervisor-hostname <hypervisor-hostname> | サーバーを作成するために要求されたハイパーバイザーホスト名。デフォルトでは管理者のみが対象です (--os-compute-api- version 2.74 以上でサポートされます)。 |
--boot-from-volume <volume-size> | ''--image'' または ''--image-property'' オプションと併用すると、このオプションは、ブートインデックスが 0 のブロックデバイスマッピングを自動的に作成し、指定されたイメージから指定のサイズ (GB) のボリュームを作成し、サーバーのルートディスクとして使用するよう Compute サービスに指示します。ルートボリュームは、サーバーの削除時に削除されません。このオプションは ``--volume`` オプションと相互に排他的です。 |
--block-device-mapping <dev-name=mapping> | サーバーにブロックデバイスを作成します。<dev-name>=<id>:<type>:<size(GB)>:<delete-on- terminate>の形式のブロックデバイスマッピング。<dev-name>: vdb、xvdc 等のブロックデバイス名 (必須)、<id>: ボリューム、ボリュームスナップショット、またはイメージの名前または ID (必須)、<type>: volume、snapshot、または image (デフォルト: volume) (オプション)、<size(GB)>: イメージまたはスナップショットから作成する場合はボリュームサイズ (オプション)、<delete-on-terminate>: true または false (デフォルト: false) (オプション) (オプションの機能拡張) |
--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none> | サーバーに nic を作成します。複数の NIC を作成するには、オプションを複数回指定します。net-id または port- id のどちらかを指定する必要がありますが、両方を指定することはできません。net-id: NIC をこの UUID が割り当てられたネットワークにアタッチします。port-id: NIC をこの UUID が割り当てられたポートにアタッチします。v4-fixed-ip: NIC 用 IPv4 固定アドレス (オプション)。v6-fixed-ip: NIC 用 IPv6 固定アドレス (オプション)。none: (v2.37 以上) ネットワークをアタッチしません。auto: (v2.37 以上) Compute サービスがネットワークを自動的に割り当てます。--nic に auto または none を指定すると、他の --nic の値とは併用できません。 |
--network <network> | サーバーに nic を作成し、ネットワークに接続します。複数の NIC を作成するには、オプションを複数回指定します。これは、新しいサーバーを指定されたネットワークに接続する標準ユースケースの簡単な構文を提供する--nic net-id=<network> パラメーターのラッパーです。高度なユースケースは、-- nic パラメーターを参照してください。 |
--port <port> | サーバーに nic を作成し、ポートに接続します。複数の NIC を作成するには、オプションを複数回指定します。これは、新しいサーバーを指定されたポートに接続する標準ユースケースの簡単な構文を提供する--nic port-id=<port> パラメーターのラッパーです。高度なユースケースは、--nic パラメーターを参照してください。 |
--hint <key=value> | スケジューラーのヒント (オプションの機能拡張) |
--config-drive <config-drive-volume>|True | 指定されたボリュームをコンフィグドライブとして使用するか、true で一時ドライブを使用します。 |
--min <count> | 起動するサーバーの最小数 (デフォルトは 1) |
--max <count> | 起動するサーバーの最大数 (デフォルトは 1) |
--wait | ビルドが完了するまで待ちます。 |
表70.21 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表70.22 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表70.23 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表70.24 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
70.9. server delete
サーバーを削除します。
使用方法
openstack server delete [-h] [--wait] <server> [<server> ...]
表70.25 位置引数
値 | 概要 |
---|---|
<server> | 削除するサーバー (名前または ID) |
表70.26 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait | 削除が完了するのを待ちます。 |
70.10. server dump create
ダンプファイルをサーバー内に作成します。Linux の kdump などの機能を使用して、サーバーでクラッシュダンプをトリガーします。サーバーのメモリーをダンプするサーバーにダンプファイルを作成し、さらにサーバーをクラッシュします。OSC は、リソースの 1 つとしてダンプファイル (サーバーダンプ) を確認します。このコマンドには ''--os-compute-api- version'' 2.17 以降が必要です。
使用方法
openstack server dump create [-h] <server> [<server> ...]
表70.27 位置引数
値 | 概要 |
---|---|
<server> | ダンプファイルを作成するサーバー (名前または ID) |
表70.28 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
70.11. server event list
サーバーの最近のイベントをリスト表示します。ID のみで指定された、削除されたサーバーのイベントを表示するには、``--os-compute-api-version 2.21`` 以降を指定します。
使用方法
openstack server event list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] <server>
表70.29 位置引数
値 | 概要 |
---|---|
<server> | イベントをリスト表示するサーバー (名前または ID) |
表70.30 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
表70.31 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表70.32 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表70.33 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表70.34 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
70.12. server event show
サーバーイベントの詳細を表示します。ID のみで指定された、削除されたサーバーのイベントの詳細を表示するには、``--os-compute-api-version 2.21`` 以降を指定します。管理者以外のユーザーのイベント詳細を表示するには、``--os-compute-api-version 2.51`` 以降を指定します。
使用方法
openstack server event show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <server> <request-id>
表70.35 位置引数
値 | 概要 |
---|---|
<server> | イベントの詳細を表示するサーバー (名前または ID) |
<request-id> | 表示するイベントの要求 ID(id のみ) |
表70.36 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表70.37 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表70.38 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表70.39 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表70.40 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
70.13. server group create
新しいサーバーグループを作成します。
使用方法
openstack server group create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--policy <policy>] [--rule <key=value>] <name>
表70.41 位置引数
値 | 概要 |
---|---|
<name> | 新しいサーバーグループ名 |
表70.42 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--policy <policy> | <name> にポリシーを追加します (affinity または anti-affinity、デフォルトは affinity)。soft-affinity または soft-anti-affinity ポリシーの場合、--os-compute-api- version 2.15 以降を指定します。 |
--rule <key=value> | ポリシーのルール。現在、max_server_per_host ルールのみが anti- affinity ポリシーでサポートされます。 |
表70.43 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表70.44 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表70.45 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表70.46 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
70.14. server group delete
既存のサーバーグループを削除します。
使用方法
openstack server group delete [-h] <server-group> [<server-group> ...]
表70.47 位置引数
値 | 概要 |
---|---|
<server-group> | 削除するサーバーグループ (名前または ID) |
表70.48 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.15. server group list
すべてのサーバーグループをリスト表示します。
使用方法
openstack server group list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--all-projects] [--long]
表70.49 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの情報を表示します (管理者のみ)。 |
--long | 出力の追加フィールドをリスト表示します。 |
表70.50 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表70.51 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表70.52 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表70.53 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
70.16. server group show
サーバーグループの詳細を表示します。
使用方法
openstack server group show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <server-group>
表70.54 位置引数
値 | 概要 |
---|---|
<server-group> | 表示するサーバーグループ (名前または ID) |
表70.55 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表70.56 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表70.57 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表70.58 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表70.59 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
70.17. server image create
既存のサーバーから新規サーバーディスクイメージを作成します。
使用方法
openstack server image create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <image-name>] [--wait] <server>
表70.60 位置引数
値 | 概要 |
---|---|
<server> | イメージを作成するサーバー (名前または ID) |
表70.61 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <image-name> | 新しいディスクイメージの名前 (デフォルト: サーバー名) |
--wait | 動作が完了するまで待ちます。 |
表70.62 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表70.63 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表70.64 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表70.65 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
70.18. server list
サーバーをリスト表示します。
使用方法
openstack server list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--reservation-id <reservation-id>] [--ip <ip-address-regex>] [--ip6 <ip-address-regex>] [--name <name-regex>] [--instance-name <server-name>] [--status <status>] [--flavor <flavor>] [--image <image>] [--host <hostname>] [--all-projects] [--project <project>] [--project-domain <project-domain>] [--user <user>] [--user-domain <user-domain>] [--long] [-n | --name-lookup-one-by-one] [--marker <server>] [--limit <num-servers>] [--deleted] [--changes-before <changes-before>] [--changes-since <changes-since>] [--locked | --unlocked]
表70.66 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--reservation-id <reservation-id> | 予約に一致するインスタンスのみを返します。 |
--ip <ip-address-regex> | IP アドレスに一致する正規表現 |
--ip6 <ip-address-regex> | ipv6 アドレスに一致する正規表現。このオプションは、''-os-compute-api-version'' 2.5 以上を使用する場合に、管理者以外のユーザーにのみ適用されることに注意してください。 |
--name <name-regex> | 名前に一致する正規表現 |
--instance-name <server-name> | インスタンス名に一致する正規表現 (管理者のみ) |
--status <status> | サーバーステータス別に検索します |
--flavor <flavor> | フレーバー別に検索します (名前または ID) |
--image <image> | イメージ別に検索します (名前または ID) |
--host <hostname> | ホスト名別に検索します |
--all-projects | すべてのプロジェクトを含めます (管理者のみ)。 |
--project <project> | プロジェクト別に検索します (管理者のみ)(名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--user <user> | ユーザーで検索します (管理者のみ)(名前または ID) |
--user-domain <user-domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
--long | 出力の追加フィールドをリスト表示します。 |
-n, --no-name-lookup | フレーバーとイメージ名による検索を省略します。"--name-lookup-one-by-one" オプションと相互に排他的です。 |
--name-lookup-one-by-one | フレーバーおよびイメージ名を検索する場合には、すべてまとめて (デフォルト) ではなく、必要に応じて 1 つずつ検索します。"--no-name- lookup|-n" オプションと相互に排他的です。 |
--marker <server> | 前のページにある最後のサーバー。マーカーの後にサーバーのリストを表示します。指定されていない場合は、すべてのサーバーを表示します。''--deleted'' と使用する場合、マーカーは ID である必要があります。それ以外の場合は、名前または ID を使用できます。 |
--limit <num-servers> | 表示するサーバーの最大数。制限が -1 の場合、すべてのサーバーが表示されます。上限が Nova API の osapi_max_limit オプションよりも大きい場合には、代わりに osapi_max_limit が使用されます。 |
--deleted | 削除されたサーバーのみを表示します (管理者のみ)。 |
--changes-before <changes-before> | 特定の時点より前に変更されたサーバーのみをリスト表示します。指定する時間は ISO 8061 形式の時刻 (例:2016-03-05T06:27:59Z) である必要があります。(API バージョン 2.66 - 2.latestでサポートされます) |
--changes-since <changes-since> | 特定の時点より後に変更されたサーバーのみをリスト表示します。指定する時間は ISO 8061 形式の時刻 (例:2016-03-04T06:27:59Z) である必要があります。 |
--locked | ロックされたサーバーのみを表示します。これには ''--os-compute- api-version'' 2.73 以上が必要です。 |
--unlocked | ロックが解除されたサーバーのみを表示します。これには ``--os- compute-api-version`` 2.73 以上が必要です。 |
表70.67 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表70.68 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表70.69 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表70.70 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
70.19. server lock
サーバーをロックします。管理者以外のユーザーはアクションを実行できなくなります。
使用方法
openstack server lock [-h] [--reason <reason>] <server> [<server> ...]
表70.71 位置引数
値 | 概要 |
---|---|
<server> | ロックするサーバー (名前または ID) |
表70.72 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--reason <reason> | サーバーをロックする理由。これには ''--os- compute-api-version'' 2.73 以上が必要です。 |
70.20. server migrate
サーバーを異なるホストに移行します。
使用方法
openstack server migrate [-h] [--live-migration] [--live <hostname> | --host <hostname>] [--shared-migration | --block-migration] [--disk-overcommit | --no-disk-overcommit] [--wait] <server>
表70.73 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
表70.74 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--live-migration | サーバーのライブマイグレーションを行います。移行のターゲットホストを指定するには、''--host'' オプションを使用します。これは、スケジューラーによって検証されます。 |
--live <hostname> | 非推奨。このオプションは、ホストが必要で、compute API バージョン 2.30 より前でライブマイグレーション中のホストを指定すると、スケジューラーによる検証がバイパスされます。これにより、サーバーを指定されたホストに実際に移行できないか、ホストのオーバーサブスクライブが発生する可能性があります。代わりに ''-live-migration'' オプションを使用してください。このオプションと ''-live-migration'' の両方が使用された場合は、''--live-migration'' が優先されます。 |
--host <hostname> | 指定したホストにサーバーを移行します。''--live-migration'' オプションと併用する場合は ''--os-compute-api-version'' 2.30 以上が必要です。それ以外の場合は、''--os-compute-api-version'' 2.56 以上が必要になります。 |
--shared-migration | 共有ライブマイグレーションを実行します (デフォルト)。 |
--block-migration | ブロックライブマイグレーションを実行します。 |
--disk-overcommit | 移行先ホストでディスクのオーバーコミットを許可します。 |
--no-disk-overcommit | 移行先ホストでディスクのオーバーコミットを行いません (デフォルト)。 |
--wait | 移行が完了するまで待ちます。 |
70.21. server pause
サーバーを一時停止します。
使用方法
openstack server pause [-h] <server> [<server> ...]
表70.75 位置引数
値 | 概要 |
---|---|
<server> | 一時停止するサーバー (名前または ID) |
表70.76 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.22. server reboot
サーバーのハードまたはソフトリブートを実行します。
使用方法
openstack server reboot [-h] [--hard | --soft] [--wait] <server>
表70.77 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
表70.78 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--hard | ハードリブートを実行します。 |
--soft | ソフトリブートを実行します。 |
--wait | リブートが完了するまで待ちます。 |
70.23. server rebuild
サーバーを再ビルドします。
使用方法
openstack server rebuild [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--image <image>] [--password <password>] [--property <key=value>] [--description <description>] [--wait] [--key-name <key-name> | --key-unset] <server>
表70.79 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
表70.80 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--image <image> | 指定されたイメージからサーバーを再作成します (名前または ID)。デフォルトは現在使用中のイメージです。 |
--password <password> | 再ビルドしたインスタンスのパスワードを設定します。 |
--property <key=value> | 再ビルドしたインスタンスで属性を設定します (複数の値を設定する場合はオプションを繰り返し使用します)。 |
--description <description> | サーバーの新しい説明 (--os- compute-api-version 2.19 以上でサポートされます) |
--wait | 再ビルドが完了するまで待ちます。 |
--key-name <key-name> | 再ビルドしたインスタンスで、キーペアのキー名を設定します。--key-unset オプションと共に指定することはできません。(API バージョン 2.54 - 2.latestでサポートされます) |
--key-unset | 再ビルドしたインスタンスで、キーペアのキー名を設定しません。--key-name オプションと共に指定することはできません。(API バージョン 2.54 - 2.latestでサポートされます) |
表70.81 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表70.82 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表70.83 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表70.84 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
70.24. server remove fixed ip
サーバーから Fixed IP アドレスを削除します。
使用方法
openstack server remove fixed ip [-h] <server> <ip-address>
表70.85 位置引数
値 | 概要 |
---|---|
<server> | Fixed IP アドレスを削除するサーバー (名前または ID) |
<ip-address> | サーバーから削除する Fixed IP アドレス (ip のみ) |
表70.86 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.25. server remove floating ip
サーバーから Floating IP アドレスを削除します。
使用方法
openstack server remove floating ip [-h] <server> <ip-address>
表70.87 位置引数
値 | 概要 |
---|---|
<server> | Floating IP アドレスを削除するサーバー (名前または ID) |
<ip-address> | サーバーから削除する Floating IP アドレス (ip のみ) |
表70.88 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.26. server remove network
サーバーからネットワークのポートをすべて削除します。
使用方法
openstack server remove network [-h] <server> <network>
表70.89 位置引数
値 | 概要 |
---|---|
<server> | ポートを削除するサーバー (名前または ID) |
<network> | サーバーから削除するネットワーク (名前または ID) |
表70.90 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.27. server remove port
サーバーからポートを削除します。
使用方法
openstack server remove port [-h] <server> <port>
表70.91 位置引数
値 | 概要 |
---|---|
<server> | ポートを削除するサーバー (名前または ID) |
<port> | サーバーから削除するポート (名前または ID) |
表70.92 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.28. server remove security group
サーバーからセキュリティーグループを削除します。
使用方法
openstack server remove security group [-h] <server> <group>
表70.93 位置引数
値 | 概要 |
---|---|
<server> | 使用するサーバーの名前または ID |
<group> | サーバーから削除するセキュリティーグループの名前または ID |
表70.94 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.29. server remove volume
サーバーからボリュームを削除します。ステータスが``SHELVED`` または ``SHELVED_OFFLOADED``のサーバーからボリュームを削除するには、``--os-compute-api-version 2.20``以上を指定します。
使用方法
openstack server remove volume [-h] <server> <volume>
表70.95 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
<volume> | 削除するボリューム (名前または ID) |
表70.96 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.30. server rescue
サーバーをレスキューモードに切り替えます。
使用方法
openstack server rescue [-h] [--image <image>] [--password <password>] <server>
表70.97 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
表70.98 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--image <image> | レスキューモードに使用するイメージ (名前または ID)。デフォルトは現在使用中のイメージです。 |
--password <password> | レスキューインスタンスのパスワードを設定します。 |
70.31. server resize confirm
サーバーのサイズ変更を確認します。サイズ変更操作の成功を確認 (検証) し、古いサーバーを解放します。
使用方法
openstack server resize confirm [-h] <server>
表70.99 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
表70.100 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.32. server resize revert
サーバーのサイズ変更を元に戻します。サイズ変更操作を元に戻します。新しいサーバーを解放し、古いサーバーを再起動します。
使用方法
openstack server resize revert [-h] <server>
表70.101 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
表70.102 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.33. server resize
サーバーを新規フレーバーにスケーリングします。サイズ変更操作は、新しいサーバーを作成して、元のディスクの内容を新しいディスクにコピーして実行されます。また、ユーザーにとっても 2 つのステップのプロセスです。1 つ目はサイズ変更の実行で、2 つ目は、成功を確認 (検証) して古いサーバーを解放するか、やり直しを宣言して新しいサーバーを解放して古いサーバーを再起動するかのどちらかです。
使用方法
openstack server resize [-h] [--flavor <flavor> | --confirm | --revert] [--wait] <server>
表70.103 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
表70.104 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--flavor <flavor> | サーバーを指定したフレーバーにサイズ変更します。 |
--confirm | サーバーのサイズ変更が完了したことを確認します。 |
--revert | サーバーの状態をサイズ変更前に復元します。 |
--wait | サイズ変更が完了するまで待ちます。 |
70.34. server restore
サーバーを復元します。
使用方法
openstack server restore [-h] <server> [<server> ...]
表70.105 位置引数
値 | 概要 |
---|---|
<server> | 復元するサーバー (名前または ID) |
表70.106 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.35. server resume
サーバーを再開します。
使用方法
openstack server resume [-h] <server> [<server> ...]
表70.107 位置引数
値 | 概要 |
---|---|
<server> | 再開するサーバー (名前または ID) |
表70.108 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.36. server set
サーバー属性を設定します。
使用方法
openstack server set [-h] [--name <new-name>] [--root-password] [--property <key=value>] [--state <state>] [--description <description>] <server>
表70.109 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
表70.110 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <new-name> | 新しいサーバー名 |
--root-password | 新しい root パスワードを設定します (対話式のみ)。 |
--property <key=value> | このサーバーに追加/変更する属性 (複数の属性を設定する場合はオプションを繰り返し使用します) |
--state <state> | 新しいサーバーの状態 (有効な値:active、error) |
--description <description> | 新規サーバーの説明 (--os-compute-api- version 2.19 以降でサポートされます) |
70.37. server shelve
サーバーを退避します。
使用方法
openstack server shelve [-h] <server> [<server> ...]
表70.111 位置引数
値 | 概要 |
---|---|
<server> | 退避するサーバー (名前または ID) |
表70.112 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
70.38. server show
サーバーの詳細を表示します。サーバーの埋め込みフレーバー情報を表示するには、``--os-compute-api-version 2.47`` 以上を指定します。
使用方法
openstack server show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--diagnostics] <server>
表70.113 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
表70.114 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--diagnostics | サーバーの診断情報を表示します。 |
表70.115 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表70.116 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表70.117 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表70.118 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
70.39. server ssh
サーバーに SSH 接続を行います。
使用方法
openstack server ssh [-h] [--login <login-name>] [--port <port>] [--identity <keyfile>] [--option <config-options>] [-4 | -6] [--public | --private | --address-type <address-type>] <server>
表70.119 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
表70.120 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--login <login-name> | ログイン名 (ssh -l オプション) |
--port <port> | 宛先ポート (ssh -p オプション) |
--identity <keyfile> | 秘密鍵ファイル (ssh -i オプション) |
--option <config-options> | ssh_config(5) 形式のオプション (ssh -o オプション) |
-4 | ipv4 アドレスのみを使用します。 |
-6 | ipv6 アドレスのみを使用します。 |
--public | パブリック IP アドレスを使用します。 |
--private | プライベート IP アドレスを使用します。 |
--address-type <address-type> | 他の IP アドレス (パブリック、プライベートなど) を使用します。 |
70.40. server start
サーバーを起動します。
使用方法
openstack server start [-h] <server> [<server> ...]
表70.121 位置引数
値 | 概要 |
---|---|
<server> | 起動するサーバー (名前または ID) |
表70.122 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
70.41. server stop
サーバーを停止します。
使用方法
openstack server stop [-h] <server> [<server> ...]
表70.123 位置引数
値 | 概要 |
---|---|
<server> | 停止するサーバー (名前または ID) |
表70.124 コマンド引数
値 | 概要 |
---|---|
-h、--help | ヘルプメッセージを表示して終了します。 |
70.42. server suspend
サーバーを一時停止します。
使用方法
openstack server suspend [-h] <server> [<server> ...]
表70.125 位置引数
値 | 概要 |
---|---|
<server> | 一時停止するサーバー (名前または ID) |
表70.126 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.43. server unlock
サーバーのロックを解除します。
使用方法
openstack server unlock [-h] <server> [<server> ...]
表70.127 位置引数
値 | 概要 |
---|---|
<server> | ロックを解除するサーバー (名前または ID) |
表70.128 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.44. server unpause
サーバーの一時停止を解除します。
使用方法
openstack server unpause [-h] <server> [<server> ...]
表70.129 位置引数
値 | 概要 |
---|---|
<server> | 一時停止を解除するサーバー (名前または ID) |
表70.130 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.45. server unrescue
レスキューモードからサーバーを復元します。
使用方法
openstack server unrescue [-h] <server>
表70.131 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
表70.132 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
70.46. server unset
サーバー属性の設定を解除します。
使用方法
openstack server unset [-h] [--property <key>] [--description] <server>
表70.133 位置引数
値 | 概要 |
---|---|
<server> | サーバー (名前または ID) |
表70.134 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--property <key> | サーバーから削除する属性キー (複数の値を削除する場合はオプションを繰り返し使用します) |
--description | サーバーの説明の設定を解除します (--os-compute-api- version 2.19 以上でサポートされます) |
70.47. server unshelve
サーバーの退避を解除します
使用方法
openstack server unshelve [-h] [--availability-zone AVAILABILITY_ZONE] <server> [<server> ...]
表70.135 位置引数
値 | 概要 |
---|---|
<server> | 退避を解除するサーバー (名前または ID) |
表70.136 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--availability-zone AVAILABILITY_ZONE | SHELVED_OFFLOADED サーバーの退避を解除するアベイラビリティーゾーンの名前 (--os-compute- api-version 2.77 以上でサポートされます) |
第71章 service
本章では、service
コマンドに含まれるコマンドについて説明します。
71.1. service create
新規サービスを作成します。
使用方法
openstack service create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] [--enable | --disable] <type>
表71.1 位置引数
値 | 概要 |
---|---|
<type> | 新しいサービスの種別 (compute、image、identity、volume など) |
表71.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 新しいサービス名 |
--description <description> | 新しいサービスの説明 |
--enable | サービスを有効にします (デフォルト)。 |
--disable | サービスを無効化します。 |
表71.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表71.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表71.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表71.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
71.2. service delete
サービスを削除します。
使用方法
openstack service delete [-h] <service> [<service> ...]
表71.7 位置引数
値 | 概要 |
---|---|
<service> | 削除するサービス (タイプ、名前、または ID) |
表71.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
71.3. service list
サービスをリスト表示します。
使用方法
openstack service list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
表71.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
表71.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表71.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表71.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表71.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
71.4. service provider create
新規サービスプロバイダーを作成します。
使用方法
openstack service provider create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --auth-url <auth-url> [--description <description>] --service-provider-url <sp-url> [--enable | --disable] <name>
表71.14 位置引数
値 | 概要 |
---|---|
<name> | 新しいサービスプロバイダー名 (一意である必要があります) |
表71.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--auth-url <auth-url> | リモートフェデレーションサービスプロバイダーの認証 URL(必須) |
--description <description> | 新規サービスプロバイダーの説明 |
--service-provider-url <sp-url> | saml アサーションが送信されるサービス URL(必須) |
--enable | サービスプロバイダーを有効にします (デフォルト)。 |
--disable | サービスプロバイダーを無効にします。 |
表71.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表71.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表71.18 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表71.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
71.5. service provider delete
サービスプロバイダーを削除します。
使用方法
openstack service provider delete [-h] <service-provider> [<service-provider> ...]
表71.20 位置引数
値 | 概要 |
---|---|
<service-provider> | 削除するサービスプロバイダー |
表71.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
71.6. service provider list
サービスプロバイダーをリスト表示します。
使用方法
openstack service provider list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表71.22 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表71.23 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表71.24 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表71.25 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表71.26 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
71.7. service provider set
サービスプロバイダーの属性を設定します。
使用方法
openstack service provider set [-h] [--auth-url <auth-url>] [--description <description>] [--service-provider-url <sp-url>] [--enable | --disable] <service-provider>
表71.27 位置引数
値 | 概要 |
---|---|
<service-provider> | 変更するサービスプロバイダー |
表71.28 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--auth-url <auth-url> | リモートフェデレーションサービスプロバイダーの新たな認証 URL |
--description <description> | 新規サービスプロバイダーの説明 |
--service-provider-url <sp-url> | saml アサーションが送信される新しいサービスプロバイダー URL |
--enable | サービスプロバイダーを有効にします。 |
--disable | サービスプロバイダーを無効にします。 |
71.8. service provider show
サービスプロバイダーの詳細を表示します。
使用方法
openstack service provider show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <service-provider>
表71.29 位置引数
値 | 概要 |
---|---|
<service-provider> | 表示するサービスプロバイダー |
表71.30 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表71.31 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表71.32 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表71.33 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表71.34 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
71.9. service set
サービスの属性を設定します。
使用方法
openstack service set [-h] [--type <type>] [--name <service-name>] [--description <description>] [--enable | --disable] <service>
表71.35 位置引数
値 | 概要 |
---|---|
<service> | 変更するサービス (タイプ、名前、または ID) |
表71.36 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--type <type> | 新しいサービスの種別 (compute、image、identity、volume など) |
--name <service-name> | 新しいサービス名 |
--description <description> | 新しいサービスの説明 |
--enable | サービスを有効化します。 |
--disable | サービスを無効化します。 |
71.10. service show
サービスの詳細を表示します。
使用方法
openstack service show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <service>
表71.37 位置引数
値 | 概要 |
---|---|
<service> | 表示するサービス (タイプ、名前、または ID) |
表71.38 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表71.39 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表71.40 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表71.41 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表71.42 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第72章 sfc
本章では、sfc
コマンドに含まれるコマンドについて説明します。
72.1. sfc flow classifier create
フロー分類子を作成します。
使用方法
openstack sfc flow classifier create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--protocol <protocol>] [--ethertype {IPv4,IPv6}] [--source-port <min-port>:<max-port>] [--destination-port <min-port>:<max-port>] [--source-ip-prefix <source-ip-prefix>] [--destination-ip-prefix <destination-ip-prefix>] [--logical-source-port <logical-source-port>] [--logical-destination-port <logical-destination-port>] [--l7-parameters L7_PARAMETERS] <name>
表72.1 位置引数
値 | 概要 |
---|---|
<name> | フロー分類子の名前 |
表72.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | フロー分類の説明 |
--protocol <protocol> | IP プロトコル名。プロトコル名は、iana 標準に従って指定する必要があります。 |
--ethertype {IPv4,IPv6} | L2 ethertype。デフォルトは ipv4 です。 |
--source-port <min-port>:<max-port> | 許容範囲でのソースプロトコルポート (指定できる範囲 [1,65535]。a:b の形で指定する必要があります。ここで、a は最小ポート、b は最大ポートです) |
--destination-port <min-port>:<max-port> | 宛先プロトコルポート (指定できる範囲 [1,65535])。a:b の形で指定する必要があります。ここで、a は最小ポート、b は最大ポートです。 |
--source-ip-prefix <source-ip-prefix> | cidr 表記のソース IP アドレス |
--destination-ip-prefix <destination-ip-prefix> | cidr 表記の宛先 IP アドレス |
--logical-source-port <logical-source-port> | neutron ソースポート (名前または ID) |
--logical-destination-port <logical-destination-port> | Neutron の宛先ポート (名前または ID) |
--l7-parameters L7_PARAMETERS | l7 パラメーターのディクショナリー。現在、このオプションではいずれの値もサポートされません。 |
表72.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表72.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表72.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
72.2. sfc flow classifier delete
指定のフロー分類子を削除します。
使用方法
openstack sfc flow classifier delete [-h] <flow-classifier>
表72.7 位置引数
値 | 概要 |
---|---|
<flow-classifier> | 削除するフロー分類子 (名前または ID) |
表72.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
72.3. sfc flow classifier list
フロー分類子をリスト表示します。
使用方法
openstack sfc flow classifier list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
表72.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
表72.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表72.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表72.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
72.4. sfc flow classifier set
フロー分類子の属性を設定します。
使用方法
openstack sfc flow classifier set [-h] [--name <name>] [--description <description>] <flow-classifier>
表72.14 位置引数
値 | 概要 |
---|---|
<flow-classifier> | 変更するフロー分類子 (名前または ID) |
表72.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | フロー分類子の名前 |
--description <description> | フロー分類の説明 |
72.5. sfc flow classifier show
フロー分類子の詳細を表示します。
使用方法
openstack sfc flow classifier show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <flow-classifier>
表72.16 位置引数
値 | 概要 |
---|---|
<flow-classifier> | 表示するフロー分類子 (名前または ID) |
表72.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表72.18 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表72.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.20 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表72.21 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
72.6. sfc port chain create
ポートチェーンを作成します。
使用方法
openstack sfc port chain create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--flow-classifier <flow-classifier>] [--chain-parameters correlation=<correlation-type>,symmetric=<boolean>] --port-pair-group <port-pair-group> <name>
表72.22 位置引数
値 | 概要 |
---|---|
<name> | ポートチェーンの名前 |
表72.23 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | ポートチェーンの説明 |
--flow-classifier <flow-classifier> | フロー分類子を追加します (名前または id)。このオプションを繰り返すことができます。 |
--chain-parameters correlation=<correlation-type>,symmetric=<boolean> | チェーンパラメーターのディクショナリー。correlation=(mpls|nsh) (デフォルトは mpls) および symmetric=(true|false) をサポートします。 |
--port-pair-group <port-pair-group> | ポートペアのグループを追加します (名前または ID)。このオプションを繰り返すことができます。 |
表72.24 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表72.25 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.26 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表72.27 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
72.7. sfc port chain delete
指定されたポートチェーンを削除します
使用方法
openstack sfc port chain delete [-h] <port-chain>
表72.28 位置引数
値 | 概要 |
---|---|
<port-chain> | 削除するポートチェーン (名前または ID) |
表72.29 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
72.8. sfc port chain list
ポートチェーンのリストを表示します。
使用方法
openstack sfc port chain list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
表72.30 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
表72.31 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表72.32 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表72.33 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.34 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
72.9. sfc port chain set
ポートチェーンの属性を設定します。
使用方法
openstack sfc port chain set [-h] [--name <name>] [--description <description>] [--flow-classifier <flow-classifier>] [--no-flow-classifier] [--port-pair-group <port-pair-group>] [--no-port-pair-group] <port-chain>
表72.35 位置引数
値 | 概要 |
---|---|
<port-chain> | 変更するポートチェーン (名前または ID) |
表72.36 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | ポートチェーンの名前 |
--description <description> | ポートチェーンの説明 |
--flow-classifier <flow-classifier> | フロー分類子を追加します (名前または id)。このオプションを繰り返すことができます。 |
--no-flow-classifier | ポートチェーンから関連するフロー分類子を削除します。 |
--port-pair-group <port-pair-group> | ポートペアのグループを追加します (名前または ID)。現在のポートペアグループの順番が保持され、追加されたポートペアグループはポートチェーンの最後に配置されます。このオプションを繰り返すことができます。 |
--no-port-pair-group | ポートチェーンから関連付けられたポートペアグループを削除します。少なくとも 1 つの --port-pair-group を共に指定する必要があります。 |
72.10. sfc port chain show
ポートチェーンの詳細を表示します。
使用方法
openstack sfc port chain show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <port-chain>
表72.37 位置引数
値 | 概要 |
---|---|
<port-chain> | 表示するポートチェーン (名前または ID) |
表72.38 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表72.39 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表72.40 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.41 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表72.42 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
72.11. sfc port chain unset
ポートチェーン属性の設定を解除します。
使用方法
openstack sfc port chain unset [-h] [--flow-classifier <flow-classifier> | --all-flow-classifier] [--port-pair-group <port-pair-group>] <port-chain>
表72.43 位置引数
値 | 概要 |
---|---|
<port-chain> | 設定を解除するポートチェーン (名前または ID) |
表72.44 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--flow-classifier <flow-classifier> | ポートチェーンからフロー分類子を削除します (名前または ID)。このオプションを繰り返すことができます。 |
--all-flow-classifier | ポートチェーンからすべてのフロー分類子を削除します。 |
--port-pair-group <port-pair-group> | ポートチェーンからポートペアグループを削除します (名前または ID)。このオプションを繰り返すことができます。 |
72.12. sfc port pair create
ポートペアを作成します。
使用方法
openstack sfc port pair create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--service-function-parameters correlation=<correlation-type>,weight=<weight>] --ingress <ingress> --egress <egress> <name>
表72.45 位置引数
値 | 概要 |
---|---|
<name> | ポートペアの名前 |
表72.46 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | ポートペアの説明 |
--service-function-parameters correlation=<correlation-type>,weight=<weight> | サービス関数パラメーターのディクショナリー。現在 correlation=(None|mpls|nsh) および重みがサポートされます。重みは、フローのポートペアグループ内のポートペアの選択に影響を与える整数です。重みが高いほど、より多くのフローがポートペアにハッシュします。デフォルトの重みは 1 です。 |
--ingress <ingress> | 受信 neutron ポート (名前または ID) |
--egress <egress> | 送信 neutron ポート (名前または ID) |
表72.47 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表72.48 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.49 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表72.50 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
72.13. sfc port pair delete
指定のポートペアを削除します。
使用方法
openstack sfc port pair delete [-h] <port-pair>
表72.51 位置引数
値 | 概要 |
---|---|
<port-pair> | 削除するポートペア (名前または ID) |
表72.52 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
72.14. sfc port pair group create
ポートペアグループを作成します。
使用方法
openstack sfc port pair group create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--port-pair <port-pair>] [--enable-tap | --disable-tap] [--port-pair-group-parameters lb-fields=<lb-fields>] <name>
表72.53 位置引数
値 | 概要 |
---|---|
<name> | ポートペアグループの名前 |
表72.54 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | ポートペアグループの説明 |
--port-pair <port-pair> | ポートのペア (名前または ID)。このオプションを繰り返すことができます。 |
--enable-tap | このポートペアグループのポートペアがパッシブタップサービス関数としてデプロイされます。 |
--disable-tap | このポートペアグループのポートペアが l3 サービス関数としてデプロイされます (デフォルト)。 |
--port-pair-group-parameters lb-fields=<lb-fields> | ポートペアグループパラメーターのディクショナリー。現在、1 つのパラメーター lb-fields のみがサポートされます。<lb-fields> は負荷分散フィールドの & 区切りリストです。 |
表72.55 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表72.56 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.57 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表72.58 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
72.15. sfc port pair group delete
指定されたポートペアグループを削除します。
使用方法
openstack sfc port pair group delete [-h] <port-pair-group>
表72.59 位置引数
値 | 概要 |
---|---|
<port-pair-group> | 削除するポートペアグループ (名前または ID) |
表72.60 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
72.16. sfc port pair group list
ポートペアグループをリスト表示します。
使用方法
openstack sfc port pair group list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
表72.61 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
表72.62 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表72.63 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表72.64 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.65 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
72.17. sfc port pair group set
ポートペアグループの属性を設定します。
使用方法
openstack sfc port pair group set [-h] [--name <name>] [--description <description>] [--port-pair <port-pair>] [--no-port-pair] <port-pair-group>
表72.66 位置引数
値 | 概要 |
---|---|
<port-pair-group> | 変更するポートペアグループ (名前または ID) |
表72.67 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | ポートペアグループの名前 |
--description <description> | ポートペアグループの説明 |
--port-pair <port-pair> | ポートのペア (名前または ID)。このオプションを繰り返すことができます。 |
--no-port-pair | ポートペアグループからポートのペアをすべて削除します。 |
72.18. sfc port pair group show
ポートペアグループの詳細を表示します。
使用方法
openstack sfc port pair group show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <port-pair-group>
表72.68 位置引数
値 | 概要 |
---|---|
<port-pair-group> | 表示するポートペアグループ (名前または ID) |
表72.69 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表72.70 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表72.71 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.72 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表72.73 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
72.19. sfc port pair group unset
ポートペアグループからポートペアの設定を解除します。
使用方法
openstack sfc port pair group unset [-h] [--port-pair <port-pair> | --all-port-pair] <port-pair-group>
表72.74 位置引数
値 | 概要 |
---|---|
<port-pair-group> | 設定を解除するポートペアグループ (名前または ID) |
表72.75 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--port-pair <port-pair> | ポートペアグループからポートのペアを削除します (名前または ID)。このオプションを繰り返すことができます。 |
--all-port-pair | ポートペアグループからポートのペアをすべて削除します。 |
72.20. sfc port pair list
ポートペアのリストを表示します。
使用方法
openstack sfc port pair list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
表72.76 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
表72.77 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表72.78 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表72.79 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.80 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
72.21. sfc port pair set
ポートペアの属性を設定します。
使用方法
openstack sfc port pair set [-h] [--name <name>] [--description <description>] <port-pair>
表72.81 位置引数
値 | 概要 |
---|---|
<port-pair> | 変更するポートペア (名前または ID) |
表72.82 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | ポートペアの名前 |
--description <description> | ポートペアの説明 |
72.22. sfc port pair show
ポートペアの詳細を表示します。
使用方法
openstack sfc port pair show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <port-pair>
表72.83 位置引数
値 | 概要 |
---|---|
<port-pair> | 表示するポートペア (名前または ID) |
表72.84 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表72.85 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表72.86 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.87 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表72.88 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
72.23. sfc service graph create
サービスグラフを作成します。
使用方法
openstack sfc service graph create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description DESCRIPTION] --branching-point SRC_CHAIN:DST_CHAIN_1,DST_CHAIN_2,DST_CHAIN_N <name>
表72.89 位置引数
値 | 概要 |
---|---|
<name> | サービスグラフの名前。 |
表72.90 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description DESCRIPTION | サービスグラフの説明。 |
--branching-point SRC_CHAIN:DST_CHAIN_1,DST_CHAIN_2,DST_CHAIN_N | サービスグラフの分岐点: キーは、ソースポートチェーンで、値は宛先ポートチェーンのリストです。このオプションを繰り返すことができます。 |
表72.91 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表72.92 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.93 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表72.94 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
72.24. sfc service graph delete
指定されたサービスグラフを削除します。
使用方法
openstack sfc service graph delete [-h] <service-graph>
表72.95 位置引数
値 | 概要 |
---|---|
<service-graph> | 削除するサービスグラフの ID または名前。 |
表72.96 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
72.25. sfc service graph list
サービスグラフのリストを表示します。
使用方法
openstack sfc service graph list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
表72.97 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
表72.98 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表72.99 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表72.100 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.101 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
72.26. sfc service graph set
サービスグラフの属性を設定します。
使用方法
openstack sfc service graph set [-h] [--name <name>] [--description <description>] <service-graph>
表72.102 位置引数
値 | 概要 |
---|---|
<service-graph> | 変更するサービスグラフ (名前または ID) |
表72.103 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | サービスグラフの名前 |
--description <description> | サービスグラフの説明 |
72.27. sfc service graph show
指定されたサービスグラフの情報を表示します。
使用方法
openstack sfc service graph show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <service-graph>
表72.104 位置引数
値 | 概要 |
---|---|
<service-graph> | 表示するサービスグラフの ID または名前。 |
表72.105 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表72.106 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表72.107 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表72.108 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表72.109 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第73章 ソフトウェア
本章では、software
コマンドに含まれるコマンドについて説明します。
73.1. software config create
ソフトウェア設定を作成します。
使用方法
openstack software config create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--config-file <config-file>] [--definition-file <destination-file>] [--group <group>] <config-name>
表73.1 位置引数
値 | 概要 |
---|---|
<config-name> | 作成するソフトウェア設定の名前 |
表73.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--config-file <config-file> | <inputs>、<outputs>、および <options> を定義するマップが含まれる json/yaml へのパス |
--definition-file <destination-file> | ソフトウェア設定スクリプト/データへのパス |
--group=GROUP | ソフトウェア設定が必要とするツールのグループ名 |
表73.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは json です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表73.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表73.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表73.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
73.2. software config delete
ソフトウェア設定を削除します。
使用方法
openstack software config delete [-h] <config> [<config> ...]
表73.7 位置引数
値 | 概要 |
---|---|
<config> | 削除するソフトウェア設定の ID |
表73.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
73.3. software config list
ソフトウェア設定のリストを表示します。
使用方法
openstack software config list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--limit <limit>] [--marker <id>]
表73.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--limit <limit> | 返される設定の数を制限します。 |
--marker <id> | 指定された設定 ID の後に表示される設定を返します。 |
表73.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表73.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表73.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表73.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
73.4. software config show
ソフトウェア設定の詳細を表示します。
使用方法
openstack software config show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--config-only] <config>
表73.14 位置引数
値 | 概要 |
---|---|
<config> | 設定の ID |
表73.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--config-only | <config> 属性の値のみを表示します。 |
表73.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは yaml です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表73.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表73.18 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表73.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
73.5. software deployment create
ソフトウェアデプロイメントを作成します。
使用方法
openstack software deployment create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--input-value <key=value>] [--action <action>] [--config <config>] [--signal-transport <signal-transport>] [--container <container>] [--timeout <timeout>] --server <server> <deployment-name>
表73.20 位置引数
値 | 概要 |
---|---|
<deployment-name> | このデプロイメントに関連する派生設定の名前。これは、サーバーに現在デプロイされている設定のリストにソート順序を適用するために使用されます。 |
表73.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--input-value <key=value> | デプロイメントに設定する入力値。これは複数回指定できます。 |
--action <action> | このデプロイメントのアクションの名前。カスタムアクション、または CREATE、UPDATE、DELETE、SUSPEND、RESUME のいずれか。デフォルトは UPDATE です。 |
--config <config> | デプロイする設定の ID |
--signal-transport <signal-transport> | デプロイメント出力値を使用して、サーバーが heat にシグナルを送信する方法。TEMP_URL_SIGNAL は、HTTP PUT 経由でシグナル送信する Swift TempURL を作成します。ZAQAR_SIGNAL は、提供された keystone 認証情報を使用してシグラル送信する専用の zaqar キューを作成します。NO_SIGNAL は、シグナルを待たずにリソースを COMPLETE 状態にします。 |
--container <container> | temp_url_signal オブジェクトを保存するオプションのコンテナー名指定しない場合は、DEPLOY_NAME から派生した名前でコンテナーが作成されます。 |
--timeout <timeout> | デプロイメントのタイムアウト (分単位) |
--server <server> | デプロイ先のサーバーの ID |
表73.22 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは yaml です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表73.23 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表73.24 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表73.25 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
73.6. software deployment delete
ソフトウェアデプロイメントおよび依存関係にある設定を削除します。
使用方法
openstack software deployment delete [-h] <deployment> [<deployment> ...]
表73.26 位置引数
値 | 概要 |
---|---|
<deployment> | 削除するデプロイメントの ID。 |
表73.27 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
73.7. software deployment list
ソフトウェアデプロイメントをリスト表示します。
使用方法
openstack software deployment list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--server <server>] [--long]
表73.28 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--server <server> | デプロイメントを取得するサーバーの ID |
--long | 出力でより多くのフィールドをリスト表示します。 |
表73.29 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表73.30 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表73.31 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表73.32 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
73.8. software deployment metadata show
指定されたサーバーのデプロイメント設定のメタデータを取得します。
使用方法
openstack software deployment metadata show [-h] <server>
表73.33 位置引数
値 | 概要 |
---|---|
<server> | デプロイメントを取得するサーバーの ID |
表73.34 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
73.9. software deployment output show
特定のデプロイメント出力を表示します。
使用方法
openstack software deployment output show [-h] [--all] [--long] <deployment> [<output-name>]
表73.35 位置引数
値 | 概要 |
---|---|
<deployment> | 出力を表示するデプロイメントの ID |
<output-name> | 表示する出力の名前 |
表73.36 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all | すべてのデプロイメント出力を表示します。 |
--long | 完全なデプロイメントログを出力に表示します。 |
73.10. software deployment show
ソフトウェアデプロイメントの詳細を表示します。
使用方法
openstack software deployment show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--long] <deployment>
表73.37 位置引数
値 | 概要 |
---|---|
<deployment> | デプロイメントの ID |
表73.38 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力により多くのフィールドを表示します。 |
表73.39 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表73.40 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表73.41 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表73.42 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第74章 stack
本章では、stack
コマンドに含まれるコマンドについて説明します。
74.1. stack abandon
スタックおよび出力の結果を破棄します。
使用方法
openstack stack abandon [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--output-file <output-file>] <stack>
表74.1 位置引数
値 | 概要 |
---|---|
<stack> | 破棄するスタックの名前または ID |
表74.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--output-file <output-file> | 破棄の結果を出力するファイル |
表74.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは json です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.2. stack adopt
スタックを受け入れます。
使用方法
openstack stack adopt [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [-e <environment>] [--timeout <timeout>] [--enable-rollback] [--parameter <key=value>] [--wait] --adopt-file <adopt-file> <stack-name>
表74.7 位置引数
値 | 概要 |
---|---|
<stack-name> | 受け入れるスタックの名前 |
表74.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-e <environment>, --environment <environment> | 環境へのパス。複数回指定できます。 |
--timeout <timeout> | スタック作成のタイムアウト (分単位) |
--enable-rollback | 作成/更新失敗時のロールバックを有効にします。 |
--parameter <key=value> | スタックの作成に使用するパラメーター値。複数回指定できます。 |
--wait | スタックの受け入れが完了するまで待ちます。 |
--adopt-file <adopt-file> | 受け入れスタックデータファイルへのパス |
表74.9 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.10 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.11 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.12 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.3. stack cancel
スタックの現在のタスクを取り消します。取り消しがサポートされるタスク:* 更新 * 作成
使用方法
openstack stack cancel [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--wait] [--no-rollback] <stack> [<stack> ...]
表74.13 位置引数
値 | 概要 |
---|---|
<stack> | 取り消すスタック (名前または ID) |
表74.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait | 取り消しが完了するまで待ちます。 |
--no-rollback | ロールバックせずに取り消します。 |
表74.15 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表74.16 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表74.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.18 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.4. stack check
スタックを確認します。
使用方法
openstack stack check [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--wait] <stack> [<stack> ...]
表74.19 位置引数
値 | 概要 |
---|---|
<stack> | 更新を確認するスタック (名前または ID) |
表74.20 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait | 確認が完了するまで待ちます。 |
表74.21 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表74.22 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表74.23 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.24 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.5. stack create
スタックを作成します。
使用方法
openstack stack create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [-e <environment>] [--timeout <timeout>] [--pre-create <resource>] [--enable-rollback] [--parameter <key=value>] [--parameter-file <key=file>] [--wait] [--tags <tag1,tag2...>] [--dry-run] -t <template> <stack-name>
表74.25 位置引数
値 | 概要 |
---|---|
<stack-name> | 作成するスタックの名前 |
表74.26 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-e <environment>, --environment <environment> | 環境へのパス。複数回指定できます。 |
--timeout <timeout> | スタック作成のタイムアウト (分単位) |
--pre-create <resource> | 作成前フックを設定するリソースの名前。入れ子状のスタックのリソースは、スラッシュを区切り文字として使用して設定できます (例: ``nested_stack/another/my_resource``)。ワイルドカードを使用すると、複数のスタックまたはリソースを照合できます (例:''nested_stack/an*/*_resource'')。これは複数回指定できます。 |
--enable-rollback | 作成/更新失敗時のロールバックを有効にします。 |
--parameter <key=value> | スタックの作成に使用するパラメーター値。これは複数回指定できます。 |
--parameter-file <key=file> | スタックの作成に使用するファイルからのパラメーター値。これは複数回指定できます。パラメーター値は、ファイルのコンテンツです。 |
--wait | スタックが create_complete または CREATE_FAILED になるまで待機します。 |
--tags <tag1,tag2…> | スタックに関連付けるタグのリスト |
--dry-run | 実際にはスタックの作成を行わずに、何が作成されるかを表示します。 |
-t <template>, --template <template> | テンプレートへのパス |
表74.27 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.28 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.29 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.30 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.6. stack delete
スタックを削除します。
使用方法
openstack stack delete [-h] [-y] [--wait] <stack> [<stack> ...]
表74.31 位置引数
値 | 概要 |
---|---|
<stack> | 削除するスタック (名前または ID) |
表74.32 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-y, --yes | yes/no プロンプトを省略します (yes を想定)。 |
--wait | スタックの削除が完了するまで待ちます。 |
74.7. stack environment show
スタックの環境を表示します。
使用方法
openstack stack environment show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <NAME or ID>
表74.33 位置引数
値 | 概要 |
---|---|
<NAME or ID> | クエリーを行うスタックの名前または ID |
表74.34 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表74.35 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは yaml です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.36 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.37 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.38 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.8. stack event list
イベントをリスト表示します。
使用方法
openstack stack event list [-h] [-f {csv,json,log,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--resource <resource>] [--filter <key=value>] [--limit <limit>] [--marker <id>] [--nested-depth <depth>] [--sort <key>[:<direction>]] [--follow] <stack>
表74.39 位置引数
値 | 概要 |
---|---|
<stack> | イベントを表示するスタックの名前または ID |
表74.40 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resource <resource> | イベントを表示するリソースの名前。注記:--nested-depth と共に指定することはできません。 |
--filter <key=value> | 返されたイベントに適用するフィルターパラメーター |
--limit <limit> | 返されるイベントの数を制限します。 |
--marker <id> | 指定の id の後に表示されるイベントのみを返します。 |
--nested-depth <depth> | イベントを表示するネストされたスタックの深さ。注記: これは --resource と共に指定することはできません。 |
--sort <key>[:<direction>] | 選択した鍵と方向 (asc または desc、デフォルト:asc) で出力を並べ替えます。複数のキーでソートするには複数回指定します。ソート用のキーには、"event_time" (デフォルト)、"resource_name"、"links"、"logical_resource_id"、"resource_status"、"resource_status_reason"、"physical_resource_id"、または "id" を使用できます。キーは空のままにし、リバースタイムでソートするために:desc を指定できます。 |
--follow | プロセスが停止するまでイベントを出力します。 |
表74.41 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,log,table,value,yaml}, --format {csv,json,log,table,value,yaml} | 出力形式。デフォルトは log です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表74.42 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表74.43 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.44 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.9. stack event show
イベントの詳細を表示します。
使用方法
openstack stack event show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <stack> <resource> <event>
表74.45 位置引数
値 | 概要 |
---|---|
<stack> | イベントを表示するスタックの名前または ID |
<resource> | イベントが属するリソースの名前 |
<event> | 詳細を表示するイベントの ID |
表74.46 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表74.47 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.48 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.49 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.50 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.10. stack export
スタックデータ json をエクスポートします。
使用方法
openstack stack export [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--output-file <output-file>] <stack>
表74.51 位置引数
値 | 概要 |
---|---|
<stack> | エクスポートするスタックの名前または ID |
表74.52 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--output-file <output-file> | エクスポートデータを出力するファイル |
表74.53 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは json です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.54 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.55 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.56 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.11. stack failures list
障害が発生したスタックリソースに関する情報を表示します。
使用方法
openstack stack failures list [-h] [--long] <stack>
表74.57 位置引数
値 | 概要 |
---|---|
<stack> | 表示するスタック (名前または ID) |
表74.58 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 完全なデプロイメントログを出力に表示します。 |
74.12. stack file list
スタックのファイルマップを表示します。
使用方法
openstack stack file list [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <NAME or ID>
表74.59 位置引数
値 | 概要 |
---|---|
<NAME or ID> | クエリーを行うスタックの名前または ID |
表74.60 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表74.61 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは yaml です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.62 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.63 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.64 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.13. stack hook clear
指定されたスタックでリソースフックをクリアします。
使用方法
openstack stack hook clear [-h] [--pre-create] [--pre-update] [--pre-delete] <stack> <resource> [<resource> ...]
表74.65 位置引数
値 | 概要 |
---|---|
<stack> | 表示するスタック (名前または ID) |
<resource> | クリアするフックがあるリソース名。ネストされたスタックのリソースは、スラッシュを区切り文字 (``nested_stack/another/my_resource``) として使用して設定できます。ワイルドカードを使用すると、複数のスタックまたはリソースを照合できます (例:''nested_stack/an*/*_resource'')。 |
表74.66 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--pre-create | 作成前フックをクリアします |
--pre-update | 更新前フックをクリアします |
--pre-delete | 削除前フックを削除します。 |
74.14. stack hook poll
スタックの保留中のフックを持つリソースをリスト表示します。
使用方法
openstack stack hook poll [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--nested-depth <nested-depth>] <stack>
表74.67 位置引数
値 | 概要 |
---|---|
<stack> | 表示するスタック (名前または ID) |
表74.68 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--nested-depth <nested-depth> | フックを表示するネストされたスタックの深さ。 |
表74.69 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表74.70 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表74.71 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.72 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.15. stack list
スタックをリスト表示します。
使用方法
openstack stack list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--deleted] [--nested] [--hidden] [--property <key=value>] [--tags <tag1,tag2...>] [--tag-mode <mode>] [--limit <limit>] [--marker <id>] [--sort <key>[:<direction>]] [--all-projects] [--short] [--long]
表74.73 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--deleted | スタックリストに、ソフト削除されたスタックを含めます。 |
--nested | スタックリストに、ネスティングされたスタックを含めます。 |
--hidden | スタックリストに、非表示のスタックを含めます。 |
--property <key=value> | 返されたスタックに適用するフィルター属性 (複数の属性で絞り込むには繰り返し指定します) |
--tags <tag1,tag2…> | 絞り込みに使用するタグのリスト。--tag- mode と組み合わせることで、タグのフィルター方法を指定できます。 |
--tag-mode <mode> | タグをフィルタリングする方法。any、not、または not-any のいずれかでなければなりません。指定しない場合、複数のタグをブール値 AND 式で組み合わせます。 |
--limit <limit> | 返されるスタックの数 |
--marker <id> | 指定の id の後に表示されるスタックのみを返します。 |
--sort <key>[:<direction>] | 選択した鍵と方向 (asc または desc、デフォルト:asc) で出力を並べ替えます。複数の属性でソートするには複数回指定します。 |
--all-projects | すべてのプロジェクトを含めます (管理者のみ)。 |
--short | 出力でより少ないフィールドをリスト表示します。 |
--long | 出力の追加フィールドをリスト表示します。これは --all-projects によって暗示されます。 |
表74.74 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表74.75 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表74.76 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.77 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.16. stack output list
スタックの出力をリスト表示します。
使用方法
openstack stack output list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <stack>
表74.78 位置引数
値 | 概要 |
---|---|
<stack> | クエリーを行うスタックの名前または ID |
表74.79 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表74.80 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表74.81 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表74.82 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.83 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.17. stack output show
スタックの出力を表示します。
使用方法
openstack stack output show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all] <stack> [<output>]
表74.84 位置引数
値 | 概要 |
---|---|
<stack> | クエリーを行うスタックの名前または ID |
<output> | 表示する出力の名前 |
表74.85 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all | すべてのスタック出力を表示します。 |
表74.86 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.87 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.88 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.89 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.18. stack resource list
スタックリソースをリスト表示します。
使用方法
openstack stack resource list [-h] [-f {csv,dot,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [-n <nested-depth>] [--filter <key=value>] <stack>
表74.90 位置引数
値 | 概要 |
---|---|
<stack> | クエリーを行うスタックの名前または ID |
表74.91 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | リソースリストの各リソースで提示される詳細情報を有効にする |
-n <nested-depth>, --nested-depth <nested-depth> | リソースを表示するネストされたスタックの深さ。 |
--filter <key=value> | リソースの名前、ステータス、種別、アクション、id、および physical_resource_id をもとに返されるリソースに適用するフィルターパラメーター |
表74.92 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,dot,json,table,value,yaml}, --format {csv,dot,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表74.93 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表74.94 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.95 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.19. stack resource mark unhealthy
リソースの健全性を設定します。
使用方法
openstack stack resource mark unhealthy [-h] [--reset] <stack> <resource> [reason]
表74.96 位置引数
値 | 概要 |
---|---|
<stack> | リソースが属するスタックの名前または ID |
<resource> | リソースの名前 |
reason | 状態変更の理由 |
表74.97 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--reset | リソースを健全として設定します。 |
74.20. stack resource metadata
リソースメタデータを表示します。
使用方法
openstack stack resource metadata [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <stack> <resource>
表74.98 位置引数
値 | 概要 |
---|---|
<stack> | 表示するスタック (名前または ID) |
<resource> | メタデータを表示するリソースの名前 |
表74.99 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表74.100 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは json です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.101 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.102 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.103 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.21. stack resource show
スタックリソースを表示します。
使用方法
openstack stack resource show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--with-attr <attribute>] <stack> <resource>
表74.104 位置引数
値 | 概要 |
---|---|
<stack> | クエリーを行うスタックの名前または ID |
<resource> | リソースの名前 |
表74.105 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--with-attr <attribute> | 表示する属性。複数回指定できます。 |
表74.106 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.107 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.108 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.109 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.22. stack resource signal
オプションのデータを持つリソースにシグナルを送ります。
使用方法
openstack stack resource signal [-h] [--data <data>] [--data-file <data-file>] <stack> <resource>
表74.110 位置引数
値 | 概要 |
---|---|
<stack> | リソースが属するスタックの名前または ID |
<resource> | シグナルを送るリソースの名前 |
表74.111 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--data <data> | シグナルハンドラーに送信する JSON データ |
--data-file <data-file> | シグナルハンドラーに送信する json データが含まれるファイル |
74.23. stack resume
スタックを再開します。
使用方法
openstack stack resume [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--wait] <stack> [<stack> ...]
表74.112 位置引数
値 | 概要 |
---|---|
<stack> | 再開するスタック (名前または ID) |
表74.113 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait | 再開が完了するまで待ちます。 |
表74.114 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表74.115 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表74.116 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.117 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.24. stack show
スタックの詳細を表示します。
使用方法
openstack stack show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--no-resolve-outputs] <stack>
表74.118 位置引数
値 | 概要 |
---|---|
<stack> | 表示するスタック (名前または ID) |
表74.119 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--no-resolve-outputs | スタックの出力を解決しません。 |
表74.120 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.121 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.122 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.123 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.25. stack snapshot create
スタックのスナップショットを作成します。
使用方法
openstack stack snapshot create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] <stack>
表74.124 位置引数
値 | 概要 |
---|---|
<stack> | スタックの名前または ID |
表74.125 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | スナップショットの名前 |
表74.126 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.127 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.128 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.129 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.26. stack snapshot delete
スタックのスナップショットを削除します。
使用方法
openstack stack snapshot delete [-h] [-y] <stack> <snapshot>
表74.130 位置引数
値 | 概要 |
---|---|
<stack> | スタックの名前または ID |
<snapshot> | スタックスナップショットの ID |
表74.131 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-y, --yes | yes/no プロンプトを省略します (yes を想定)。 |
74.27. stack snapshot list
スタックのスナップショットをリスト表示します。
使用方法
openstack stack snapshot list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <stack>
表74.132 位置引数
値 | 概要 |
---|---|
<stack> | スナップショットが含まれるスタックの名前または ID |
表74.133 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表74.134 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表74.135 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表74.136 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.137 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.28. stack snapshot restore
スタックのスナップショットを復元します。
使用方法
openstack stack snapshot restore [-h] <stack> <snapshot>
表74.138 位置引数
値 | 概要 |
---|---|
<stack> | スナップショットが含まれるスタックの名前または ID |
<snapshot> | 復元するスナップショットの ID |
表74.139 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
74.29. stack snapshot show
スタックのスナップショットを表示します。
使用方法
openstack stack snapshot show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <stack> <snapshot>
表74.140 位置引数
値 | 概要 |
---|---|
<stack> | スナップショットが含まれるスタックの名前または ID |
<snapshot> | 表示するスナップショットの ID |
表74.141 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表74.142 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは yaml です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.143 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.144 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.145 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.30. stack suspend
スタックを中断します。
使用方法
openstack stack suspend [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--wait] <stack> [<stack> ...]
表74.146 位置引数
値 | 概要 |
---|---|
<stack> | 中断するスタック (名前または ID) |
表74.147 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--wait | 中断が完了するまで待ちます。 |
表74.148 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表74.149 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表74.150 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.151 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.31. stack template show
スタックのテンプレートを表示します。
使用方法
openstack stack template show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <stack>
表74.152 位置引数
値 | 概要 |
---|---|
<stack> | クエリーを行うスタックの名前または ID |
表74.153 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表74.154 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは yaml です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.155 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.156 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.157 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
74.32. stack update
スタックを更新します。
使用方法
openstack stack update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [-t <template>] [-e <environment>] [--pre-update <resource>] [--timeout <timeout>] [--rollback <value>] [--dry-run] [--show-nested] [--parameter <key=value>] [--parameter-file <key=file>] [--existing] [--clear-parameter <parameter>] [--tags <tag1,tag2...>] [--wait] [--converge] <stack>
表74.158 位置引数
値 | 概要 |
---|---|
<stack> | 更新するスタックの名前または ID |
表74.159 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-t <template>, --template <template> | テンプレートへのパス |
-e <environment>, --environment <environment> | 環境へのパス。複数回指定できます。 |
--pre-update <resource> | 更新前フックを設定するリソースの名前。入れ子状のスタックのリソースは、スラッシュを区切り文字として使用して設定できます (例: ``nested_stack/another/my_resource``)。ワイルドカードを使用すると、複数のスタックまたはリソースを照合できます (例:''nested_stack/an*/*_resource'')。これは複数回指定できます。 |
--timeout <timeout> | スタック更新のタイムアウト (分単位) |
--rollback <value> | 更新の失敗時にロールバックを設定します。値 "enabled" はロールバックを有効に設定します。値 "disabled" はロールバックを無効に設定します。値 keep は、更新する既存のスタックの値を使用します (デフォルト)。 |
--dry-run | 実際にはスタックの更新を行わずに、何が変更されるかを表示します。 |
--show-nested | --dry-run の実行時にネストされたスタックを表示します。 |
--parameter <key=value> | スタックの作成に使用するパラメーター値。これは複数回指定できます。 |
--parameter-file <key=file> | スタックの作成に使用するファイルからのパラメーター値。これは複数回指定できます。パラメーター値は、ファイルのコンテンツです。 |
--existing | 現在のスタックのテンプレート、パラメーター、および環境を再利用します。テンプレートの引数を省略すると、既存のテンプレートが使用されます。--environment を指定しないと、既存の環境が使用されます。--parameter で指定したパラメーターは、現在のスタックの既存の値にパッチを適用します。省略されたパラメーターは既存の値を維持します。 |
--clear-parameter <parameter> | スタックの更新用に、現在のスタックのパラメーターセットからパラメーターを削除します。テンプレートのデフォルト値が使用されます。これは複数回指定できます。 |
--tags <tag1,tag2…> | スタックに関連付ける更新されたタグのリスト |
--wait | スタックが update_complete または UPDATE_FAILED になるまで待機します。 |
--converge | 現実性を観察しながらのスタック更新。 |
表74.160 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表74.161 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表74.162 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表74.163 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第75章 subnet
本章では、subnet
コマンドに含まれるコマンドについて説明します。
75.1. subnet create
サブネットを作成します。
使用方法
openstack subnet create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--project <project>] [--project-domain <project-domain>] [--subnet-pool <subnet-pool> | --use-prefix-delegation USE_PREFIX_DELEGATION | --use-default-subnet-pool] [--prefix-length <prefix-length>] [--subnet-range <subnet-range>] [--dhcp | --no-dhcp] [--gateway <gateway>] [--ip-version {4,6}] [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] [--network-segment <network-segment>] --network <network> [--description <description>] [--allocation-pool start=<ip-address>,end=<ip-address>] [--dns-nameserver <dns-nameserver>] [--host-route destination=<subnet>,gateway=<ip-address>] [--service-type <service-type>] [--tag <tag> | --no-tag] <name>
表75.1 位置引数
値 | 概要 |
---|---|
<name> | 新規サブネット名 |
表75.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--subnet-pool <subnet-pool> | このサブネットが cidr を取得するサブネットプール (名前または ID)。 |
--use-prefix-delegation USE_PREFIX_DELEGATION | ip が ipv6 形式で、ip が外部に委譲される場合は prefix-delegation を使用します。 |
--use-default-subnet-pool | --ip-version のデフォルトのサブネットプールを使用します。 |
--prefix-length <prefix-length> | サブネットプールからのサブネット割り当ての接頭辞長 |
--subnet-range <subnet-range> | cidr 表記のサブネット範囲 (--subnet- pool が指定されていない場合には必須、それ以外の場合はオプション) |
--dhcp | dhcp を有効にします (デフォルト)。 |
--no-dhcp | dhcp を無効にします。 |
--gateway <gateway> | サブネットのゲートウェイを指定します。3 つのオプションは、<ip-address>: ゲートウェイとして使用する特定の IP アドレス、auto: ゲートウェイのアドレスはサブネット自体から自動的に選択される、none: このサブネットはゲートウェイを使用しない、です (例:--gateway 192.168.9.1、--gateway auto、--gateway none(デフォルトは auto))。 |
--ip-version {4,6} | IP バージョン (デフォルトは 4)。サブネットプールが指定されている場合には、サブネットプールから IP バージョンが決定され、このオプションは無視されます。 |
--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} | Ipv6 ra(ルーター広告) モード。有効なモード:[dhcpv6-stateful、dhcpv6-stateless、slaac] |
--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} | Ipv6 アドレスモード。有効なモード:[dhcpv6-stateful、dhcpv6-stateless、slaac] |
--network-segment <network-segment> | このサブネットに関連付けるネットワークセグメント (名前または ID) |
--network <network> | このサブネットが属するネットワーク (名前または ID) |
--description <description> | サブネットの説明を設定します。 |
--allocation-pool start=<ip-address>,end=<ip-address> | このサブネットの割り当てプール IP アドレス (例:start=192.168.199.2,end=192.168.199.254)(複数の IP アドレスを追加する場合はオプションを繰り返し使用します) |
--dns-nameserver <dns-nameserver> | このサブネットの DNS サーバー (複数の DNS サーバーを設定する場合はオプションを繰り返し使用します) |
--host-route destination=<subnet>,gateway=<ip-address> | このサブネットの追加のルート (例:destination=10.10.0.0/16,gateway=192.168.71.254、 destination: 宛先のサブネット (CIDR 表記)、gateway: 次のホップの IP アドレス)(複数のルートを追加する場合はオプションを繰り返し使用します) |
--service-type <service-type> | このサブネットのサービス種別 (例:network:floatingip_agent_gateway)。ネットワークポートの有効なデバイス所有者の値でなければなりません (複数のサービス種別を設定する場合はオプションを繰り返し使用します)。 |
--tag <tag> | サブネットに追加されるタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--no-tag | サブネットにタグを関連付けません。 |
表75.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表75.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表75.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表75.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
75.2. subnet delete
サブネットを削除します。
使用方法
openstack subnet delete [-h] <subnet> [<subnet> ...]
表75.7 位置引数
値 | 概要 |
---|---|
<subnet> | 削除するサブネット (名前または ID) |
表75.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
75.3. subnet list
サブネットをリスト表示します。
使用方法
openstack subnet list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--ip-version <ip-version>] [--dhcp | --no-dhcp] [--service-type <service-type>] [--project <project>] [--project-domain <project-domain>] [--network <network>] [--gateway <gateway>] [--name <name>] [--subnet-range <subnet-range>] [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]] [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]]
表75.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
--ip-version <ip-version> | 出力に、指定した ip バージョンのサブネットのみをリスト表示します。IP バージョンに使用可能な値は 4 および 6 です。 |
--dhcp | dhcp が有効になっているサブネットをリスト表示します。 |
--no-dhcp | dhcp が無効になっているサブネットをリスト表示します。 |
--service-type <service-type> | 出力に、指定のサービス種別のサブネットのみをリスト表示します (例:network:floatingip_agent_gateway)。ネットワークポートの有効なデバイス所有者の値でなければなりません (複数のサービス種別をリスト表示する場合はオプションを繰り返し使用します)。 |
--project <project> | 出力に、指定のプロジェクトに属するサブネットのみをリスト表示します (名前または ID)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--network <network> | 出力に、指定のネットワークに属するサブネットのみをリスト表示します (名前または ID)。 |
--gateway <gateway> | 出力に、指定したゲートウェイのサブネットのみをリスト表示します。 |
--name <name> | 出力に、指定した名前のサブネットのみをリスト表示します。 |
--subnet-range <subnet-range> | 出力に、指定のサブネット範囲 (cidr 表記) のサブネットのみをリスト表示します (例:--subnet-range 10.10.0.0/16)。 |
--tags <tag>[,<tag>,…] | 指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたサブネットをリスト表示します。 |
--any-tags <tag>[,<tag>,…] | 指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたサブネットをリスト表示します。 |
--not-tags <tag>[,<tag>,…] | 指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたサブネットを除外します。 |
--not-any-tags <tag>[,<tag>,…] | 指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたサブネットを除外します。 |
表75.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表75.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表75.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表75.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
75.4. subnet pool create
サブネットプールを作成します。
使用方法
openstack subnet pool create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --pool-prefix <pool-prefix> [--default-prefix-length <default-prefix-length>] [--min-prefix-length <min-prefix-length>] [--max-prefix-length <max-prefix-length>] [--project <project>] [--project-domain <project-domain>] [--address-scope <address-scope>] [--default | --no-default] [--share | --no-share] [--description <description>] [--default-quota <num-ip-addresses>] [--tag <tag> | --no-tag] <name>
表75.14 位置引数
値 | 概要 |
---|---|
<name> | 新規サブネットプールの名前 |
表75.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--pool-prefix <pool-prefix> | サブネットプールの接頭辞 (cidr 表記) を設定します (複数の接頭辞を設定する場合はオプションを繰り返し使用します)。 |
--default-prefix-length <default-prefix-length> | サブネットプールのデフォルト接頭辞長を設定します。 |
--min-prefix-length <min-prefix-length> | サブネットプールの最小接頭辞長を設定します。 |
--max-prefix-length <max-prefix-length> | サブネットプールの最大接頭辞長を設定します。 |
--project <project> | 所有者のプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--address-scope <address-scope> | サブネットプールに関連付けられたアドレススコープを設定します (名前または ID)。接頭辞は、アドレススコープ全体で一意でなければなりません。 |
--default | これをデフォルトのサブネットプールとして設定します。 |
--no-default | これをデフォルト以外のサブネットプールとして設定します。 |
--share | このサブネットプールを共有として設定します。 |
--no-share | このサブネットプールを非共有として設定します。 |
--description <description> | サブネットプールの説明を設定します。 |
--default-quota <num-ip-addresses> | このサブネットプールのデフォルトのプロジェクトクォータを、サブネットプールから割り当て可能な IP アドレスの数として設定します。 |
--tag <tag> | サブネットプールに追加されるタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--no-tag | サブネットプールにタグを関連付けません。 |
表75.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表75.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表75.18 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表75.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
75.5. subnet pool delete
サブネットプールを削除します。
使用方法
openstack subnet pool delete [-h] <subnet-pool> [<subnet-pool> ...]
表75.20 位置引数
値 | 概要 |
---|---|
<subnet-pool> | 削除するサブネットプール (名前または ID) |
表75.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
75.6. subnet pool list
サブネットプールをリスト表示します。
使用方法
openstack subnet pool list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--share | --no-share] [--default | --no-default] [--project <project>] [--project-domain <project-domain>] [--name <name>] [--address-scope <address-scope>] [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]] [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]]
表75.22 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
--share | プロジェクト間で共有されるサブネットプールをリスト表示します。 |
--no-share | プロジェクト間で共有されないサブネットプールをリスト表示します。 |
--default | デフォルトの外部サブネットプールとして使用されるサブネットプールをリスト表示します。 |
--no-default | デフォルトの外部サブネットプールとして使用されないサブネットプールをリスト表示します。 |
--project <project> | プロジェクトに従ってサブネットプールをリスト表示します (名前または ID)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--name <name> | 出力に、指定した名前のサブネットプールのみをリスト表示します。 |
--address-scope <address-scope> | 出力に、指定したアドレススコープのサブネットプールのみをリスト表示します (名前または ID)。 |
--tags <tag>[,<tag>,…] | 指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたサブネットプールをリスト表示します。 |
--any-tags <tag>[,<tag>,…] | 指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたサブネットプールをリスト表示します。 |
--not-tags <tag>[,<tag>,…] | 指定したすべてのタグ (タグのコンマ区切りリスト) が設定されたサブネットプールを除外します。 |
--not-any-tags <tag>[,<tag>,…] | 指定したタグ (タグのコンマ区切りリスト) のいずれかが設定されたサブネットプールを除外します。 |
表75.23 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表75.24 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表75.25 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表75.26 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
75.7. subnet pool set
サブネットプールの属性を設定します。
使用方法
openstack subnet pool set [-h] [--name <name>] [--pool-prefix <pool-prefix>] [--default-prefix-length <default-prefix-length>] [--min-prefix-length <min-prefix-length>] [--max-prefix-length <max-prefix-length>] [--address-scope <address-scope> | --no-address-scope] [--default | --no-default] [--description <description>] [--default-quota <num-ip-addresses>] [--tag <tag>] [--no-tag] <subnet-pool>
表75.27 位置引数
値 | 概要 |
---|---|
<subnet-pool> | 変更するサブネットプール (名前または ID) |
表75.28 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | サブネットプールの名前を設定します。 |
--pool-prefix <pool-prefix> | サブネットプールの接頭辞 (cidr 表記) を設定します (複数の接頭辞を設定する場合はオプションを繰り返し使用します)。 |
--default-prefix-length <default-prefix-length> | サブネットプールのデフォルト接頭辞長を設定します。 |
--min-prefix-length <min-prefix-length> | サブネットプールの最小接頭辞長を設定します。 |
--max-prefix-length <max-prefix-length> | サブネットプールの最大接頭辞長を設定します。 |
--address-scope <address-scope> | サブネットプールに関連付けられたアドレススコープを設定します (名前または ID)。接頭辞は、アドレススコープ全体で一意でなければなりません。 |
--no-address-scope | サブネットプールに関連付けられたアドレススコープを削除します。 |
--default | これをデフォルトのサブネットプールとして設定します。 |
--no-default | これをデフォルト以外のサブネットプールとして設定します。 |
--description <description> | サブネットプールの説明を設定します。 |
--default-quota <num-ip-addresses> | このサブネットプールのデフォルトのプロジェクトクォータを、サブネットプールから割り当て可能な IP アドレスの数として設定します。 |
--tag <tag> | サブネットプールに追加されるタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--no-tag | サブネットプールに関連付けられたタグをクリアします。現在のタグを上書きするには、--tag と --no-tag の両方を指定します |
75.8. subnet pool show
サブネットプールの詳細を表示します。
使用方法
openstack subnet pool show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <subnet-pool>
表75.29 位置引数
値 | 概要 |
---|---|
<subnet-pool> | 表示するサブネットプール (名前または ID) |
表75.30 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表75.31 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表75.32 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表75.33 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表75.34 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
75.9. subnet pool unset
サブネットプール属性の設定を解除します。
使用方法
openstack subnet pool unset [-h] [--tag <tag> | --all-tag] <subnet-pool>
表75.35 位置引数
値 | 概要 |
---|---|
<subnet-pool> | 変更するサブネットプール (名前または ID) |
表75.36 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--tag <tag> | サブネットプールから削除するタグ (複数のタグを削除する場合はオプションを繰り返し使用します) |
--all-tag | サブネットプールに関連付けられたすべてのタグをクリアします |
75.10. subnet set
サブネットの属性を設定します。
使用方法
openstack subnet set [-h] [--name <name>] [--dhcp | --no-dhcp] [--gateway <gateway>] [--network-segment <network-segment>] [--description <description>] [--tag <tag>] [--no-tag] [--allocation-pool start=<ip-address>,end=<ip-address>] [--no-allocation-pool] [--dns-nameserver <dns-nameserver>] [--no-dns-nameservers] [--host-route destination=<subnet>,gateway=<ip-address>] [--no-host-route] [--service-type <service-type>] <subnet>
表75.37 位置引数
値 | 概要 |
---|---|
<subnet> | 変更するサブネット (名前または ID) |
表75.38 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | サブネットの更新された名前 |
--dhcp | dhcp を有効にします。 |
--no-dhcp | dhcp を無効にします。 |
--gateway <gateway> | サブネットのゲートウェイを指定します。オプションは、<ip-address>: ゲートウェイとして使用する特定の IP アドレス、none: このサブネットはゲートウェイを使用しない、です (例:--gateway 192.168.9.1、--gateway none)。 |
--network-segment <network-segment> |
このサブネットに関連付けるネットワークセグメント (名前または ID)現在の値が |
--description <description> | サブネットの説明を設定します。 |
--tag <tag> | サブネットに追加されるタグ (複数のタグを設定する場合はオプションを繰り返し使用します) |
--no-tag | サブネットに関連付けられたタグをクリアします。現在のタグを上書きするには、--tag と --no-tag の両方を指定します。 |
--allocation-pool start=<ip-address>,end=<ip-address> | このサブネットの割り当てプール IP アドレス (例:start=192.168.199.2,end=192.168.199.254)(複数の IP アドレスを追加する場合はオプションを繰り返し使用します) |
--no-allocation-pool | サブネットから、関連付けられた allocation-pool をクリアします。現在の割り当てプール情報を上書きするには、--allocation-pool と --no-allocation- pool の両方を指定します。 |
--dns-nameserver <dns-nameserver> | このサブネットの DNS サーバー (複数の DNS サーバーを設定する場合はオプションを繰り返し使用します) |
--no-dns-nameservers | dns ネームサーバーの既存の情報をクリアします。現在の DNS ネームサーバーの情報を上書きするには、--dns-nameserver と --no-dns-nameserver の両方を指定します。 |
--host-route destination=<subnet>,gateway=<ip-address> | このサブネットの追加のルート (例:destination=10.10.0.0/16,gateway=192.168.71.254、 destination: 宛先のサブネット (CIDR 表記)、gateway: 次のホップの IP アドレス)(複数のルートを追加する場合はオプションを繰り返し使用します) |
--no-host-route | サブネットから関連するホストルートをクリアします。現在のホストルート情報を上書きするには、--host-route と --no-host-route の両方を指定します。 |
--service-type <service-type> | このサブネットのサービス種別 (例:network:floatingip_agent_gateway)。ネットワークポートの有効なデバイス所有者の値でなければなりません (複数のサービス種別を設定する場合はオプションを繰り返し使用します)。 |
75.11. subnet show
サブネットの詳細を表示します。
使用方法
openstack subnet show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <subnet>
表75.39 位置引数
値 | 概要 |
---|---|
<subnet> | 表示するサブネット (名前または ID) |
表75.40 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表75.41 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表75.42 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表75.43 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表75.44 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
75.12. subnet unset
サブネット属性の設定を解除します。
使用方法
openstack subnet unset [-h] [--allocation-pool start=<ip-address>,end=<ip-address>] [--dns-nameserver <dns-nameserver>] [--host-route destination=<subnet>,gateway=<ip-address>] [--service-type <service-type>] [--tag <tag> | --all-tag] <subnet>
表75.45 位置引数
値 | 概要 |
---|---|
<subnet> | 変更するサブネット (名前または ID) |
表75.46 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--allocation-pool start=<ip-address>,end=<ip-address> | このサブネットから削除する割り当てプール IP アドレス (例:start=192.168.199.2,end=192.168.199.254)(複数の割り当てプールの設定を解除する場合はオプションを繰り返し使用します) |
--dns-nameserver <dns-nameserver> | このサブネットから削除する DNS サーバー (複数の DNS サーバーの設定を解除する場合はオプションを繰り返し使用します) |
--host-route destination=<subnet>,gateway=<ip-address> | このサブネットから削除するルート (例:destination=10.10.0.0/16,gateway=192.168.71.254、 destination: 宛先のサブネット (CIDR 表記)、gateway: 次のホップの IP アドレス)(複数のホストルートの設定を解除する場合はオプションを繰り返し使用します) |
--service-type <service-type> | このサブネットから削除するサービス種別 (例:network:floatingip_agent_gateway)。ネットワークポートの有効なデバイス所有者の値でなければなりません (複数のサービス種別の設定を解除する場合はオプションを繰り返し使用します)。 |
--tag <tag> | サブネットから削除するタグ (複数のタグを削除する場合はオプションを繰り返し使用します) |
--all-tag | サブネットに関連付けられたすべてのタグをクリアします |
第76章 task
本章では、task
コマンドに含まれるコマンドについて説明します。
76.1. task execution list
全タスクをリスト表示します。
使用方法
openstack task execution list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS] [--oldest] [workflow_execution]
表76.1 位置引数
値 | 概要 |
---|---|
workflow_execution | タスクのリストに関連付けられたワークフロー実行 ID。 |
表76.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 | フィルター。繰り返し使用できます。 |
--oldest | 最新のエントリーからではなく、最も古いエントリーから開始する実行を表示します。 |
表76.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表76.4 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表76.5 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表76.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
76.2. task execution published show
タスクが公開した変数を表示します。
使用方法
openstack task execution published show [-h] id
表76.7 位置引数
値 | 概要 |
---|---|
id | タスク ID |
表76.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
76.3. task execution rerun
既存タスクを再度実行します。
使用方法
openstack task execution rerun [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--resume] [-e ENV] id
表76.9 位置引数
値 | 概要 |
---|---|
id | タスクの識別子 |
表76.10 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--resume | with-items タスクで失敗または開始されていないアクション実行だけを再実行します。 |
-e ENV、--env ENV | 環境変数 |
表76.11 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表76.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表76.13 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表76.14 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
76.4. task execution result show
タスクの出力データを表示します。
使用方法
openstack task execution result show [-h] id
表76.15 位置引数
値 | 概要 |
---|---|
id | タスク ID |
表76.16 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
76.5. task execution show
特定のタスクを表示します。
使用方法
openstack task execution show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] task
表76.17 位置引数
値 | 概要 |
---|---|
task | タスクの識別子 |
表76.18 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表76.19 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表76.20 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表76.21 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表76.22 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第77章 tld
本章では、tld
コマンドに含まれるコマンドについて説明します。
77.1. tld create
新規 tld を作成します。
使用方法
openstack tld create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --name NAME [--description DESCRIPTION] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
表77.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name NAME | TLD 名 |
--description DESCRIPTION | 説明 |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表77.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表77.3 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表77.4 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表77.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
77.2. tld delete
tld を削除します。
使用方法
openstack tld delete [-h] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表77.6 位置引数
値 | 概要 |
---|---|
id | TLD id |
表77.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
77.3. tld list
tld をリスト表示します。
使用方法
openstack tld list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name NAME] [--description DESCRIPTION] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
表77.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name NAME | TLD 名 |
--description DESCRIPTION | TLD の説明 |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表77.9 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表77.10 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表77.11 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表77.12 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
77.4. tld set
tld の属性を設定します。
使用方法
openstack tld set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name NAME] [--description DESCRIPTION | --no-description] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表77.13 位置引数
値 | 概要 |
---|---|
id | TLD id |
表77.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name NAME | TLD 名 |
--description DESCRIPTION | 説明 |
--no-description—all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表77.15 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表77.16 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表77.17 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表77.18 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
77.5. tld show
tld の詳細を表示します。
使用方法
openstack tld show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表77.19 位置引数
値 | 概要 |
---|---|
id | TLD id |
表77.20 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表77.21 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表77.22 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表77.23 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表77.24 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第78章 トークン (token)
本章では、token
コマンドに含まれるコマンドについて説明します。
78.1. token issue
新しいトークンを発行します。
使用方法
openstack token issue [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
表78.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表78.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表78.3 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表78.4 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表78.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
78.2. token revoke
既存のトークンを取り消します。
使用方法
openstack token revoke [-h] <token>
表78.6 位置引数
値 | 概要 |
---|---|
<token> | 削除するトークン |
表78.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
第79章 tripleo
本章では、tripleo
コマンドに含まれるコマンドについて説明します。
79.1. tripleo config generate ansible
デプロイメント用のデフォルトの ansible.cfg を生成します。
使用方法
openstack tripleo config generate ansible [--deployment-user DEPLOYMENT_USER] [--output-dir OUTPUT_DIR]
表79.1 コマンド引数
値 | 概要 |
---|---|
--deployment-user DEPLOYMENT_USER | tripleo config generate コマンドを実行するユーザー。デフォルトは stack です。 |
--output-dir OUTPUT_DIR | ansible.cfg ファイルおよび ansible.log ファイルを出力するディレクトリー。 |
79.2. tripleo container image build
tripleo-ansible を使用して tripleo コンテナーイメージをビルドします。
使用方法
openstack tripleo container image build [-h] [--authfile <authfile>] [--base <base-image>] [--config-file <config-file>] [--config-path <config-path>] [--distro <distro>] [--exclude <container-name>] [--extra-config <extra-config>] [--namespace <registry-namespace>] [--registry <registry-url>] [--skip-build] [--tag <image-tag>] [--prefix <image-prefix>] [--push] [--label <label-data>] [--volume <volume-path>] [--work-dir <work-directory>] [--rhel-modules <rhel-modules>]
表79.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--authfile <authfile> | 認証ファイルのパス。上書きするには REGISTRY_AUTH_FILE 環境変数を使用します (デフォルト:/root/containers/auth.json)。 |
--base <base-image> | オプションのバージョンを含むベースイメージ名。centos:8 を指定できます。ベースイメージ名は centos ですが、centos:8 はベースイメージをビルドするためにプルされます (デフォルト:ubi8)。 |
--config-file <config-file> | ビルドするイメージを指定する yaml 設定ファイル (デフォルト:tripleo_containers.yaml) |
--config-path <config-path> | ベース設定パス。これは、すべてのコンテナーイメージファイルのベースパスです。定義されたコンテナーは、このパスにある tcib フォルダー内になければなりません。このオプションが設定されると、<config-file> のデフォルトパスが変更されます (デフォルト:/usr/share/tripleo- common/container-images)。 |
--distro <distro> | ディストリビューション名。未定義の場合、システムはホストのディストリビューションを使用してビルドします (デフォルト:centos)。 |
--exclude <container-name> | ビルドをスキップするコンテナーのリストに対して一致するコンテナーの名前。複数のコンテナーを省略する場合は複数回指定する必要があります (デフォルト:[])。 |
--extra-config <extra-config> | 指定された設定 YAML ファイルから追加オプションを適用します。これはすべてのコンテナービルドに適用されます (デフォルト:None)。 |
--namespace <registry-namespace> | コンテナーレジストリーの名前空間 (デフォルト:tripleotrain) |
--registry <registry-url> | コンテナーレジストリーの URL(デフォルト:localhost) |
--skip-build | イメージのビルドをスキップかどうか (デフォルト:false)。 |
--tag <image-tag> | イメージタグ (デフォルト:latest) |
--prefix <image-prefix> | イメージの接頭辞 (デフォルト:openstack) |
--push | 指定されたレジストリーへのイメージのプッシュを有効にします (デフォルト:False)。 |
--label <label-data> | コンテナーにラベルを追加します。このオプションは複数回指定できます。各ラベルは key=value のペアです。 |
--volume <volume-path> | イメージのビルド時に使用するコンテナーバインドマウント。複数ボリュームの場合は、複数回指定する必要があります (デフォルト:[/etc/yum.repos.d:/etc/distro.repos.d:z、/etc/pki/rpm-gpg:/etc/pki/rpm-gpg:z])。 |
--work-dir <work-directory> | TripleO コンテナービルドディレクトリー。各イメージおよびその依存関係の設定およびログを保存します (デフォルト: /tmp/container-builds)。 |
--rhel-modules <rhel-modules> | 有効にする rhel モジュールおよびバージョンのコンマ区切りリスト例:mariadb:10.3,virt:8.3 |
79.3. tripleo container image delete
レジストリーから指定されたイメージを削除します。
使用方法
openstack tripleo container image delete [-h] [--registry-url <registry url>] [--username <username>] [--password <password>] [-y] <image to delete>
表79.3 位置引数
値 | 概要 |
---|---|
<image to delete> | 削除されるイメージのフル URL (形式: <fqdn>:<port>/path/to/image) |
表79.4 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--registry-url <registry url> | イメージをリスト表示するレジストリーの URL (形式: <fqdn>:<port>) |
--username <username> | イメージレジストリーのユーザー名。 |
--password <password> | イメージレジストリーのパスワード。 |
-y, --yes | yes/no プロンプトを省略します (yes を想定)。 |
79.4. tripleo container image hotfix
tripleo-ansible を使用して tripleo コンテナーイメージにホットフィックスを適用します。
使用方法
openstack tripleo container image hotfix [-h] --image <images> --rpms-path <rpms-path> [--tag <image-tag>]
表79.5 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--image <images> | 変更するソースイメージへの完全修飾参照。複数回指定することができます (イメージごとに 1 つ)。(デフォルト:[])。 |
--rpms-path <rpms-path> | インストールする rpm が含まれるパス (デフォルト:none) |
--tag <image-tag> | イメージのホットフィックスのタグ (デフォルト:latest) |
79.5. tripleo container image list
レジストリーで検出されたイメージをリスト表示します。
使用方法
openstack tripleo container image list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--registry-url <registry url>] [--username <username>] [--password <password>]
表79.6 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--registry-url <registry url> | イメージをリスト表示するレジストリーの URL (形式: <fqdn>:<port>) |
--username <username> | イメージレジストリーのユーザー名。 |
--password <password> | イメージレジストリーのパスワード。 |
表79.7 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表79.8 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表79.9 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表79.10 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
79.6. tripleo container image prepare default
デフォルトの ContainerImagePrepare パラメーターを生成します。
使用方法
openstack tripleo container image prepare default [-h] [--output-env-file <file path>] [--local-push-destination] [--enable-registry-login]
表79.11 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--output-env-file <file path> | デフォルトの ContainerImagePrepare 値が含まれる環境ファイルを書き込むファイル。 |
--local-push-destination | ローカルレジストリーへのアップロードをトリガーする push_destination を追加します。 |
--enable-registry-login | このフラグを使用して、コンテナーをプルする前にシステムがリモートレジストリーにログインできるようにします。--local-push-destination が使用されておらず、ターゲットシステムにリモートレジストリーへのネットワーク接続がある場合に、このフラグを使用する必要があります。リモートレジストリーへのネットワーク接続がないオーバークラウドの場合、このオプションを使用しないでください。 |
79.7. tripleo container image prepare
1 つのコマンドからコンテナーを準備してアップロードします。
使用方法
openstack tripleo container image prepare [-h] [--environment-file <file path>] [--environment-directory <HEAT ENVIRONMENT DIRECTORY>] [--roles-file ROLES_FILE] [--output-env-file <file path>] [--dry-run] [--cleanup <full, partial, none>]
表79.12 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--environment-file <file path>, -e <file path> | すべての準備アクションを指定する containerimageprepare パラメーターが含まれる環境ファイル。どのサービスをコンテナー化するかを指定する環境ファイルも追加します。エントリーは、コンテナー化されるサービスで使用されるイメージのみを含むようにフィルターされます。(複数回指定することが可能です。) |
--environment-directory <HEAT ENVIRONMENT DIRECTORY> | 環境に自動的に追加される環境ファイルのディレクトリー。複数回指定することが可能です。ディレクトリー内のファイルは、昇順で読み込まれます。 |
--roles-file ROLES_FILE, -r ROLES_FILE | ロールファイル。デプロイメントに使用する t-h-t templates ディレクトリーのデフォルトの roles_data.yaml を上書きします。絶対パスまたは templates ディレクトリーへの相対パスを指定できます。 |
--output-env-file <file path> | すべてのイメージパラメーターを指定する heat 環境ファイルを書き込むファイル。既存のファイルは上書きされます。 |
--dry-run | プル、変更、またはプッシュ操作を実行しません。ただし、これらの操作が実施されたかのように、環境ファイルが反映されます。 |
--cleanup <full, partial, none> | アップロード後に残されたローカルイメージの動作をクリーンアップします。デフォルトの full は、すべてのローカルイメージの削除を試行します。partial は、このホストでのデプロイメントに必要なイメージを残します。noneは、クリーンアップを実行しません。 |
79.8. tripleo container image push
指定されたイメージをレジストリーにプッシュします。
使用方法
openstack tripleo container image push [-h] [--local] [--registry-url <registry url>] [--append-tag APPEND_TAG] [--username <username>] [--password <password>] [--source-username <source_username>] [--source-password <source_password>] [--dry-run] [--multi-arch] [--cleanup] <image to push>
表79.13 位置引数
値 | 概要 |
---|---|
<image to push> | アップロードするコンテナーイメージ。<registry>/<namespace>/<name>:<tag> の形式にする必要があります。タグが指定されていない場合は、latest が使用されます。 |
表79.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--local | コンテナーイメージが現在のシステムにすでにあり、リモートレジストリーからプルする必要がない場合は、このフラグを使用します。 |
--registry-url <registry url> | <fqdn>:<port> 形式のプッシュ先レジストリーの URL。 |
--append-tag APPEND_TAG | コンテナーのプッシュ時に既存のタグに追加するタグ。 |
--username <username> | プッシュ先イメージレジストリーのユーザー名。 |
--password <password> | プッシュ先イメージレジストリーのパスワード。 |
--source-username <source_username> | ソースイメージレジストリーのユーザー名。 |
--source-password <source_password> | ソースイメージレジストリーのパスワード |
--dry-run | アップロードのドライランを実行します。アップロードアクションは実行されませんが、認証プロセスが試行されます。 |
--multi-arch | アップロードのマルチアーキテクチャーサポートを有効にします。 |
--cleanup | アップロード後にイメージのローカルコピーを削除します。 |
79.9. tripleo container image show
レジストリーから選択したイメージを表示します。
使用方法
openstack tripleo container image show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--username <username>] [--password <password>] <image to inspect>
表79.15 位置引数
値 | 概要 |
---|---|
<image to inspect> | 検査するイメージ (docker.io/library/centos:7 または docker://docker.io/library/centos:7 など) |
表79.16 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--username <username> | イメージレジストリーのユーザー名。 |
--password <password> | イメージレジストリーのパスワード。 |
表79.17 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは json です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表79.18 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表79.19 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表79.20 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
79.10. tripleo deploy
コンテナー化されたアンダークラウドをデプロイします。
使用方法
openstack tripleo deploy [--templates [TEMPLATES]] [--standalone] [--upgrade] [-y] [--stack STACK] [--output-dir OUTPUT_DIR] [--output-only] [--standalone-role STANDALONE_ROLE] [-t <TIMEOUT>] [-e <HEAT ENVIRONMENT FILE>] [--roles-file ROLES_FILE] [--networks-file NETWORKS_FILE] [--plan-environment-file PLAN_ENVIRONMENT_FILE] [--heat-api-port <HEAT_API_PORT>] [--heat-user <HEAT_USER>] [--deployment-user DEPLOYMENT_USER] [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER] [--heat-container-image <HEAT_CONTAINER_IMAGE>] [--heat-native [HEAT_NATIVE]] [--local-ip <LOCAL_IP>] [--control-virtual-ip <CONTROL_VIRTUAL_IP>] [--public-virtual-ip <PUBLIC_VIRTUAL_IP>] [--local-domain <LOCAL_DOMAIN>] [--cleanup] [--hieradata-override [HIERADATA_OVERRIDE]] [--keep-running] [--inflight-validations] [--ansible-forks ANSIBLE_FORKS] [--force-stack-update | --force-stack-create]
表79.21 コマンド引数
値 | 概要 |
---|---|
--templates [TEMPLATES] | デプロイする Heat テンプレートが格納されているディレクトリー。 |
--standalone | アンダークラウドを持たないスタンドアロンデプロイメントとしてデプロイメントを実行します。 |
--upgrade | 既存のデプロイメントをアップグレードします。 |
-y, --yes | yes/no プロンプトを省略します (yes を想定)。 |
--stack STACK | 一時 (一時的に作成して破棄する)heat スタックの名前 |
--output-dir OUTPUT_DIR | 状態、処理された heat テンプレート、Ansible デプロイメントファイルを出力するディレクトリー。 |
--output-only | Ansible Playbook は実行されません。デフォルトでは、Playbook は output-dir に保存され、その後実行されます。 |
--standalone-role STANDALONE_ROLE | デプロイメントのアクションを反映するときに、スタンドアロン設定に使用するロール。 |
-t <TIMEOUT>, --timeout <TIMEOUT> | デプロイメントのタイムアウト (分単位) |
-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE> | heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。) |
--roles-file ROLES_FILE, -r ROLES_FILE | ロールファイル。デプロイメントに使用する t-h-t templates ディレクトリーのデフォルトの roles_data_undercloud.yaml を上書きします。絶対パスまたは templates ディレクトリーへの相対パスを指定できます。 |
--networks-file NETWORKS_FILE, -n NETWORKS_FILE | ロールファイル。デプロイメントに使用する t-h-t templates ディレクトリーのデフォルトの /dev/null を上書きします。絶対パスまたは templates ディレクトリーへの相対パスを指定できます。 |
--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE | プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。 |
--heat-api-port <HEAT_API_PORT> | インストーラーのプライベート heat API インスタンスに使用する heat api ポートオプション: デフォルト: 8006。 |
--heat-user <HEAT_USER> | 非特権 heat-all プロセスを実行するユーザー。デフォルトは heat です。 |
--deployment-user DEPLOYMENT_USER | tripleo deploy コマンドを実行するユーザー。デフォルトは $SUDO_USER です。$SUDO_USER が設定されていない場合は、デフォルトで stack に設定されます。 |
--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER | デプロイメントアクションに使用する Python インタープリターへのパス。指定しない場合は、openstackclient の python バージョンが使用されます。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。 |
--heat-container-image <HEAT_CONTAINER_IMAGE> | heat-all プロセスの起動時に使用するコンテナーイメージデフォルト:tripleomaster/centos-binary- heat-all:current-tripleo です。 |
--heat-native [HEAT_NATIVE] | このホストで heat-all プロセスをネイティブに実行します。このオプションは、heat-all バイナリーをこのマシンにローカルにインストールすることを要求します。このオプションはデフォルトで有効になっています。したがって、heat-all はホスト OS 上で直接実行されます。 |
--local-ip <LOCAL_IP> | アンダークラウドトラフィックのローカルの ip/cidr (必須) |
--control-virtual-ip <CONTROL_VIRTUAL_IP> | コントロールプレーンの仮想 IP。これにより、アンダークラウドのインストーラーはコントロールプレーンにカスタム仮想 IP を設定できます。 |
--public-virtual-ip <PUBLIC_VIRTUAL_IP> | パブリックの nw 仮想 IP。これにより、アンダークラウドインストーラーはパブリック (外部)NW でカスタム仮想 IP を設定できます。 |
--local-domain <LOCAL_DOMAIN> | スタンドアロンクラウドおよびその API エンドポイントのローカルドメイン |
--cleanup | 一時ファイルをクリーンアップします。このフラグを使用すると、コマンド実行後にデプロイメント時に使用される一時ファイルが削除されます。 |
--hieradata-override [HIERADATA_OVERRIDE] | hieradata オーバーライドファイルへのパス。heat 環境ファイルを参照する際には、--environment-file により t-h-t に渡されます。ファイルにレガシーの instack データが含まれている場合には、<role>ExtraConfig でラップされ、--output-dir に成される一時ファイルとして t-h-t に渡されます。instack hiera データには t-h-t との互換性がないので、手動によるリビジョンが必要になる可能性が高くなっています。 |
--keep-running | スタック操作が完了した後に、一時 heat を稼働したままにします。これはデバッグ目的にのみ使用されます。一時 Heat は、OS_AUTH_TYPE=none OS_ENDPOINT=http://127.0.0.1:8006/v1/admin openstack スタックリストで openstackclient により使用されます。ここで、8006 は --heat- api-port で指定したポートです。 |
--inflight-validations | デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。 |
--ansible-forks ANSIBLE_FORKS | config- download ansible-playbook コマンドに使用する Ansible のフォークの数。 |
--force-stack-update | 一時 heat スタックの仮想更新を行います (実際の更新はできません)。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=UPDATE を強制します。 |
--force-stack-create | 一時 heat スタックの仮想的な作成を行います。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=CREATE を強制します。 |
79.11. tripleo upgrade
TripleO をアップグレードします。
使用方法
openstack tripleo upgrade [--templates [TEMPLATES]] [--standalone] [--upgrade] [-y] [--stack STACK] [--output-dir OUTPUT_DIR] [--output-only] [--standalone-role STANDALONE_ROLE] [-t <TIMEOUT>] [-e <HEAT ENVIRONMENT FILE>] [--roles-file ROLES_FILE] [--networks-file NETWORKS_FILE] [--plan-environment-file PLAN_ENVIRONMENT_FILE] [--heat-api-port <HEAT_API_PORT>] [--heat-user <HEAT_USER>] [--deployment-user DEPLOYMENT_USER] [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER] [--heat-container-image <HEAT_CONTAINER_IMAGE>] [--heat-native [HEAT_NATIVE]] [--local-ip <LOCAL_IP>] [--control-virtual-ip <CONTROL_VIRTUAL_IP>] [--public-virtual-ip <PUBLIC_VIRTUAL_IP>] [--local-domain <LOCAL_DOMAIN>] [--cleanup] [--hieradata-override [HIERADATA_OVERRIDE]] [--keep-running] [--inflight-validations] [--ansible-forks ANSIBLE_FORKS] [--force-stack-update | --force-stack-create]
表79.22 コマンド引数
値 | 概要 |
---|---|
--templates [TEMPLATES] | デプロイする Heat テンプレートが格納されているディレクトリー。 |
--standalone | アンダークラウドを持たないスタンドアロンデプロイメントとしてデプロイメントを実行します。 |
--upgrade | 既存のデプロイメントをアップグレードします。 |
-y, --yes | yes/no プロンプトを省略します (yes を想定)。 |
--stack STACK | 一時 (一時的に作成して破棄する)heat スタックの名前 |
--output-dir OUTPUT_DIR | 状態、処理された heat テンプレート、Ansible デプロイメントファイルを出力するディレクトリー。 |
--output-only | Ansible Playbook は実行されません。デフォルトでは、Playbook は output-dir に保存され、その後実行されます。 |
--standalone-role STANDALONE_ROLE | デプロイメントのアクションを反映するときに、スタンドアロン設定に使用するロール。 |
-t <TIMEOUT>, --timeout <TIMEOUT> | デプロイメントのタイムアウト (分単位) |
-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE> | heat stack- create または heat stack-update コマンドに渡す環境ファイル。(複数回指定することが可能です。) |
--roles-file ROLES_FILE, -r ROLES_FILE | ロールファイル。デプロイメントに使用する t-h-t templates ディレクトリーのデフォルトの roles_data_undercloud.yaml を上書きします。絶対パスまたは templates ディレクトリーへの相対パスを指定できます。 |
--networks-file NETWORKS_FILE, -n NETWORKS_FILE | ロールファイル。デプロイメントに使用する t-h-t templates ディレクトリーのデフォルトの /dev/null を上書きします。絶対パスまたは templates ディレクトリーへの相対パスを指定できます。 |
--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE | プラン環境ファイル。--templates ディレクトリーのデフォルトの plan-environment.yaml を上書きします。 |
--heat-api-port <HEAT_API_PORT> | インストーラーのプライベート heat API インスタンスに使用する heat api ポートオプション: デフォルト: 8006。 |
--heat-user <HEAT_USER> | 非特権 heat-all プロセスを実行するユーザー。デフォルトは heat です。 |
--deployment-user DEPLOYMENT_USER | tripleo deploy コマンドを実行するユーザー。デフォルトは $SUDO_USER です。$SUDO_USER が設定されていない場合は、デフォルトで stack に設定されます。 |
--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER | デプロイメントアクションに使用する Python インタープリターへのパス。指定しない場合は、openstackclient の python バージョンが使用されます。これは、python3 システムから python2 ホストにデプロイする場合や、その逆の場合に使用する必要がある場合があります。 |
--heat-container-image <HEAT_CONTAINER_IMAGE> | heat-all プロセスの起動時に使用するコンテナーイメージデフォルト:tripleomaster/centos-binary- heat-all:current-tripleo です。 |
--heat-native [HEAT_NATIVE] | このホストで heat-all プロセスをネイティブに実行します。このオプションは、heat-all バイナリーをこのマシンにローカルにインストールすることを要求します。このオプションはデフォルトで有効になっています。したがって、heat-all はホスト OS 上で直接実行されます。 |
--local-ip <LOCAL_IP> | アンダークラウドトラフィックのローカルの ip/cidr (必須) |
--control-virtual-ip <CONTROL_VIRTUAL_IP> | コントロールプレーンの仮想 IP。これにより、アンダークラウドのインストーラーはコントロールプレーンにカスタム仮想 IP を設定できます。 |
--public-virtual-ip <PUBLIC_VIRTUAL_IP> | パブリックの nw 仮想 IP。これにより、アンダークラウドインストーラーはパブリック (外部)NW でカスタム仮想 IP を設定できます。 |
--local-domain <LOCAL_DOMAIN> | スタンドアロンクラウドおよびその API エンドポイントのローカルドメイン |
--cleanup | 一時ファイルをクリーンアップします。このフラグを使用すると、コマンド実行後にデプロイメント時に使用される一時ファイルが削除されます。 |
--hieradata-override [HIERADATA_OVERRIDE] | hieradata オーバーライドファイルへのパス。heat 環境ファイルを参照する際には、--environment-file により t-h-t に渡されます。ファイルにレガシーの instack データが含まれている場合には、<role>ExtraConfig でラップされ、--output-dir に成される一時ファイルとして t-h-t に渡されます。instack hiera データには t-h-t との互換性がないので、手動によるリビジョンが必要になる可能性が高くなっています。 |
--keep-running | スタック操作が完了した後に、一時 heat を稼働したままにします。これはデバッグ目的にのみ使用されます。一時 Heat は、OS_AUTH_TYPE=none OS_ENDPOINT=http://127.0.0.1:8006/v1/admin openstack スタックリストで openstackclient により使用されます。ここで、8006 は --heat- api-port で指定したポートです。 |
--inflight-validations | デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。 |
--ansible-forks ANSIBLE_FORKS | config- download ansible-playbook コマンドに使用する Ansible のフォークの数。 |
--force-stack-update | 一時 heat スタックの仮想更新を行います (実際の更新はできません)。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=UPDATE を強制します。 |
--force-stack-create | 一時 heat スタックの仮想的な作成を行います。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=CREATE を強制します。 |
79.12. tripleo validator group info
グループに関する詳細情報を表示します。
使用方法
openstack tripleo validator group info [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--config CONFIG] [--validation-dir VALIDATION_DIR]
表79.23 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
--noindent | Json のインデントを無効にするかどうか。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
--config CONFIG | 検証用の設定ファイルのパス。 |
--validation-dir VALIDATION_DIR | 検証 Playbook が配置されているパス。 |
79.13. tripleo validator init
コミュニティー検証を作成するためのパスおよびインフラストラクチャーを作成します
使用方法
openstack tripleo validator init [-h] [--config CONFIG] <validation_name>
表79.24 位置引数
値 | 概要 |
---|---|
<validation_name> | コミュニティー検証の名前: 検証名には、小文字の英数字と _ または - のみが含まれ、英字で始まるように制限されます。例: my-val, my_val2これにより、Ansible ロールと Playbook が /root/community-validations に生成されます。このディレクトリーの構造は、初回使用時に作成されることに注意してください。 |
表79.25 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--config CONFIG | 検証用の設定ファイルのパス。 |
79.14. tripleo validator list
利用可能な検証をリスト表示します。
使用方法
openstack tripleo validator list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--config CONFIG] [--group <group_id>[,<group_id>,...]] [--category <category_id>[,<category_id>,...]] [--product <product_id>[,<product_id>,...]] [--validation-dir VALIDATION_DIR]
表79.26 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
--noindent | Json のインデントを無効にするかどうか。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
--config CONFIG | 検証用の設定ファイルのパス。 |
--group <group_id>[,<group_id>,…], -g <group_id>[,<group_id>,…] | 特定グループの検証を一覧表示します。複数のグループが必要な場合は、グループ名をコンマで区切ります。 |
--category <category_id>[,<category_id>,…] | 特定の検証カテゴリーを一覧表示します。複数のカテゴリーが必要な場合は、カテゴリー名をコンマで区切ります。 |
--product <product_id>[,<product_id>,…] | 特定製品の検証を一覧表示します。複数のグループが必要な場合は、製品名をコンマで区切ります。 |
--validation-dir VALIDATION_DIR | 検証 Playbook が配置されているパス。 |
79.15. tripleo validator run
利用可能な検証を実行します。
使用方法
openstack tripleo validator run [-h] [--config CONFIG] [--limit <host1>[,<host2>,<host3>,...]] [--ssh-user SSH_USER] [--validation-dir VALIDATION_DIR] [--ansible-base-dir ANSIBLE_BASE_DIR] [--validation-log-dir VALIDATION_LOG_DIR] [--inventory INVENTORY] [--output-log OUTPUT_LOG] [--junitxml JUNITXML] [--python-interpreter --python-interpreter <PYTHON_INTERPRETER_PATH>] [--extra-env-vars key1=<val1> [--extra-env-vars key2=<val2>]] [--skiplist SKIP_LIST] [--extra-vars key1=<val1> [--extra-vars key2=<val2>] | --extra-vars-file /tmp/my_vars_file.[json|yaml]] (--validation <validation_id>[,<validation_id>,...] | --group <group_id>[,<group_id>,...] | --category <category_id>[,<category_id>,...] | --product <product_id>[,<product_id>,...])
表79.27 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--config CONFIG | 検証用の設定ファイルのパス。 |
--limit <host1>[,<host2>,<host3>,…] | このアップグレード実行の呼び出しで並行してアップグレードされる単一ノードまたはコンマ区切りのノードリストを特定する文字列。 |
--ssh-user SSH_USER | ansible ssh 接続の SSH ユーザー名。 |
--validation-dir VALIDATION_DIR | 検証 Playbook が配置されているパス。 |
--ansible-base-dir ANSIBLE_BASE_DIR | Ansible ロール、ライブラリー、およびプラグインが置かれるパス。 |
--validation-log-dir VALIDATION_LOG_DIR | ログファイルとアーティファクトが配置されるパス。 |
--inventory INVENTORY, -i INVENTORY | Ansible インベントリーのパス。 |
--output-log OUTPUT_LOG | 実行結果が保存されるパス。 |
--junitxml JUNITXML | 実行結果が junitxml 形式で保存されるパス。 |
--python-interpreter --python-interpreter <PYTHON_INTERPRETER_PATH> | Ansible 実行用の Python インタープリター。 |
--extra-env-vars key1=<val1> [--extra-env-vars key2=<val2>] | 指定する必要がある追加の環境変数を KEY=VALUE ペアとして Ansible 実行に追加します。同じキーを複数回渡すと、その同じキーの最後に指定した VALUE が他の値をオーバーライドすることに注意してください。 |
--skiplist SKIP_LIST | スキップリストが保存されているパス。スキップリスト形式の例は、validations-libs リポジトリーのルートにあります。 |
--extra-vars key1=<val1> [--extra-vars key2=<val2>] | 検証の実行に Ansible 追加変数を KEY=VALUE ペアとして追加します。同じキーを複数回渡すと、その同じキーの最後に指定した VALUE が他の値をオーバーライドすることに注意してください。 |
--extra-vars-file /tmp/my_vars_file.[json|yaml] | 1 つまたは複数の検証実行に渡す追加の変数が含まれる json/yaml ファイルへの絶対パスまたは相対パス。 |
--validation <validation_id>[,<validation_id>,…] | 特定の検証を実行します。複数の検証が必要な場合は、名前をコンマで区切ります。 |
--group <group_id>[,<group_id>,…], -g <group_id>[,<group_id>,…] | 特定グループの検証を一覧表示します。複数のグループが必要な場合は、グループ名をコンマで区切ります。 |
--category <category_id>[,<category_id>,…] | カテゴリーごとに特定の検証を実行します。複数のカテゴリーが必要な場合は、カテゴリー名をコンマで区切ります。 |
--product <product_id>[,<product_id>,…] | 製品ごとに特定の検証を実行します。複数の製品が必要な場合は、製品名をコンマで区切ります。 |
79.16. tripleo validator show history
検証の実行履歴を表示します。
使用方法
openstack tripleo validator show history [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--config CONFIG] [--validation <validation_id>] [--limit HISTORY_LIMIT] [--validation-log-dir VALIDATION_LOG_DIR]
表79.28 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
--noindent | Json のインデントを無効にするかどうか。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
--config CONFIG | 検証用の設定ファイルのパス。 |
--validation <validation_id> | 検証の実行履歴を表示します。 |
--limit HISTORY_LIMIT | 選択した <validation> の最新の実行 <n> を表示します。<n> は > 0 である必要があります。デフォルトの表示制限は 15 に設定されています。 |
--validation-log-dir VALIDATION_LOG_DIR | 検証ログファイルが配置されているパス。 |
79.17. tripleo validator show parameter
検証パラメーターを表示します。
使用方法
openstack tripleo validator show parameter [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--config CONFIG] [--validation-dir VALIDATION_DIR] [--validation <validation_id>[,<validation_id>,...] | --group <group_id>[,<group_id>,...] | --category <category_id>[,<category_id>,...] | --product <product_id>[,<product_id>,...]] [--download DOWNLOAD] [--format-output <format_output>]
表79.29 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--config CONFIG | 検証用の設定ファイルのパス。 |
--validation-dir VALIDATION_DIR | 検証 Playbook が配置されているパス。 |
--validation <validation_id>[,<validation_id>,…] | 特定の検証を一覧表示します。複数の検証が必要な場合は、名前をコンマで区切ります。 |
--group <group_id>[,<group_id>,…], -g <group_id>[,<group_id>,…] | 特定グループの検証を一覧表示します。複数のグループが必要な場合は、グループ名をコンマで区切ります。 |
--category <category_id>[,<category_id>,…] | カテゴリーごとに特定の検証を実行します。複数のカテゴリーが必要な場合は、カテゴリー名をコンマで区切ります。 |
--product <product_id>[,<product_id>,…] | 製品ごとに特定の検証を実行します。複数の製品が必要な場合は、製品名をコンマで区切ります。 |
--download DOWNLOAD | 検証で利用可能なすべての変数が含まれる json または yaml ファイルを作成します: /tmp/myvars |
--format-output <format_output> | 検証の表現を出力します。出力形式の選択肢は json、yaml です。 |
表79.30 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表79.31 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表79.32 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表79.33 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
79.18. tripleo validator show run
検証実行に関する詳細を表示します。
使用方法
openstack tripleo validator show run [-h] [--config CONFIG] [--full] [--validation-log-dir VALIDATION_LOG_DIR] <uuid>
表79.34 位置引数
値 | 概要 |
---|---|
<uuid> | 実行する検証の uuid |
表79.35 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--config CONFIG | 検証用の設定ファイルのパス。 |
--full | 実行の詳細を表示 |
--validation-log-dir VALIDATION_LOG_DIR | 検証ログファイルが配置されているパス。 |
79.19. tripleo validator show
検証に関する詳細情報を表示します。
使用方法
openstack tripleo validator show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--config CONFIG] [--validation-dir VALIDATION_DIR] <validation>
表79.36 位置引数
値 | 概要 |
---|---|
<validation> | 特定の検証を表示します。 |
表79.37 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--config CONFIG | 検証用の設定ファイルのパス。 |
--validation-dir VALIDATION_DIR | 検証 Playbook が配置されているパス。 |
表79.38 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表79.39 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表79.40 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表79.41 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第80章 信頼 (trust)
本章では、trust
コマンドに含まれるコマンドについて説明します。
80.1. trust create
新規信頼を作成します。
使用方法
openstack trust create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --project <project> --role <role> [--impersonate] [--expiration <expiration>] [--project-domain <project-domain>] [--trustor-domain <trustor-domain>] [--trustee-domain <trustee-domain>] <trustor-user> <trustee-user>
表80.1 位置引数
値 | 概要 |
---|---|
<trustor-user> | 承認を委譲されるユーザー (名前または ID) |
<trustee-user> | 承認を想定するユーザー (名前または ID) |
表80.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | 委譲されるプロジェクト (名前または ID)(必須) |
--role <role> | 承認するロール (名前または ID) (複数の値を設定する場合はオプションを繰り返し使用します。必須) |
--impersonate | 信頼から生成されたトークンは <trustor> を表します (デフォルトは False)。 |
--expiration <expiration> | 信頼の有効期限を設定します (yyyy- mm-ddTHH:MM:SS の形式) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--trustor-domain <trustor-domain> | <trustor>が含まれるドメイン (名前または ID) |
--trustee-domain <trustee-domain> | <trustee>が含まれるドメイン (名前または ID) |
表80.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表80.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表80.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表80.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
80.2. trust delete
信頼を削除します。
使用方法
openstack trust delete [-h] <trust> [<trust> ...]
表80.7 位置引数
値 | 概要 |
---|---|
<trust> | 削除する信頼 |
表80.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
80.3. trust list
信頼のリストを表示します。
使用方法
openstack trust list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表80.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表80.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表80.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表80.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表80.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
80.4. trust show
信頼の詳細を表示します。
使用方法
openstack trust show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <trust>
表80.14 位置引数
値 | 概要 |
---|---|
<trust> | 表示する信頼 |
表80.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表80.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表80.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表80.18 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表80.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第81章 tsigkey
本章では、tsigkey
コマンドに含まれるコマンドについて説明します。
81.1. tsigkey create
新規 tsigkey を作成します。
使用方法
openstack tsigkey create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --name NAME --algorithm ALGORITHM --secret SECRET --scope SCOPE --resource-id RESOURCE_ID [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
表81.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name NAME | Tsigkey 名 |
--algorithm ALGORITHM | Tsigkey アルゴリズム |
--secret SECRET | Tsigkey シークレット |
--scope SCOPE | Tsigkey スコープ |
--resource-id RESOURCE_ID | Tsigkey のリソース id |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表81.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表81.3 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表81.4 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表81.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
81.2. tsigkey delete
tsigkey を削除します。
使用方法
openstack tsigkey delete [-h] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表81.6 位置引数
値 | 概要 |
---|---|
id | Tsigkey id |
表81.7 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
81.3. tsigkey list
tsigkey をリスト表示します。
使用方法
openstack tsigkey list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name NAME] [--algorithm ALGORITHM] [--scope SCOPE] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
表81.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name NAME | Tsigkey 名 |
--algorithm ALGORITHM | Tsigkey アルゴリズム |
--scope SCOPE | Tsigkey スコープ |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表81.9 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表81.10 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表81.11 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表81.12 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
81.4. tsigkey set
tsigkey の属性を設定します。
使用方法
openstack tsigkey set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name NAME] [--algorithm ALGORITHM] [--secret SECRET] [--scope SCOPE] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表81.13 位置引数
値 | 概要 |
---|---|
id | Tsigkey id |
表81.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name NAME | Tsigkey 名 |
--algorithm ALGORITHM | Tsigkey アルゴリズム |
--secret SECRET | Tsigkey シークレット |
--scope SCOPE | Tsigkey スコープ |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表81.15 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表81.16 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表81.17 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表81.18 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
81.5. tsigkey show
tsigkey の詳細を表示します。
使用方法
openstack tsigkey show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表81.19 位置引数
値 | 概要 |
---|---|
id | Tsigkey id |
表81.20 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表81.21 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表81.22 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表81.23 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表81.24 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第82章 undercloud
本章では、undercloud
コマンドに含まれるコマンドについて説明します。
82.1. undercloud backup
アンダークラウドのバックアップを作成します。
使用方法
openstack undercloud backup [--init [INIT]] [--setup-nfs] [--setup-rear] [--cron] [--db-only] [--inventory INVENTORY] [--add-path ADD_PATH] [--exclude-path EXCLUDE_PATH] [--extra-vars EXTRA_VARS]
表82.1 コマンド引数
値 | 概要 |
---|---|
--init [INIT] | rear または nfs を引数として使用し、バックアップの環境を初期化します。パッケージのインストールと設定された ReaR サーバーまたは NFS サーバーを確認します。デフォルトは rear です (例:--init rear)。警告: このフラグは非推奨となり、--setup-rear および --setup-nfs で置き換えられます。 |
--setup-nfs | ansible インベントリーのホストの BackupNode に必要なパッケージおよび設定をインストールするバックアップノードで、nfs サーバーを設定します。 |
--setup-rear | ReaR をインストールおよび設定する アンダークラウド ホストに rear をセットアップします。 |
--cron | デフォルトで日曜日の午前 0 時にバックアップを実行する新しい cron ジョブをセットアップしますが、これは tripleo_backup_and_restore_cron extra-var を使用してカスタマイズできます。 |
--db-only | アンダークラウド ホストの db バックアップを実行します。db バックアップファイルは、openstack-backup-mysql-<timestamp>.sql という名前で /home/stack に保存されます。 |
--inventory INVENTORY | tripleo-ansible- inventory コマンドで生成された tripleo インベントリーファイル。デフォルトは /home/stack/tripleo- inventory.yaml です。 |
--add-path ADD_PATH | バックアップに追加のファイルを追加します。デフォルトは /home/stack/ です (例: --add-path /this/is/a/folder/ --add- path /this/is/a/texfile.txt)。 |
--exclude-path EXCLUDE_PATH | アンダークラウドのバックアップを実行する際の除外パス。このオプションは複数回指定することができます。デフォルト:none (例: --exclude-path /this/is/a/folder/ --exclude-path /this/is/a/texfile.txt) |
--extra-vars EXTRA_VARS | 追加の変数を dict または JSON または YAML ファイルタイプの絶対パスとして設定します。例:--extra-vars {"key": "val", "key2": "val2"} 例: --extra-vars /path/to/my_vars.yaml 例: --extra-vars /path/to/my_vars.json渡すことのできる変数についての詳細は、https://opendev.org/openstack/tripleo-ansible/src/branch/master/tripleo_ansible/roles/backup_and_restore/def aults/main.yml を参照してください。 |
82.2. undercloud install
アンダークラウドをインストールおよび設定します。
使用方法
openstack undercloud install [--force-stack-update] [--no-validations] [--inflight-validations] [--dry-run] [-y]
表82.2 コマンド引数
値 | 概要 |
---|---|
--force-stack-update | 一時 heat スタックの仮想的な更新を行います。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=UPDATE を強制します。 |
--no-validations | アンダークラウド設定の検証を実行しません。 |
--inflight-validations | デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。 |
--dry-run | install コマンドを実行せずに出力します。 |
-y, --yes | yes/no プロンプトを省略します (yes と仮定)。 |
82.3. undercloud minion install
アンダークラウドミニオンをインストールおよび設定します。
使用方法
openstack undercloud minion install [--force-stack-update] [--no-validations] [--dry-run] [-y]
表82.3 コマンド引数
値 | 概要 |
---|---|
--force-stack-update | 一時 heat スタックの仮想的な更新を行います。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=UPDATE を強制します。 |
--no-validations | ミニオン設定の検証を実行しません。 |
--dry-run | install コマンドを実行せずに出力します。 |
-y, --yes | yes/no プロンプトを省略します (yes と仮定)。 |
82.4. undercloud minion upgrade
アンダークラウドミニオンをアップグレードします。
使用方法
openstack undercloud minion upgrade [--force-stack-update] [--no-validations] [--dry-run] [-y]
表82.4 コマンド引数
値 | 概要 |
---|---|
--force-stack-update | 一時 heat スタックの仮想的な更新を行います。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=UPDATE を強制します。 |
--no-validations | ミニオン設定の検証を実行しません。 |
--dry-run | install コマンドを実行せずに出力します。 |
-y, --yes | yes/no プロンプトを省略します (yes と仮定)。 |
82.5. undercloud upgrade
アンダークラウドをアップグレードします。
使用方法
openstack undercloud upgrade [--force-stack-update] [--no-validations] [--inflight-validations] [--dry-run] [-y] [--skip-package-updates]
表82.5 コマンド引数
値 | 概要 |
---|---|
--force-stack-update | 一時 heat スタックの仮想的な更新を行います。新規または失敗したデプロイメントは常に stack_action=CREATE を持ちます。このオプションは、stack_action=UPDATE を強制します。 |
--no-validations | アンダークラウド設定の検証を実行しません。 |
--inflight-validations | デプロイ中のインフライト検証をアクティブにします。インフライト検証は、デプロイされたサービスがアクティベーション直後に実行されるようにする堅牢な方法を提供します。デフォルトは false です。 |
--dry-run | install コマンドを実行せずに出力します。 |
-y, --yes | yes/no プロンプトを省略します (yes と仮定)。 |
--skip-package-updates | アップグレードおよび更新の実行時にパッケージの更新を省略するフラグ |
第83章 使用状況
本章では、usage
コマンドに含まれるコマンドについて説明します。
83.1. usage list
プロジェクトごとのリソース使用状況をリスト表示します。
使用方法
openstack usage list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--start <start>] [--end <end>]
表83.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--start <start> | 使用範囲の開始日 (例:2012-01-20)(デフォルト:4 週間前) |
--end <end> | 使用範囲の終了日 (例:2012-01-20)(デフォルト: 明日) |
表83.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表83.3 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表83.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表83.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
83.2. usage show
単一プロジェクトのリソース使用状況を表示します。
使用方法
openstack usage show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--project <project>] [--start <start>] [--end <end>]
表83.6 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | 使用状況を表示するプロジェクトの名前または ID |
--start <start> | 使用範囲の開始日 (例:2012-01-20)(デフォルト:4 週間前) |
--end <end> | 使用範囲の終了日 (例:2012-01-20)(デフォルト: 明日) |
表83.7 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表83.8 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表83.9 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表83.10 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第84章 user
本章では、user
コマンドに含まれるコマンドについて説明します。
84.1. user create
新規ユーザーを作成します。
使用方法
openstack user create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--domain <domain>] [--project <project>] [--project-domain <project-domain>] [--password <password>] [--password-prompt] [--email <email-address>] [--description <description>] [--enable | --disable] [--or-show] <name>
表84.1 位置引数
値 | 概要 |
---|---|
<name> | 新しいユーザー名 |
表84.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | デフォルトのドメイン (名前または ID) |
--project <project> | デフォルトプロジェクト (名前または ID) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--password <password> | ユーザーのパスワードを設定します。 |
--password-prompt | パスワードを対話的に要求します。 |
--email <email-address> | ユーザーのメールアドレスを設定します。 |
--description <description> | ユーザーの説明 |
--enable | ユーザーを有効にします (デフォルト)。 |
--disable | ユーザーを無効にします。 |
--or-show | 既存ユーザーを返します。 |
表84.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表84.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表84.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表84.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
84.2. user delete
ユーザーを削除します。
使用方法
openstack user delete [-h] [--domain <domain>] <user> [<user> ...]
表84.7 位置引数
値 | 概要 |
---|---|
<user> | 削除するユーザー (名前または ID) |
表84.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | <user> を所有するドメイン (名前または ID) |
84.3. user list
ユーザーをリスト表示します。
使用方法
openstack user list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--domain <domain>] [--group <group> | --project <project>] [--long]
表84.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | <domain>でユーザーをフィルターします (名前または id)。 |
--group=GROUP | <group> メンバーシップでユーザーをフィルターします (名前または ID)。 |
--project <project> | <project>でユーザーをフィルターします (名前または id)。 |
--long | 出力の追加フィールドをリスト表示します。 |
表84.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表84.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表84.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表84.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
84.4. user password set
現在のユーザーのパスワードを変更します。
使用方法
openstack user password set [-h] [--password <new-password>] [--original-password <original-password>]
表84.14 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--password <new-password> | 新しいユーザーパスワード |
--original-password <original-password> | 元のユーザーパスワード |
84.5. user set
ユーザーの属性を設定します。
使用方法
openstack user set [-h] [--name <name>] [--domain <domain>] [--project <project>] [--project-domain <project-domain>] [--password <password>] [--password-prompt] [--email <email-address>] [--description <description>] [--enable | --disable] <user>
表84.15 位置引数
値 | 概要 |
---|---|
<user> | 変更するユーザー (名前または ID) |
表84.16 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | ユーザー名を設定します。 |
--domain <domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
--project <project> | デフォルトプロジェクトを設定します (名前または ID)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--password <password> | ユーザーのパスワードを設定します。 |
--password-prompt | パスワードを対話的に要求します。 |
--email <email-address> | ユーザーのメールアドレスを設定します。 |
--description <description> | ユーザーの説明を設定します。 |
--enable | ユーザーを有効にします (デフォルト)。 |
--disable | ユーザーを無効にします。 |
84.6. user show
ユーザーの詳細を表示します。
使用方法
openstack user show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--domain <domain>] <user>
表84.17 位置引数
値 | 概要 |
---|---|
<user> | 表示するユーザー (名前または ID) |
表84.18 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--domain <domain> | <user> を所有するドメイン (名前または ID) |
表84.19 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表84.20 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表84.21 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表84.22 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第85章 versions
本章では、versions
コマンドに含まれるコマンドについて説明します。
85.1. versions show
利用可能なサービスのバージョンを表示します。
使用方法
openstack versions show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--all-interfaces | --interface <interface>] [--region-name <region_name>] [--service <region_name>] [--status <region_name>]
表85.1 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-interfaces | すべてのインターフェイスの値を表示します。 |
--interface <interface> | 特定のインターフェイスのバージョンを表示します。 |
--region-name <region_name> | 特定のリージョンのバージョンを表示します。 |
--service <region_name> | 特定のサービスのバージョンを表示します。 |
--status <region_name> | 特定のステータスのバージョンを表示します[有効な値は SUPPORTED、CURRENT、DEPRECATED、EXPERIMENTAL です]。 |
表85.2 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表85.3 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表85.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表85.5 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第86章 volume
本章では、volume
コマンドに含まれるコマンドについて説明します。
86.1. volume backup create
新しいボリュームのバックアップを作成します。
使用方法
openstack volume backup create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] [--container <container>] [--snapshot <snapshot>] [--force] [--incremental] <volume>
表86.1 位置引数
値 | 概要 |
---|---|
<volume> | バックアップするボリューム (名前または ID) |
表86.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | バックアップの名前 |
--description <description> | バックアップの説明 |
--container <container> | オプションのバックアップコンテナー名 |
--snapshot <snapshot> | バックアップするスナップショット (名前または ID) |
--force | 使用中のボリュームのバックアップを許可します。 |
--incremental | 増分バックアップを実行します。 |
表86.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表86.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表86.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.2. volume backup delete
ボリュームバックアップを削除します。
使用方法
openstack volume backup delete [-h] [--force] <backup> [<backup> ...]
表86.7 位置引数
値 | 概要 |
---|---|
<backup> | 削除するバックアップ (名前または ID) |
表86.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--force | Error または available 以外の状態で削除を可能にします。 |
86.3. volume backup list
ボリュームのバックアップをリスト表示します。
使用方法
openstack volume backup list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--name <name>] [--status <status>] [--volume <volume>] [--marker <volume-backup>] [--limit <num-backups>] [--all-projects]
表86.9 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
--name <name> | バックアップ名で結果をフィルタリングします。 |
--status <status> | バックアップのステータス (creating、available、deleting、error、restoring、または error_restoring) で結果をフィルタリングします。 |
--volume <volume> | バックアップするボリュームで結果をフィルタリングします (名前または ID)。 |
--marker <volume-backup> | 前のページにある最後のバックアップ (名前または ID) |
--limit <num-backups> | 表示するバックアップの最大数。 |
--all-projects | すべてのプロジェクトを含めます (管理者のみ)。 |
表86.10 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表86.11 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表86.12 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.13 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.4. volume backup restore
ボリュームのバックアップを復元します。
使用方法
openstack volume backup restore [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <backup> <volume>
表86.14 位置引数
値 | 概要 |
---|---|
<backup> | 復元するバックアップ (名前または ID) |
<volume> | 復元先のボリューム (名前または ID) |
表86.15 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表86.16 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表86.17 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.18 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表86.19 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.5. volume backup set
ボリュームのバックアップの属性を設定します。
使用方法
openstack volume backup set [-h] [--name <name>] [--description <description>] [--state <state>] <backup>
表86.20 位置引数
値 | 概要 |
---|---|
<backup> | 変更するバックアップ (名前または ID) |
表86.21 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 新しいバックアップ名 |
--description <description> | 新しいバックアップの説明 |
--state <state> | 新しいバックアップの状態 ("available" または "error")(管理者のみ)(このオプションは、実際のステータスに関係なくデータベースのバックアップの状態を変更するだけで、使用時には注意が必要です) |
86.6. volume backup show
ボリュームのバックアップの詳細を表示します。
使用方法
openstack volume backup show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <backup>
表86.22 位置引数
値 | 概要 |
---|---|
<backup> | 表示するバックアップ (名前または ID) |
表86.23 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表86.24 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表86.25 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.26 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表86.27 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.7. volume create
新規ボリュームを作成します。
使用方法
openstack volume create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--size <size>] [--type <volume-type>] [--image <image> | --snapshot <snapshot> | --source <volume>] [--description <description>] [--availability-zone <availability-zone>] [--consistency-group consistency-group>] [--property <key=value>] [--hint <key=value>] [--bootable | --non-bootable] [--read-only | --read-write] <name>
表86.28 位置引数
値 | 概要 |
---|---|
<name> | ボリューム名 |
表86.29 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--size <size> | gb 単位のボリュームサイズ (--snapshot または --source が指定されていない場合に必要) |
--type <volume-type> | ボリュームの種別を設定します。 |
--image <image> | <image> をボリュームのソースとして使用します (名前または ID)。 |
--snapshot <snapshot> | <snapshot> をボリュームのソースとして使用します (名前または ID)。 |
--source <volume> | クローンを作成するボリューム (名前または ID) |
--description <description> | ボリュームの説明 |
--availability-zone <availability-zone> | <availability-zone> にボリュームを作成します。 |
--consistency-group consistency-group> | 新しいボリュームが属する整合性グループ |
--property <key=value> | このボリュームに属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します) |
--hint <key=value> | インスタンスのブートに役立つ任意のスケジューラーヒントのキーと値のペア (複数のヒントを設定する場合はオプションを繰り返し使用します) |
--bootable | ボリュームをブート可能としてマークします。 |
--non-bootable | ボリュームをブート不可としてマークします (デフォルト)。 |
--read-only | volume を読み取り専用モードに設定します。 |
--read-write | volume を読み取り/書き込みアクセスモードに設定します (デフォルト)。 |
表86.30 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表86.31 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.32 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表86.33 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.8. volume delete
ボリュームを削除します。
使用方法
openstack volume delete [-h] [--force | --purge] <volume> [<volume> ...]
表86.34 位置引数
値 | 概要 |
---|---|
<volume> | 削除するボリューム (名前または ID) |
表86.35 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--force | 状態に関係なく、ボリュームを強制的に削除しようとします (デフォルトは False)。 |
--purge | ボリュームと共にすべてのスナップショットを削除します (デフォルトは false)。 |
86.9. volume host set
ボリュームのホストの属性を設定します。
使用方法
openstack volume host set [-h] [--disable | --enable] <host-name>
表86.36 位置引数
値 | 概要 |
---|---|
<host-name> | ボリュームホスト名 |
表86.37 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--disable | 指定したボリュームホストをフリーズおよび無効化します。 |
--enable | 指定されたボリュームホストをフリーズ解除および有効化します。 |
86.10. volume list
ボリュームをリスト表示します。
使用方法
openstack volume list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--project <project>] [--project-domain <project-domain>] [--user <user>] [--user-domain <user-domain>] [--name <name>] [--status <status>] [--all-projects] [--long] [--marker <volume>] [--limit <num-volumes>]
表86.38 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--project <project> | プロジェクト (名前または ID) で結果をフィルターします (管理者のみ)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--user <user> | ユーザー (名前または ID) で結果をフィルターします (管理者のみ)。 |
--user-domain <user-domain> | ユーザーが所属するドメイン (名前または ID)。ユーザー名の競合が発生してしまった場合に、使用できます。 |
--name <name> | ボリューム名で結果をフィルタリングします。 |
--status <status> | ステータスで結果をフィルタリングします。 |
--all-projects | すべてのプロジェクトを含めます (管理者のみ)。 |
--long | 出力の追加フィールドをリスト表示します。 |
--marker <volume> | 前のページにある最後のボリューム ID |
--limit <num-volumes> | 表示するボリュームの最大数。 |
表86.39 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表86.40 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表86.41 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.42 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.11. volume migrate
新規ホストにボリュームを移行します。
使用方法
openstack volume migrate [-h] --host <host> [--force-host-copy] [--lock-volume] <volume>
表86.43 位置引数
値 | 概要 |
---|---|
<volume> | 移行するボリューム (名前または ID) |
表86.44 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--host <host> | 移行先ホスト (形式:host@backend-name#pool) |
--force-host-copy | 汎用のホストベースの強制移行を有効にし、ドライバーの最適化をバイパスします。 |
--lock-volume | 指定されている場合には、ボリュームの状態がロックされ、(別の操作で) 移行が中断されなくなります。 |
86.12. volume qos associate
QoS 仕様をボリューム種別に関連付けます。
使用方法
openstack volume qos associate [-h] <qos-spec> <volume-type>
表86.45 位置引数
値 | 概要 |
---|---|
<qos-spec> | 変更する QoS 仕様 (名前または ID) |
<volume-type> | qos を関連付けるボリューム種別 (名前または id) |
表86.46 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
86.13. volume qos create
新規 QoS 仕様を作成します。
使用方法
openstack volume qos create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--consumer <consumer>] [--property <key=value>] <name>
表86.47 位置引数
値 | 概要 |
---|---|
<name> | 新しい qos 仕様の名前 |
表86.48 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--consumer <consumer> | qos のコンシューマー。有効なコンシューマー:back-end、both、front-end (デフォルトは both) |
--property <key=value> | qos 仕様の属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します) |
表86.49 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表86.50 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.51 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表86.52 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.14. volume qos delete
QoS 仕様を削除します。
使用方法
openstack volume qos delete [-h] [--force] <qos-spec> [<qos-spec> ...]
表86.53 位置引数
値 | 概要 |
---|---|
<qos-spec> | 削除する QoS 仕様 (名前または ID) |
表86.54 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--force | 使用中の qos 仕様の削除を許可します。 |
86.15. volume qos disassociate
ボリューム種別から QoS 仕様の関連付けを解除します。
使用方法
openstack volume qos disassociate [-h] [--volume-type <volume-type> | --all] <qos-spec>
表86.55 位置引数
値 | 概要 |
---|---|
<qos-spec> | 変更する QoS 仕様 (名前または ID) |
表86.56 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--volume-type <volume-type> | qos の関連付けを解除するボリューム種別 (名前または ID) |
--all | すべてのボリューム種別から qos の関連付けを解除します。 |
86.16. volume qos list
QoS 仕様のリストを表示します。
使用方法
openstack volume qos list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
表86.57 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表86.58 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表86.59 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表86.60 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.61 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.17. volume qos set
QoS 仕様の属性を設定します。
使用方法
openstack volume qos set [-h] [--property <key=value>] <qos-spec>
表86.62 位置引数
値 | 概要 |
---|---|
<qos-spec> | 変更する QoS 仕様 (名前または ID) |
表86.63 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--property <key=value> | この qos 仕様に追加または変更する属性 (複数の属性を設定する場合はオプションを繰り返し使用します) |
86.18. volume qos show
QoS 仕様の詳細を表示します。
使用方法
openstack volume qos show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <qos-spec>
表86.64 位置引数
値 | 概要 |
---|---|
<qos-spec> | 表示する QoS 仕様 (名前または ID) |
表86.65 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表86.66 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表86.67 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.68 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表86.69 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.19. volume qos unset
QoS 仕様の属性の設定を解除します。
使用方法
openstack volume qos unset [-h] [--property <key>] <qos-spec>
表86.70 位置引数
値 | 概要 |
---|---|
<qos-spec> | 変更する QoS 仕様 (名前または ID) |
表86.71 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--property <key> | qos 使用から削除する属性 (複数属性の設定を解除する場合はオプションを繰り返し使用します) |
86.20. volume service list
サービスをリスト表示するコマンド
使用方法
openstack volume service list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--host <host>] [--service <service>] [--long]
表86.72 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--host <host> | 指定したホストでサービスをリスト表示します (名前のみ)。 |
--service <service> | 指定されたサービスのみをリスト表示します (名前のみ)。 |
--long | 出力の追加フィールドをリスト表示します。 |
表86.73 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表86.74 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表86.75 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.76 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.21. volume service set
ボリュームサービスの属性を設定します。
使用方法
openstack volume service set [-h] [--enable | --disable] [--disable-reason <reason>] <host> <service>
表86.77 位置引数
値 | 概要 |
---|---|
<host> | ホスト名 |
<service> | サービスの名前 (バイナリー名) |
表86.78 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--enable | ボリュームサービスを有効にします。 |
--disable | ボリュームサービスを無効にします。 |
--disable-reason <reason> | サービスを無効にする理由。--disable オプションと併用する必要があります。 |
86.22. volume set
ボリュームの属性を設定します。
使用方法
openstack volume set [-h] [--name <name>] [--size <size>] [--description <description>] [--no-property] [--property <key=value>] [--image-property <key=value>] [--state <state>] [--attached | --detached] [--type <volume-type>] [--retype-policy <retype-policy>] [--bootable | --non-bootable] [--read-only | --read-write] <volume>
表86.79 位置引数
値 | 概要 |
---|---|
<volume> | 変更するボリューム (名前または ID) |
表86.80 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 新規ボリューム名 |
--size <size> | ボリュームサイズを拡張します (gb 単位) |
--description <description> | 新規ボリュームの説明 |
--no-property | <volume>からすべての属性を削除します (新しい属性を設定する前に現在の属性を削除するには --no-property と --property の両方を指定します)。 |
--property <key=value> | このボリュームに属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します) |
--image-property <key=value> | このボリュームにイメージ属性を設定します (複数のイメージ属性を設定する場合はオプションを繰り返し使用します) |
--state <state> | 新しいボリュームの状態 ("available"、"error"、"creating"、"deleting"、"in-use"、"attaching"、"detaching"、"error_deleting"、または "maintenance") (管理者のみ) (このオプションは、実際のステータスに関係なくデータベースのボリュームの状態を変更するだけで、使用時には注意が必要です) |
--attached | ボリューム割り当てのステータスを attached に設定します (管理者のみ)。(このオプションは、実際のステータスに関係なくデータベースのボリュームの状態を変更するだけで、使用時には注意が必要です) |
--detached | ボリューム割り当てのステータスを detached に設定します (管理者のみ)。(このオプションは、実際のステータスに関係なくデータベースのボリュームの状態を変更するだけで、使用時には注意が必要です) |
--type <volume-type> | 新規ボリューム種別 (名前または ID) |
--retype-policy <retype-policy> | ボリューム種別の変更中の移行ポリシー (never または on-demand、デフォルトは never)(--type オプションが指定されている場合にのみ利用可能) |
--bootable | ボリュームをブート可能としてマークします。 |
--non-bootable | ボリュームをブート不可としてマークします。 |
--read-only | volume を読み取り専用モードに設定します。 |
--read-write | volume を読み取り/書き込みアクセスモードに設定します。 |
86.23. volume show
ボリュームの詳細を表示します。
使用方法
openstack volume show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <volume>
表86.81 位置引数
値 | 概要 |
---|---|
<volume> | 表示するボリューム (名前または ID) |
表86.82 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表86.83 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表86.84 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.85 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表86.86 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.24. volume snapshot create
新規ボリュームスナップショットを作成します。
使用方法
openstack volume snapshot create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--volume <volume>] [--description <description>] [--force] [--property <key=value>] [--remote-source <key=value>] <snapshot-name>
表86.87 位置引数
値 | 概要 |
---|---|
<snapshot-name> | 新規スナップショットの名前 |
表86.88 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--volume <volume> | スナップショットを作成するボリューム (名前または id)(デフォルトは <snapshot- name>) |
--description <description> | スナップショットの説明 |
--force | インスタンスに割り当てられているスナップショットを作成します。デフォルトは False です。 |
--property <key=value> | 属性をこのスナップショットに設定します (複数の属性を設定する場合はオプションを繰り返し使用します)。 |
--remote-source <key=value> | 既存のリモートボリュームスナップショットの属性 (管理者が必要)(複数属性を指定する場合はオプションを繰り返し使用します)(例: --remote-source source- name=test_name --remote-source source-id=test_id) |
表86.89 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表86.90 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.91 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表86.92 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.25. volume snapshot delete
ボリュームスナップショットを削除します。
使用方法
openstack volume snapshot delete [-h] [--force] <snapshot> [<snapshot> ...]
表86.93 位置引数
値 | 概要 |
---|---|
<snapshot> | 削除するスナップショット (名前または ID) |
表86.94 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--force | 状態に関係なく、スナップショットの強制的な削除を試行します (デフォルトは False)。 |
86.26. volume snapshot list
ボリュームスナップショットのリストを表示します。
使用方法
openstack volume snapshot list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--all-projects] [--project <project>] [--project-domain <project-domain>] [--long] [--marker <volume-snapshot>] [--limit <num-snapshots>] [--name <name>] [--status <status>] [--volume <volume>]
表86.95 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトを含めます (管理者のみ)。 |
--project <project> | プロジェクト (名前または ID) で結果をフィルターします (管理者のみ)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--long | 出力の追加フィールドをリスト表示します。 |
--marker <volume-snapshot> | 前のページにある最後のスナップショット ID |
--limit <num-snapshots> | 表示するスナップショットの最大数。 |
--name <name> | 名前で結果をフィルタリングします。 |
--status <status> | ステータス (available、error、creating、deleting、または error-deleting) で結果をフィルタリングします。 |
--volume <volume> | ボリュームで結果をフィルタリングします (名前または ID)。 |
表86.96 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表86.97 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表86.98 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.99 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.27. volume snapshot set
ボリュームスナップショットの属性を設定します。
使用方法
openstack volume snapshot set [-h] [--name <name>] [--description <description>] [--no-property] [--property <key=value>] [--state <state>] <snapshot>
表86.100 位置引数
値 | 概要 |
---|---|
<snapshot> | 変更するスナップショット (名前または ID) |
表86.101 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 新しいスナップショット名 |
--description <description> | 新しいスナップショットの説明 |
--no-property | <snapshot>からすべての属性を削除します (新しい属性を設定する前に現在の属性を削除するには --no-property と --property の両方を指定します)。 |
--property <key=value> | このスナップショットに追加/変更する属性 (複数の属性を設定する場合はオプションを繰り返し使用します) |
--state <state> | 新しいボリュームの状態 ("available"、"error"、"creating"、"deleting"、または "error_deleting") (管理者のみ) (このオプションは、実際のステータスに関係なくデータベースのスナップショットの状態を変更するだけで、使用時には注意が必要です) |
86.28. volume snapshot show
ボリュームスナップショットの詳細を表示します。
使用方法
openstack volume snapshot show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <snapshot>
表86.102 位置引数
値 | 概要 |
---|---|
<snapshot> | 表示するスナップショット (名前または ID) |
表86.103 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表86.104 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表86.105 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.106 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表86.107 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.29. volume snapshot unset
ボリュームスナップショット属性の設定を解除します。
使用方法
openstack volume snapshot unset [-h] [--property <key>] <snapshot>
表86.108 位置引数
値 | 概要 |
---|---|
<snapshot> | 変更するスナップショット (名前または ID) |
表86.109 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--property <key> | スナップショットから削除する属性 (複数の属性を削除する場合はオプションを繰り返し使用します) |
86.30. volume transfer request accept
ボリュームの譲渡要求を受け入れます。
使用方法
openstack volume transfer request accept [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --auth-key <key> <transfer-request-id>
表86.110 位置引数
値 | 概要 |
---|---|
<transfer-request-id> | 受け入れるボリュームの譲渡要求 (id のみ) |
表86.111 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--auth-key <key> | ボリュームの転送要求の認証キー |
表86.112 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表86.113 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.114 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表86.115 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.31. volume transfer request create
ボリュームの譲渡要求を作成します。
使用方法
openstack volume transfer request create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] <volume>
表86.116 位置引数
値 | 概要 |
---|---|
<volume> | 譲渡するボリューム (名前または ID) |
表86.117 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | 新規譲渡要求の名前 (デフォルトは none) |
表86.118 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表86.119 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.120 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表86.121 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.32. volume transfer request delete
ボリュームの譲渡要求を削除します。
使用方法
openstack volume transfer request delete [-h] <transfer-request> [<transfer-request> ...]
表86.122 位置引数
値 | 概要 |
---|---|
<transfer-request> | 削除するボリュームの譲渡要求 (名前または ID) |
表86.123 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
86.33. volume transfer request list
すべてのボリュームの譲渡要求をリスト表示します。
使用方法
openstack volume transfer request list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--all-projects]
表86.124 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトを含めます (管理者のみ)。 |
表86.125 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表86.126 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表86.127 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.128 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.34. volume transfer request show
ボリュームの譲渡要求の詳細を表示します。
使用方法
openstack volume transfer request show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <transfer-request>
表86.129 位置引数
値 | 概要 |
---|---|
<transfer-request> | 表示するボリュームの譲渡要求 (名前または ID) |
表86.130 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表86.131 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表86.132 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.133 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表86.134 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.35. volume type create
新規ボリューム種別を作成します。
使用方法
openstack volume type create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--public | --private] [--property <key=value>] [--project <project>] [--encryption-provider <provider>] [--encryption-cipher <cipher>] [--encryption-key-size <key-size>] [--encryption-control-location <control-location>] [--project-domain <project-domain>] <name>
表86.135 位置引数
値 | 概要 |
---|---|
<name> | ボリューム種別名 |
表86.136 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description <description> | ボリューム種別の説明 |
--public | ボリューム種別にパブリックからアクセスできる。 |
--private | ボリューム種別にパブリックからアクセスできない。 |
--property <key=value> | このボリューム種別に属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します) |
--project <project> | <project>(名前または ID) がプライベート種別にアクセスできるようにします (--private オプションと併せて使用する必要があります)。 |
--encryption-provider <provider> | このボリューム種別の暗号化プロバイダー形式 (luks または plain など) を設定します (このオプションは、ボリュームの暗号化種別を設定する際に必要です)。-- encryption-cipher、--encryption-key-size、および-- encryption-control-location などの他の暗号化オプションの使用を検討してください。 |
--encryption-cipher <cipher> | このボリューム種別の暗号化アルゴリズムまたはモードを設定します (例:aes-xts-plain64)。(管理者のみ) |
--encryption-key-size <key-size> | このボリューム種別の暗号化キーのサイズを設定します (例:128 または 256)。(管理者のみ) |
--encryption-control-location <control-location> | 暗号化が実施される想定サービス ("front-end" または "back-end") を設定します (管理者のみ)。(ボリュームの暗号化種別を設定する際のこのオプションのデフォルト値は、"front-end"です。--encryption- cipher、--encryption-key-size、および--encryption- provider などの他の暗号化オプションの使用を検討してください。) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
表86.137 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表86.138 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.139 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表86.140 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.36. volume type delete
ボリューム種別を削除します。
使用方法
openstack volume type delete [-h] <volume-type> [<volume-type> ...]
表86.141 位置引数
値 | 概要 |
---|---|
<volume-type> | 削除するボリューム種別 (名前または ID) |
表86.142 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
86.37. volume type list
ボリューム種別をリスト表示します。
使用方法
openstack volume type list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--default | --public | --private] [--encryption-type]
表86.143 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--long | 出力の追加フィールドをリスト表示します。 |
--default | デフォルトのボリューム種別をリスト表示します。 |
--public | パブリック種別のみをリスト表示します。 |
--private | プライベート種別のみをリスト表示します (管理者のみ)。 |
--encryption-type | 各ボリューム種別の暗号化情報を表示します (管理者のみ)。 |
表86.144 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表86.145 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表86.146 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.147 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.38. volume type set
ボリューム種別の属性を設定します。
使用方法
openstack volume type set [-h] [--name <name>] [--description <description>] [--property <key=value>] [--project <project>] [--project-domain <project-domain>] [--encryption-provider <provider>] [--encryption-cipher <cipher>] [--encryption-key-size <key-size>] [--encryption-control-location <control-location>] <volume-type>
表86.148 位置引数
値 | 概要 |
---|---|
<volume-type> | 変更するボリューム種別 (名前または ID) |
表86.149 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name <name> | ボリューム種別名を設定します。 |
--description <description> | ボリューム種別の説明を設定します。 |
--property <key=value> | このボリューム種別に属性を設定します (複数の属性を設定する場合はオプションを繰り返し使用します) |
--project <project> | プロジェクト (名前または ID) へのボリューム種別アクセスを設定します (管理者のみ)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--encryption-provider <provider> | このボリューム種別の暗号化プロバイダー形式 (luks または plain など) を設定します (このオプションは、ボリュームの暗号化種別を初めて設定する際に必要です)。--encryption-cipher、--encryption- key-size、および--encryption-control-location などの他の暗号化オプションの使用を検討してください。 |
--encryption-cipher <cipher> | このボリューム種別の暗号化アルゴリズムまたはモードを設定します (例:aes-xts-plain64)。(管理者のみ) |
--encryption-key-size <key-size> | このボリューム種別の暗号化キーのサイズを設定します (例:128 または 256)。(管理者のみ) |
--encryption-control-location <control-location> | 暗号化が実施される想定サービス ("front-end" または "back-end") を設定します (管理者のみ)。(ボリュームの暗号化種別を初めて設定する際のこのオプションのデフォルト値は、"front-end"です。--encryption-cipher、--encryption-key-size、および-- encryption-provider などの他の暗号化オプションの使用を検討してください。) |
86.39. volume type show
ボリューム種別の詳細を表示します。
使用方法
openstack volume type show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--encryption-type] <volume-type>
表86.150 位置引数
値 | 概要 |
---|---|
<volume-type> | 表示するボリューム種別 (名前または ID) |
表86.151 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--encryption-type | このボリューム種別の暗号化情報を表示します (管理者のみ)。 |
表86.152 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表86.153 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表86.154 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表86.155 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
86.40. volume type unset
ボリューム種別の属性の設定を解除します。
使用方法
openstack volume type unset [-h] [--property <key>] [--project <project>] [--project-domain <project-domain>] [--encryption-type] <volume-type>
表86.156 位置引数
値 | 概要 |
---|---|
<volume-type> | 変更するボリューム種別 (名前または ID) |
表86.157 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--property <key> | このボリューム種別から属性を削除します (複数の属性を削除する場合はオプションを繰り返し使用します) |
--project <project> | プロジェクト (名前または ID) へのボリューム種別アクセスを削除します (管理者のみ)。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--encryption-type | このボリューム種別の暗号化種別を削除します (管理者のみ)。 |
86.41. volume unset
ボリューム属性の設定を解除します。
使用方法
openstack volume unset [-h] [--property <key>] [--image-property <key>] <volume>
表86.158 位置引数
値 | 概要 |
---|---|
<volume> | 変更するボリューム (名前または ID) |
表86.159 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--property <key> | ボリュームから属性を削除します (複数の属性を削除する場合はオプションを繰り返し使用します) |
--image-property <key> | ボリュームからイメージ属性を削除します (複数のイメージ属性を削除する場合はオプションを繰り返し使用します) |
第87章 workbook
本章では、workbook
コマンドに含まれるコマンドについて説明します。
87.1. workbook create
新規のワークブックを作成します。
使用方法
openstack workbook create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--public] [--namespace [NAMESPACE]] definition
表87.1 位置引数
値 | 概要 |
---|---|
定義 | ワークブックの定義ファイル |
表87.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--public | このフラグを使用した場合には、ワークブックにはパブリックのマークが付けられます。 |
--namespace [NAMESPACE] | ワークブックを作成する名前空間 |
表87.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表87.4 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表87.5 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表87.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
87.2. workbook definition show
ワークブックの定義を表示します。
使用方法
openstack workbook definition show [-h] name
表87.7 位置引数
値 | 概要 |
---|---|
name | ワークブック名 |
表87.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
87.3. workbook delete
ワークブックを削除します。
使用方法
openstack workbook delete [-h] [--namespace [NAMESPACE]] workbook [workbook ...]
表87.9 位置引数
値 | 概要 |
---|---|
workbook | ワークブックの名前。 |
表87.10 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--namespace [NAMESPACE] | ワークブックを削除する名前空間 |
87.4. workbook list
すべてのワークブックをリスト表示します。
使用方法
openstack workbook list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS]
表87.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 | フィルター。繰り返し使用できます。 |
表87.12 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表87.13 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表87.14 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表87.15 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
87.5. workbook show
特定のワークブックを表示します。
使用方法
openstack workbook show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--namespace [NAMESPACE]] workbook
表87.16 位置引数
値 | 概要 |
---|---|
workbook | ワークブック名 |
表87.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--namespace [NAMESPACE] | ワークブックを取得する名前空間 |
表87.18 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表87.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表87.20 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表87.21 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
87.6. workbook update
ワークブックを更新します。
使用方法
openstack workbook update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--namespace [NAMESPACE]] [--public] definition
表87.22 位置引数
値 | 概要 |
---|---|
定義 | ワークブックの定義ファイル |
表87.23 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--namespace [NAMESPACE] | ワークブックを更新する名前空間 |
--public | このフラグを使用した場合には、ワークブックにはパブリックのマークが付けられます。 |
表87.24 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表87.25 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表87.26 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表87.27 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
87.7. workbook validate
ワークブックを検証します。
使用方法
openstack workbook validate [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] definition
表87.28 位置引数
値 | 概要 |
---|---|
定義 | ワークブックの定義ファイル |
表87.29 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表87.30 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表87.31 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表87.32 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表87.33 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第88章 workflow
本章では、workflow
コマンドに含まれるコマンドについて説明します。
88.1. workflow create
新規ワークフローを作成します。
使用方法
openstack workflow create [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS] [--namespace [NAMESPACE]] [--public] definition
表88.1 位置引数
値 | 概要 |
---|---|
定義 | ワークフローの定義ファイル。 |
表88.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 | フィルター。繰り返し使用できます。 |
--namespace [NAMESPACE] | ワークフローを作成する名前空間 |
--public | このフラグを使用した場合には、ワークフローにはパブリックのマークが付けられます。 |
表88.3 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表88.4 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表88.5 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表88.6 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
88.2. workflow definition show
ワークフローの定義を表示します。
使用方法
openstack workflow definition show [-h] [--namespace [NAMESPACE]] identifier
表88.7 位置引数
値 | 概要 |
---|---|
identifier | ワークフローの ID または名前。 |
表88.8 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--namespace [NAMESPACE] | ワークフローを取得する名前空間 |
88.3. workflow delete
ワークフローを削除します。
使用方法
openstack workflow delete [-h] [--namespace [NAMESPACE]] workflow [workflow ...]
表88.9 位置引数
値 | 概要 |
---|---|
workflow | ワークフローの名前または ID。 |
表88.10 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--namespace [NAMESPACE] | ワークフローを削除する名前空間 |
88.4. workflow engine service list
全サービスをリスト表示します。
使用方法
openstack workflow engine service list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS]
表88.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 | フィルター。繰り返し使用できます。 |
表88.12 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表88.13 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表88.14 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表88.15 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
88.5. workflow env create
新規環境を作成します。
使用方法
openstack workflow env create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] file
表88.16 位置引数
値 | 概要 |
---|---|
file | json または yaml の環境設定ファイル |
表88.17 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表88.18 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表88.19 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表88.20 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表88.21 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
88.6. workflow env delete
環境を削除します。
使用方法
openstack workflow env delete [-h] environment [environment ...]
表88.22 位置引数
値 | 概要 |
---|---|
environment | 環境の名前 |
表88.23 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
88.7. workflow env list
すべての環境をリスト表示します。
使用方法
openstack workflow env list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS]
表88.24 コマンド引数
値 | 概要 |
---|---|
-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 | フィルター。繰り返し使用できます。 |
表88.25 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表88.26 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表88.27 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表88.28 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
88.8. workflow env show
特定の環境を表示します。
使用方法
openstack workflow env show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--export] environment
表88.29 位置引数
値 | 概要 |
---|---|
environment | 環境名 |
表88.30 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--export | インポートに適した環境をエクスポートします。 |
表88.31 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表88.32 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表88.33 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表88.34 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
88.9. workflow env update
環境を更新します。
使用方法
openstack workflow env update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] file
表88.35 位置引数
値 | 概要 |
---|---|
file | json または yaml の環境設定ファイル |
表88.36 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表88.37 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表88.38 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表88.39 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表88.40 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
88.10. workflow execution create
新規実行を作成します。
使用方法
openstack workflow execution create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--namespace [NAMESPACE]] [-d DESCRIPTION] [-s [SOURCE_EXECUTION_ID]] [workflow_identifier] [workflow_input] [params]
表88.41 位置引数
値 | 概要 |
---|---|
workflow_identifier | ワークフローの ID または名前。ワークフロー名は、Mitaka 以降は非推奨になります。 |
workflow_input | ワークフロー入力 |
params | ワークフローの追加パラメーター |
表88.42 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--namespace [NAMESPACE] | ワークフローの名前空間。 |
-d DESCRIPTION、--description DESCRIPTION | 実行の説明 |
-s [SOURCE_EXECUTION_ID] | ワークフローの実行 ID。これにより、オペレーターは以前に正常に実行されたワークフローに基づいて新しいワークフロー実行を作成できます。例:mistral execution-create -s 123e4567-e89b-12d3-a456-426655440000 |
表88.43 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表88.44 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表88.45 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表88.46 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
88.11. workflow execution delete
実行を削除します。
使用方法
openstack workflow execution delete [-h] [--force] execution [execution ...]
表88.47 位置引数
値 | 概要 |
---|---|
execution | 実行識別子の ID。 |
表88.48 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--force | 実行を強制的に削除します。実行中の実行に使用すると、エラーが連続して発生する可能性があります。 |
88.12. workflow execution input show
実行の入力データを表示します。
使用方法
openstack workflow execution input show [-h] id
表88.49 位置引数
値 | 概要 |
---|---|
id | 実行 ID |
表88.50 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
88.13. workflow execution list
すべての実行をリスト表示します。
使用方法
openstack workflow execution list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS] [--oldest] [--task [TASK]]
表88.51 コマンド引数
値 | 概要 |
---|---|
-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 | 最新のエントリーからではなく、最も古いエントリーから開始する実行を表示します。 |
--task [TASK] | ワークフロー実行リストに関連付けられた親タスク実行 ID。 |
表88.52 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表88.53 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表88.54 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表88.55 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
88.14. workflow execution output show
実行の出力データを表示します。
使用方法
openstack workflow execution output show [-h] id
表88.56 位置引数
値 | 概要 |
---|---|
id | 実行 ID |
表88.57 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
88.15. workflow execution published show
ワークフローのグローバルに公開されている変数を表示します。
使用方法
openstack workflow execution published show [-h] id
表88.58 位置引数
値 | 概要 |
---|---|
id | ワークフロー id |
表88.59 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
88.16. workflow execution report show
実行のレポートを出力します。
使用方法
openstack workflow execution report show [-h] [--errors-only] [--no-errors-only] [--max-depth [MAX_DEPTH]] id
表88.60 位置引数
値 | 概要 |
---|---|
id | 実行 ID |
表88.61 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--errors-only | エラーパスのみが含まれます。 |
--no-errors-only | エラーパス以外も含まれます。 |
--max-depth [MAX_DEPTH] | ワークフロー実行ツリーの最大深さ。0 の場合、ルートワークフローの実行とそのタスクのみが含まれます。 |
88.17. workflow execution show
特定の実行を表示します。
使用方法
openstack workflow execution show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] execution
表88.62 位置引数
値 | 概要 |
---|---|
execution | 実行の識別子 |
表88.63 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表88.64 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表88.65 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表88.66 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表88.67 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
88.18. workflow execution update
実行を更新します。
使用方法
openstack workflow execution update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}] [-e ENV] [-d DESCRIPTION] id
表88.68 位置引数
値 | 概要 |
---|---|
id | 実行の識別子 |
表88.69 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}、--state {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED} | 実行の状態 |
-e ENV、--env ENV | 環境変数 |
-d DESCRIPTION、--description DESCRIPTION | 実行の説明 |
表88.70 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表88.71 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表88.72 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表88.73 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
88.19. workflow list
すべてのワークフローをリスト表示します。
使用方法
openstack workflow list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS]
表88.74 コマンド引数
値 | 概要 |
---|---|
-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 | フィルター。繰り返し使用できます。 |
表88.75 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表88.76 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表88.77 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表88.78 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
88.20. workflow show
特定のワークフローを表示します。
使用方法
openstack workflow show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--namespace [NAMESPACE]] workflow
表88.79 位置引数
値 | 概要 |
---|---|
workflow | ワークフローの ID または名前。 |
表88.80 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--namespace [NAMESPACE] | ワークフローを取得する名前空間 |
表88.81 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表88.82 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表88.83 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表88.84 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
88.21. workflow update
ワークフローを更新します。
使用方法
openstack workflow update [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--marker [MARKER]] [--limit [LIMIT]] [--sort_keys [SORT_KEYS]] [--sort_dirs [SORT_DIRS]] [--filter FILTERS] [--id ID] [--namespace [NAMESPACE]] [--public] definition
表88.85 位置引数
値 | 概要 |
---|---|
定義 | ワークフローの定義 |
表88.86 コマンド引数
値 | 概要 |
---|---|
-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 |
--namespace [NAMESPACE] | ワークフローの名前空間 |
--public | このフラグを使用した場合には、ワークフローにはパブリックのマークが付けられます。 |
表88.87 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表88.88 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表88.89 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表88.90 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
88.22. workflow validate
ワークフローを検証します。
使用方法
openstack workflow validate [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] definition
表88.91 位置引数
値 | 概要 |
---|---|
定義 | ワークフローの定義ファイル |
表88.92 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
表88.93 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表88.94 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表88.95 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表88.96 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
第89章 zone
本章では、zone
コマンドに含まれるコマンドについて説明します。
89.1. zone abandon
ゾーンを破棄します。
使用方法
openstack zone abandon [-h] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表89.1 位置引数
値 | 概要 |
---|---|
id | ゾーンの id |
表89.2 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
89.2. zone axfr
ゾーンの自動ゾーン転送を行います。
使用方法
openstack zone axfr [-h] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表89.3 位置引数
値 | 概要 |
---|---|
id | ゾーンの id |
表89.4 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
89.3. zone blacklist create
新規ブラックリストを作成します。
使用方法
openstack zone blacklist create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --pattern PATTERN [--description DESCRIPTION] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
表89.5 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--pattern PATTERN | ブラックリストのパターン |
--description DESCRIPTION | 説明 |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.6 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.7 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.8 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.9 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.4. zone blacklist delete
ブラックリストを削除します。
使用方法
openstack zone blacklist delete [-h] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表89.10 位置引数
値 | 概要 |
---|---|
id | ブラックリストの id |
表89.11 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
89.5. zone blacklist list
ブラックリストをリスト表示します。
使用方法
openstack zone blacklist list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
表89.12 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.13 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表89.14 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表89.15 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.16 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.6. zone blacklist set
ブラックリストの属性を設定します。
使用方法
openstack zone blacklist set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--pattern PATTERN] [--description DESCRIPTION | --no-description] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表89.17 位置引数
値 | 概要 |
---|---|
id | ブラックリストの id |
表89.18 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--pattern PATTERN | ブラックリストのパターン |
--description DESCRIPTION | 説明 |
--no-description—all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.19 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.20 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.21 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.22 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.7. zone blacklist show
ブラックリストの詳細を表示します。
使用方法
openstack zone blacklist show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表89.23 位置引数
値 | 概要 |
---|---|
id | ブラックリストの id |
表89.24 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.25 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.26 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.27 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.28 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.8. zone create
新しいゾーンを作成します。
使用方法
openstack zone create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--email EMAIL] [--type TYPE] [--ttl TTL] [--description DESCRIPTION] [--masters MASTERS [MASTERS ...]] [--attributes ATTRIBUTES [ATTRIBUTES ...]] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] name
表89.29 位置引数
値 | 概要 |
---|---|
name | ゾーン名 |
表89.30 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--email EMAIL | ゾーンのメール |
--type TYPE | ゾーンの種別 |
--ttl TTL | 存続期間 (秒) |
--description DESCRIPTION | 説明 |
--masters MASTERS [MASTERS …] | ゾーンのマスター |
--attributes ATTRIBUTES [ATTRIBUTES …] | ゾーンの属性 |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.31 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.32 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.33 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.34 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.9. zone delete
ゾーンを削除します。
使用方法
openstack zone delete [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表89.35 位置引数
値 | 概要 |
---|---|
id | ゾーンの id |
表89.36 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.37 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.38 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.39 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.40 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.10. zone export create
ゾーンをエクスポートします。
使用方法
openstack zone export create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] zone_id
表89.41 位置引数
値 | 概要 |
---|---|
zone_id | ゾーンの id |
表89.42 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.43 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.44 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.45 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.46 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.11. zone export delete
ゾーンのエクスポートを削除します。
使用方法
openstack zone export delete [-h] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] zone_export_id
表89.47 位置引数
値 | 概要 |
---|---|
zone_export_id | ゾーンエクスポート ID |
表89.48 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
89.12. zone export list
ゾーンのエクスポートをリスト表示します。
使用方法
openstack zone export list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
表89.49 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.50 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表89.51 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表89.52 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.53 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.13. zone export show
ゾーンのエクスポートを表示します。
使用方法
openstack zone export show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] zone_export_id
表89.54 位置引数
値 | 概要 |
---|---|
zone_export_id | ゾーンエクスポート ID |
表89.55 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.56 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.57 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.58 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.59 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.14. zone export showfile
ゾーンエクスポートのゾーンファイルを表示します。
使用方法
openstack zone export showfile [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] zone_export_id
表89.60 位置引数
値 | 概要 |
---|---|
zone_export_id | ゾーンエクスポート ID |
表89.61 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.62 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.63 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.64 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.65 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.15. zone import create
ファイルシステムのファイルからゾーンをインポートします。
使用方法
openstack zone import create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] zone_file_path
表89.66 位置引数
値 | 概要 |
---|---|
zone_file_path | ゾーンファイルへのパス |
表89.67 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.68 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.69 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.70 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.71 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.16. zone import delete
ゾーンのインポートを削除します。
使用方法
openstack zone import delete [-h] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] zone_import_id
表89.72 位置引数
値 | 概要 |
---|---|
zone_import_id | ゾーンインポート id |
表89.73 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
89.17. zone import list
ゾーンのインポートをリスト表示します。
使用方法
openstack zone import list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
表89.74 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.75 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表89.76 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表89.77 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.78 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.18. zone import show
ゾーンのインポートを表示します。
使用方法
openstack zone import show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] zone_import_id
表89.79 位置引数
値 | 概要 |
---|---|
zone_import_id | ゾーンインポート id |
表89.80 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.81 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.82 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.83 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.84 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.19. zone list
ゾーンのリストを表示します。
使用方法
openstack zone list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name NAME] [--email EMAIL] [--type TYPE] [--ttl TTL] [--description DESCRIPTION] [--status STATUS] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
表89.85 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--name NAME | ゾーン名 |
--email EMAIL | ゾーンのメール |
--type TYPE | ゾーンの種別 |
--ttl TTL | 存続期間 (秒) |
--description DESCRIPTION | 説明 |
--status STATUS | ゾーンのステータス |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.86 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表89.87 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表89.88 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.89 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.20. zone set
ゾーンの属性を設定します。
使用方法
openstack zone set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--email EMAIL] [--ttl TTL] [--description DESCRIPTION | --no-description] [--masters MASTERS [MASTERS ...]] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表89.90 位置引数
値 | 概要 |
---|---|
id | ゾーンの id |
表89.91 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--email EMAIL | ゾーンのメール |
--ttl TTL | 存続期間 (秒) |
--description DESCRIPTION | 説明 |
--no-description—masters MASTERS [MASTERS …] | ゾーンのマスター |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.92 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.93 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.94 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.95 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.21. zone show
ゾーンの詳細を表示します。
使用方法
openstack zone show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表89.96 位置引数
値 | 概要 |
---|---|
id | ゾーンの id |
表89.97 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.98 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.99 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.100 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.101 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.22. zone transfer accept list
ゾーン転送の受理をリスト表示します。
使用方法
openstack zone transfer accept list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
表89.102 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.103 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表89.104 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表89.105 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.106 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.23. zone transfer accept request
ゾーン転送リクエストを許可します。
使用方法
openstack zone transfer accept request [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --transfer-id TRANSFER_ID --key KEY [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
表89.107 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--transfer-id TRANSFER_ID | 転送 id |
--key KEY | 転送キー |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.108 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.109 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.110 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.111 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.24. zone transfer accept show
ゾーン転送の受理を表示します。
使用方法
openstack zone transfer accept show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表89.112 位置引数
値 | 概要 |
---|---|
id | ゾーン転送受理 ID |
表89.113 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.114 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.115 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.116 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.117 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.25. zone transfer request create
新しいゾーン転送リクエストを作成します。
使用方法
openstack zone transfer request create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--target-project-id TARGET_PROJECT_ID] [--description DESCRIPTION] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] zone_id
表89.118 位置引数
値 | 概要 |
---|---|
zone_id | 転送するゾーン ID。 |
表89.119 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--target-project-id TARGET_PROJECT_ID | 転送先のターゲットプロジェクト ID。 |
--description DESCRIPTION | 説明 |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.120 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.121 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.122 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.123 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.26. zone transfer request delete
ゾーン転送リクエストを削除します。
使用方法
openstack zone transfer request delete [-h] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表89.124 位置引数
値 | 概要 |
---|---|
id | ゾーン転送リクエスト ID |
表89.125 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
89.27. zone transfer request list
ゾーン転送リクエストのリストを表示します。
使用方法
openstack zone transfer request list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
表89.126 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.127 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表89.128 CSV フォーマット設定オプション
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表89.129 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.130 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.28. zone transfer request set
ゾーン転送リクエストを設定します。
使用方法
openstack zone transfer request set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description DESCRIPTION | --no-description] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表89.131 位置引数
値 | 概要 |
---|---|
id | ゾーン転送リクエスト ID |
表89.132 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--description DESCRIPTION | 説明 |
--no-description—all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.133 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.134 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.135 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.136 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
89.29. zone transfer request show
ゾーン転送リクエストの詳細を表示します。
使用方法
openstack zone transfer request show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--all-projects] [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID] id
表89.137 位置引数
値 | 概要 |
---|---|
id | ゾーン転送リクエスト ID |
表89.138 コマンド引数
値 | 概要 |
---|---|
-h、--help | help メッセージを表示して終了します |
--all-projects | すべてのプロジェクトの結果を表示します。デフォルト:false |
--edit-managed | マネージドのリソースを編集します。デフォルト:false |
--sudo-project-id SUDO_PROJECT_ID | このコマンドの権限を借用するプロジェクト ID。デフォルト:None |
表89.139 出力フォーマット設定オプション
値 | 概要 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表89.140 JSON フォーマット設定オプション
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表89.141 シェルフォーマット設定オプション
値 | 概要 |
---|---|
--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
表89.142 テーブルフォーマット設定オプション
値 | 概要 |
---|---|
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |