コマンドラインインターフェイスリファレンス
Red Hat OpenStack Platform のコマンドラインクライアント
概要
はじめに
OpenStack に組み込まれているコマンドラインクライアントで利用できるコマンドに関するリファレンス
第1章 OpenStack クライアント
openstack
クライアントは、一般的な OpenStack コマンドラインインターフェイス (CLI) です。本章では、openstack
バージョン 3.14.3 の主なオプションについて説明します。:leveloffset: +1
OpenStack API へのコマンドラインインターフェイス
使用方法
openstack [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug] [--os-cloud <cloud-config-name>] [--os-region-name <auth-region-name>] [--os-cacert <ca-bundle-file>] [--os-cert <certificate-file>] [--os-key <key-file>] [--verify | --insecure] [--os-default-domain <auth-domain>] [--os-interface <interface>] [--os-service-provider <service_provider>] [--os-remote-project-name <remote_project_name> | --os-remote-project-id <remote_project_id>] [--os-remote-project-domain-name <remote_project_domain_name> | --os-remote-project-domain-id <remote_project_domain_id>] [--timing] [--os-beta-command] [--os-profile hmac-key] [--os-compute-api-version <compute-api-version>] [--os-network-api-version <network-api-version>] [--os-image-api-version <image-api-version>] [--os-volume-api-version <volume-api-version>] [--os-identity-api-version <identity-api-version>] [--os-object-api-version <object-api-version>] [--os-queues-api-version <queues-api-version>] [--os-tripleoclient-api-version <tripleoclient-api-version>] [--os-key-manager-api-version <key-manager-api-version>] [--os-loadbalancer-api-version <loadbalancer-api-version>] [--os-metrics-api-version <metrics-api-version>] [--os-workflow-api-version <workflow-api-version>] [--os-baremetal-api-version <baremetal-api-version>] [--os-dns-api-version <dns-api-version>] [--os-alarming-api-version <alarming-api-version>] [--os-orchestration-api-version <orchestration-api-version>] [--os-data-processing-api-version <data-processing-api-version>] [--os-data-processing-url OS_DATA_PROCESSING_URL] [--os-container-infra-api-version <container-infra-api-version>] [--inspector-api-version INSPECTOR_API_VERSION] [--inspector-url INSPECTOR_URL] [--os-database-api-version <database-api-version>] [--os-auth-type <auth-type>] [--os-project-domain-id <auth-project-domain-id>] [--os-protocol <auth-protocol>] [--os-project-name <auth-project-name>] [--os-trust-id <auth-trust-id>] [--os-consumer-key <auth-consumer-key>] [--os-domain-name <auth-domain-name>] [--os-access-secret <auth-access-secret>] [--os-user-domain-id <auth-user-domain-id>] [--os-access-token-type <auth-access-token-type>] [--os-code <auth-code>] [--os-application-credential-name <auth-application-credential-name>] [--os-identity-provider-url <auth-identity-provider-url>] [--os-aodh-endpoint <auth-aodh-endpoint>] [--os-service-provider-endpoint <auth-service-provider-endpoint>] [--os-access-token <auth-access-token>] [--os-domain-id <auth-domain-id>] [--os-user-domain-name <auth-user-domain-name>] [--os-openid-scope <auth-openid-scope>] [--os-user-id <auth-user-id>] [--os-application-credential-secret <auth-application-credential-secret>] [--os-identity-provider <auth-identity-provider>] [--os-username <auth-username>] [--os-auth-url <auth-auth-url>] [--os-client-secret <auth-client-secret>] [--os-access-token-endpoint <auth-access-token-endpoint>] [--os-default-domain-id <auth-default-domain-id>] [--os-discovery-endpoint <auth-discovery-endpoint>] [--os-client-id <auth-client-id>] [--os-default-domain-name <auth-default-domain-name>] [--os-project-domain-name <auth-project-domain-name>] [--os-service-provider-entity-id <auth-service-provider-entity-id>] [--os-access-key <auth-access-key>] [--os-password <auth-password>] [--os-redirect-uri <auth-redirect-uri>] [--os-endpoint <auth-endpoint>] [--os-roles <auth-roles>] [--os-url <auth-url>] [--os-consumer-secret <auth-consumer-secret>] [--os-token <auth-token>] [--os-application-credential-id <auth-application-credential-id>] [--os-passcode <auth-passcode>] [--os-system-scope <auth-system-scope>] [--os-project-id <auth-project-id>] [--os-user <auth-user>]
表1.1 その他の引数 (オプション):
値 | 概要 |
---|---|
--inspector-url INSPECTOR_URL | インスペクター url。デフォルトは localhost です (env: INMYBACKUPDIRTOR_URL)。 |
--os-cacert <ca-bundle-file> | CA 証明書バンドルファイル (env: os_cacert) |
--os-baremetal-api-version <baremetal-api-version> | ベアメタル api バージョン、デフォルト="latest"(クライアントとサーバーの両方でサポートされる最新バージョン)(Env: OS_BAREMETAL_API_VERSION) |
--inspector-api-version INSPECTOR_API_VERSION | インスペクター api バージョン。バージョン 1 だけがサポート対象です (env: INMYBACKUPDIRTOR_VERSION)。 |
--os-redirect-uri <auth-redirect-uri> | v3oidcauthcode: openid connect リダイレクト url (env: OS_REPOL_URI) |
--os-cloud <cloud-config-name> | Clouds.yaml のクラウド名 (env: os_cloud) |
--os-container-infra-api-version <container-infra-api-version> | Container-infra api バージョン、デフォルト=1(env: OS_CONTAINER_INFRA_API_VERSION) |
--os-alarming-api-version <alarming-api-version> | キュー api バージョン、デフォルト=2(env: OS_ALARMING_API_VERSION) |
--os-user-id <auth-user-id> | password: ユーザー ID。v2password: ログイン用ユーザー ID。v3password: ユーザー ID。noauth: ユーザー ID。v3totp: ユーザー ID。v3applicationcredential: ユーザー ID。aodh-noauth: ユーザー ID。gnocchi-noauth: ユーザー ID。(Env: OS_USER_ID) |
-h, --help | ヘルプメッセージを表示して終了します。 |
--os-project-name <auth-project-name> | password: 範囲内のプロジェクト名。v3adfspassword: 範囲内のプロジェクト名。v3oidcclientcredentials: 範囲内のプロジェクト名。v3samlpassword: 範囲内のプロジェクト名。v3password: 範囲内のプロジェクト名。v3oidcaccesstoken: 範囲内のプロジェクト名。v3oidcpassword: 範囲内のプロジェクト名。token: 範囲内のプロジェクト名。v3tokenlessauth: 範囲内のプロジェクト名。v3totp: 範囲内のプロジェクト名。v3applicationcredential: 範囲内のプロジェクト名。v1password: 使用する Swift アカウント。v3oidcauthcode: 範囲内のプロジェクト名。v3token: 範囲内のプロジェクト名。v3multifactor: 範囲内のプロジェクト名。(Env: OS_PROJECT_NAME) |
--os-trust-id <auth-trust-id> | password: 信頼 ID。v3adfspassword: 信頼 ID。v3oidcclientcredentials: 信頼 ID。v3samlpassword: 信頼 ID。v2password: 信頼 ID。v3password: 信頼 ID。v3oidcaccesstoken: 信頼 ID。v2token: 信頼 ID。v3oidcpassword: 信頼 ID。token: 信頼 ID。v3totp: 信頼 ID。v3applicationcredential: 信頼 ID。v3oidcauthcode: 信頼 ID。v3token: 信頼 ID。v3multifactor: 信頼 ID。(Env: OS_TRUST_ID) |
--os-identity-api-version <identity-api-version> | api バージョンを特定します。デフォルト=3(env: OS_IDMYBACKUPDIR_API_VERSION) |
--os-remote-project-name <remote_project_name> | Keystone-to-Keystone フェデレーションを使用する場合の、サービスプロバイダーに対して認証する際のプロジェクト名。 |
--verify | サーバー証明書を検証します (デフォルト) |
--os-remote-project-domain-id <remote_project_domain_id> | Keystone-to-Keystone フェデレーションを使用する場合の、サービスプロバイダーに対して認証する際のプロジェクトのドメイン ID。 |
--os-system-scope <auth-system-scope> | password: システム運用の範囲。v3adfspassword: システム運用の範囲。v3oidcclientcredentials: システム運用の範囲。v3samlpassword: システム運用の範囲。v3password: システム運用の範囲。v3oidcaccesstoken: システム運用の範囲。v3oidcpassword: システム運用の範囲。token: システム運用の範囲。v3totp: システム運用の範囲。v3applicationcredential: システム運用の範囲。v3oidcauthcode: システム運用の範囲。v3token: システム運用の範囲。v3multifactor: システム運用の範囲。(Env: OS_SYSTEM_SCOPE) |
--os-auth-type <auth-type> | 認証タイプを選択します。利用可能なタイプ:v2token、v3adfspassword、admin_token、v2password、v3password、noauth、v3token、v3oauth1、v3oidcauthcode、v3samlpassword、token_endpoint、v1password、v3totp、aodh-noauth、v3tokenlessauth、v3oidcclientcredentials、 gnocchi-basic, gnocchi-noauth, password, none, v3oidcaccesstoken, v3oidcpassword, token, v3applicationcredentialデフォルト:--os-username/--os-token をもとに選択されます (Env: OS_AUTH_TYPE)。 |
--os-remote-project-domain-name <remote_project_domain_name> | Keystone-to-Keystone フェデレーションを使用する場合の、サービスプロバイダーに対して認証する際のプロジェクトのドメイン名。 |
--os-project-domain-name <auth-project-domain-name> | password: プロジェクトが含まれるドメイン名。v3adfspassword: プロジェクトが含まれるドメイン名。v3oidcclientcredentials: プロジェクトが含まれるドメイン名。v3samlpassword: プロジェクトが含まれるドメイン名。v3password: プロジェクトが含まれるドメイン名。v3oidcaccesstoken: プロジェクトが含まれるドメイン名。v3oidcpassword: プロジェクトが含まれるドメイン名。token: プロジェクトが含まれるドメイン名。v3tokenlessauth: プロジェクトが含まれるドメイン名。v3totp: プロジェクトが含まれるドメイン名。3applicationcredential: プロジェクトが含まれるドメイン名。v3oidcauthcode: プロジェクトが含まれるドメイン名。v3token: プロジェクトが含まれるドメイン名。v3multifactor: プロジェクトが含まれるドメイン名。(Env: OS_PROJECT_DOMAIN_NAME) |
--os-endpoint <auth-endpoint> | admin_token: 常に使用されるエンドポイント。none: 常に使用されるエンドポイント。gnocchi-basic: Gnocchi エンドポイント。noauth: Cinder エンドポイント。gnocchi-noauth: Gnocchi エンドポイント。(Env: OS_ENDPOINT) |
--os-default-domain-name <auth-default-domain-name> | パスワード: v3 api および v2 パラメーターと使用するオプションのドメイン名。これは v3 のユーザーとプロジェクトドメインの両方に使用され、v2 認証では無視されます。トークン:v3 API および v2 パラメーターで使用するオプションのドメイン名。これは v3 のユーザーとプロジェクトドメインの両方に使用され、v2 認証では無視されます。(Env: OS_DEFAULT_DOMAIN_NAME) |
--os-aodh-endpoint <auth-aodh-endpoint> | aodh-noauth: aodh エンドポイント (env: OS_AODH_ENDPOINT) |
--os-roles <auth-roles> | aodh-noauth: ロール。with gnocchi-noauth: ロール (Env: OS_ROLES) |
--os-application-credential-name <auth-application-credential-name> | V3applicationcredential: アプリケーション認証情報名 (Env: OS_APPLICATION_CREDENTIAL_NAME) |
--os-dns-api-version <dns-api-version> | DNS api バージョン、デフォルト=2(env: os_dns_api_version) |
--os-key-manager-api-version <key-manager-api-version> | Barbican api バージョン、デフォルト=1(env: OS_KEY_MANAGER_API_VERSION) |
--os-data-processing-api-version <data-processing-api-version> | データ処理の api バージョン、デフォルト=1.1(env: OS_DATA_MYBACKUPDIRING_API_VERSION) |
--os-service-provider-entity-id <auth-service-provider-entity-id> | v3adfspassword: サービスプロバイダーの SAML エンティティー id(Env: OS_SERVICE_MYBACKUPDIR_MYBACKUPDIR_ID) |
--os-access-secret <auth-access-secret> | V3oauth1: oauth アクセスシークレット (env: OS_ACCESS_SECRET) |
--os-beta-command | 変更の可能性のあるベータコマンドを有効にします。 |
--os-orchestration-api-version <orchestration-api-version> | オーケストレーション api バージョン、デフォルト=1(env: OS_ORCHESTRATION_API_VERSION) |
--os-service-provider-endpoint <auth-service-provider-endpoint> | V3adfspassword: サービスプロバイダーのエンドポイント (env: OS_SERVICE_PROVIDER_ENDPOINT) の使用 |
--timing | API 呼び出しのタイミング情報を出力します。 |
--os-tripleoclient-api-version <tripleoclient-api-version> | TripleO クライアント api バージョン、デフォルト=1(env: OS_TRIPLEOCLIENT_API_VERSION) |
--os-loadbalancer-api-version <loadbalancer-api-version> | Osc プラグイン api バージョン、デフォルト=2.0(env: OS_LOADBALANCER_API_VERSION) |
--os-protocol <auth-protocol> | v3adfspassword: フェデレーションプラグイン向けのプロトコル。v3oidcclientcredentials: フェデレーションプラグイン向けのプロトコル。v3samlpassword: フェデレーションプラグイン向けのプロトコル。v3oidcaccesstoken: フェデレーションプラグイン向けのプロトコル。v3oidcpassword: フェデレーションプラグイン向けのプロトコル。v3oidcauthcode: フェデレーションプラグイン向けのプロトコル。(Env: OS_PROTOCOL) |
--os-auth-url <auth-auth-url> | password: 認証 URL。v3adfspassword: 認証 URL。v3oidcclientcredentials: 認証 URL。v3samlpassword: 認証 URL。v2password: 認証 URL。v3password: 認証 URL。v3oidcaccesstoken: 認証 URL。v2token: 認証 URL。v3oidcpassword: 認証 URL。token: 認証 URL。v3tokenlessauth: 認証 URL。v3totp: 認証 URL。v3applicationcredential: 認証 URL。v1password: 認証 URL。v3oauth1: 認証 URL。v3oidcauthcode: 認証 URL。v3token: 認証 URL。v3multifactor: 認証 URL。(Env: OS_AUTH_URL) |
--os-user <auth-user> | gnocchi-basic: ユーザー (env: os_user) |
--os-client-secret <auth-client-secret> | v3oidcauthcode: oauth 2.0 クライアントシークレット。 v3oidcclientcredentials: OAuth 2.0 クライアントシークレット。v3oidcpassword: OAuth 2.0 クライアントシークレット。(Env: OS_CLIENT_SECRET) |
--os-project-domain-id <auth-project-domain-id> | password: プロジェクトが含まれるドメイン ID。v3adfspassword: プロジェクトが含まれるドメイン ID。v3oidcclientcredentials: プロジェクトが含まれるドメイン ID。v3samlpassword: プロジェクトが含まれるドメイン ID。v3password: プロジェクトが含まれるドメイン ID。v3oidcaccesstoken: プロジェクトが含まれるドメイン ID。v3oidcpassword: プロジェクトが含まれるドメイン ID。token: プロジェクトが含まれるドメイン ID。v3tokenlessauth: プロジェクトが含まれるドメイン ID。v3totp: プロジェクトが含まれるドメイン ID。v3applicationcredential: プロジェクトが含まれるドメイン ID。v3oidcauthcode: プロジェクトが含まれるドメイン ID。v3token: プロジェクトが含まれるドメイン ID。v3multifactor: プロジェクトが含まれるドメイン ID。(Env: OS_PROJECT_DOMAIN_ID) |
--insecure | サーバー証明書の検証を無効にします。 |
--os-network-api-version <network-api-version> | ネットワーク api バージョン、デフォルト=2.0(env: OS_NETWORK_API_VERSION) |
--os-password <auth-password> | v3password: ユーザーのパスワード。password: ユーザーのパスワード。v1password: ユーザーのパスワード。v3MYBACKUPDIRpassword: パスワード。v2password: 使用するパスワード。v3oidcpassword: パスワード。 v3adfspassword: パスワード。(Env: OS_PASSWORD) |
--os-cert <certificate-file> | クライアント証明書バンドルファイル (env: os_cert) |
--os-code <auth-code> | v3oidcauthcode: oauth 2.0 承認コード (Env: OS_CODE) |
--os-consumer-secret <auth-consumer-secret> | V3oauth1: oauth コンシューマーシークレット (env: OS_CONSUMER_SECRET) |
--os-compute-api-version <compute-api-version> | Compute api バージョン、デフォルト=2.1(env: OS_COMPUTE_API_VERSION) |
--os-default-domain-id <auth-default-domain-id> | パスワード: v3 および v2 パラメーターで使用するオプションのドメイン ID。これは v3 のユーザーとプロジェクトドメインの両方に使用され、v2 認証では無視されます。トークン:v3 および v2 パラメーターで使用するオプションのドメイン ID。これは v3 のユーザーとプロジェクトドメインの両方に使用され、v2 認証では無視されます。(Env: OS_DEFAULT_DOMAIN_ID) |
--os-access-token <auth-access-token> | v3oidcaccesstoken: oauth 2.0 アクセストークン (env: OS_ACCESS_TOKEN) |
--os-region-name <auth-region-name> | 認証リージョン名 (env: os_region_name) |
--os-queues-api-version <queues-api-version> | キュー API バージョン、デフォルト=2(env: OS_QUEUES_API_VERSION) |
--os-identity-provider-url <auth-identity-provider-url> | v3adfspassword: SAML 認証要求の送信先となる認証プロバイダーの URL。v3samlpassword: SAML2 認証要求の送信先となる認証プロバイダーの URL。(Env: OS_IDMYBACKUPDIR_INTERFACE_URL) |
--os-application-credential-secret <auth-application-credential-secret> | V3applicationcredential: アプリケーション認証情報の認証シークレット (Env: OS_APPLICATION_CREDENTIAL_SECRET) |
--os-passcode <auth-passcode> | v3totp: ユーザーの totp パスコード (env: os_passcode) |
--os-profile hmac-key | プロファイリングコンテキストデータを暗号化するための HMAC キー |
--os-domain-id <auth-domain-id> | password: 範囲内のドメイン ID。v3adfspassword: 範囲内のドメイン ID。v3oidcclientcredentials: 範囲内のドメイン ID。v3samlpassword: 範囲内のドメイン ID。v3password: 範囲内のドメイン ID。v3oidcaccesstoken: 範囲内のドメイン ID。v3oidcpassword: 範囲内のドメイン ID。token: 範囲内のドメイン ID。v3tokenlessauth: 範囲内のドメイン ID。v3totp: 範囲内のドメイン ID。v3applicationcredential: 範囲内のドメイン ID。v3oidcauthcode: 範囲内のドメイン ID。v3token: 範囲内のドメイン ID。v3multifactor: 範囲内のドメイン ID。(Env: OS_DOMAIN_ID) |
--os-discovery-endpoint <auth-discovery-endpoint> | V3oidcauthcode: openid connect 検出 ドキュメント URL。検出ドキュメントを使用して、アクセストークンエンドポイントおよび認証エンドポイントの値を取得します。この URL は、https://idp.example.org/.well-known/openid-configuration のようになります。v3oidcclientcredentials: OpenID Connect 検出ドキュメントの URL。検出ドキュメントを使用して、アクセストークンエンドポイントおよび認証エンドポイントの値を取得します。この URL は https://idp.example.org/.well-known/openid- 設定のようになるはずです。v3oidcpassword: OpenID Connect 検出ドキュメント URL。検出ドキュメントを使用して、アクセストークンエンドポイントおよび認証エンドポイントの値を取得します。この URL はhttps://idp.example.org/.well- known/openid-設定のようになります (Env: |
OS_DISCOVERY_ENDPOINT)--os-access-token-type <auth-access-token-type> | V3oidcauthcode: oauth 2.0 承認サーバー Introspection トークンタイプ。これはトークンイントロスペクションの処理時に使用するトークンの種類を決定するために使用されます。有効な値は、access_token または id_token です。v3oidcclientcredentials: OAuth 2.0 認証サーバーイントロスペクションのトークンタイプで、トークンイントロスペクションの処理時に使用するトークンのタイプを決定するために使用されます。有効な値は、access_token または id_token です。v3oidcpassword: OAuth 2.0 認証サーバーイントロスペクションのトークンタイプで、トークンイントロスペクションの処理時に使用するトークンのタイプを決定するために使用されます。有効な値は、access_token または id_token です (Env: OS_ACCESS_TOKEN_TYPE)。 |
-v、--verbose | 出力の詳細レベルが上がります。繰り返し指定できます。 |
--os-workflow-api-version <workflow-api-version> | ワークフロー api バージョン、デフォルト=2(env: OS_WORKFLOW_API_VERSION) |
--os-application-credential-id <auth-application-credential-id> | V3applicationcredential: アプリケーション認証情報 ID(Env: OS_APPLICATION_CREDENTIAL_ID) |
--os-data-processing-url OS_DATA_PROCESSING_URL | データ処理の api url (env: OS_DATA_MYBACKUPDIRING_API_URL) |
--os-service-provider <service_provider> | Keystone-to-keystone フェデレーションを使用して、サービスプロバイダーで認証を行い、コマンドを実行します。リモートプロジェクトオプションも指定する必要があります。 |
--os-image-api-version <image-api-version> | イメージ api バージョン、デフォルト=2(env: OS_IMAGE_API_VERSION) |
--os-user-domain-name <auth-user-domain-name> | v3password: ユーザーのドメイン名。v3totp: ユーザーのドメイン名。password: ユーザーのドメイン名。v3applicationcredential: ユーザーのドメイン名。(Env: OS_USER_DOMAIN_NAME) |
--os-remote-project-id <remote_project_id> | Keystone-to-Keystone フェデレーションを使用する場合の、サービスプロバイダーに対して認証する際のプロジェクト ID。 |
--os-key <key-file> | クライアント証明書キーファイル (env: os_key) |
--os-identity-provider <auth-identity-provider> | v3adfspassword: 認証プロバイダーの名前。v3oidcclientcredentials: 認証プロバイダーの名前。v3samlpassword: 認証プロバイダーの名前。v3oidcaccesstoken: 認証プロバイダーの名前。v3oidcpassword: 認証プロバイダーの名前。v3oidcauthcode: 認証プロバイダーの名前。(Env: OS_IDENTITY_PROVIDER) |
--os-user-domain-id <auth-user-domain-id> | v3password: ユーザーのドメイン ID。v3totp: ユーザーのドメイン ID。password: ユーザーのドメイン ID。v3applicationcredential: ユーザーのドメイン ID。(Env: OS_USER_DOMAIN_ID) |
--os-default-domain <auth-domain> | デフォルトのドメイン ID、デフォルト=default (env: OS_DEFAULT_DOMAIN)。 |
--os-volume-api-version <volume-api-version> | ボリューム api バージョン、デフォルト=3 (env: |
OS_VOLUME_API_VERSION)--log-file LOG_FILE | 出力をログに記録するファイルを指定します。デフォルトでは無効です。 |
--os-access-key <auth-access-key> | v3oauth1: oauth アクセスキー (env: os_access_key) |
--debug | エラーのトレースバックを表示します。 |
--os-access-token-endpoint <auth-access-token-endpoint> | V3oidcauthcode: openid connect プロバイダーの トークンエンドポイント。検出ドキュメントが渡された場合には、このオプションの指定内容が、検出ドキュメントでサーバーが提供するエンドポイントよりも優先される点に注意してください。V3oidcclientcredentials: OpenID Connect プロバイダートークンエンドポイント。検出ドキュメントが渡された場合には、このオプションの指定内容が、検出ドキュメントでサーバーが提供するエンドポイントよりも優先される点に注意してください。V3oidcpassword: OpenID Connect プロバイダートークンエンドポイント。検出ドキュメントが渡された場合には、このオプションの指定内容が、検出ドキュメントでサーバーが提供するエンドポイントよりも優先される点に注意してください。(Env: OS_ACCESS_TOKEN_ENDPOINT) |
--os-domain-name <auth-domain-name> | password: 範囲内のドメイン名。v3adfspassword: 範囲内のドメイン名。v3oidcclientcredentials: 範囲内のドメイン名。v3samlpassword: 範囲内のドメイン名。v3password: 範囲内のドメイン名。v3oidcaccesstoken: 範囲内のドメイン名。v3oidcpassword: 範囲内のドメイン名。token: 範囲内のドメイン名。v3tokenlessauth: 範囲内のドメイン名。v3totp: 範囲内のドメイン名。v3applicationcredential: 範囲内のドメイン名。v3oidcauthcode: 範囲内のドメイン名。v3token: 範囲内のドメイン名。v3multifactor: 範囲内のドメイン名。(Env: OS_DOMAIN_NAME) |
--os-project-id <auth-project-id> | password: 範囲内のプロジェクト ID。v3adfspassword: 範囲内のプロジェクト ID。v3oidcclientcredentials: 範囲内のプロジェクト ID。v3samlpassword: 範囲内のプロジェクト ID。v3password: 範囲内のプロジェクト ID。v3oidcaccesstoken: 範囲内のプロジェクト ID。noauth: プロジェクト ID。v3oidcpassword: 範囲内のプロジェクト ID。token: 範囲内のプロジェクト ID。v3tokenlessauth: 範囲内のプロジェクト ID。v3totp: 範囲内のプロジェクト ID。v3applicationcredential: 範囲内のプロジェクト ID。aodh-noauth: プロジェクト ID。v3oidcauthcode: 範囲内のプロジェクト ID。gnocchi-noauth: プロジェクト ID。v3token: 範囲内のプロジェクト ID。v3multifactor: 範囲内のプロジェクト ID。(Env: OS_PROJECT_ID) |
-q, --quiet | 警告およびエラー以外の出力を減らします。 |
--version | プログラムのバージョン番号を表示して終了します。 |
--os-metrics-api-version <metrics-api-version> | メトリクス api バージョン、デフォルト=1(env: OS_METRICS_API_VERSION) |
--os-interface <interface> | インターフェイスタイプを選択します。有効なインターフェイスタイプ:[admin, public, internal](Env: OS_INTERFACE) |
--os-client-id <auth-client-id> | v3oidcauthcode: oauth 2.0 クライアント ID。 v3oidcclientcredentials: OAuth 2.0 クライアント ID。v3oidcpassword: OAuth 2.0 クライアント ID。(Env: OS_CLIENT_ID) |
--os-token <auth-token> | v2token: トークン。admin_token: 常に使用されるトークン。v3token: 認証に使用するトークン。token_endpoint: 使用する認証トークン。token: 認証に使用するトークン。(Env: OS_TOKEN) |
--os-object-api-version <object-api-version> | オブジェクト api バージョン、デフォルト=1(env: OS_MYBACKUPDIR_API_VERSION) |
--os-database-api-version <database-api-version> | データベース api バージョン、デフォルト=1(env: OS_DATABASE_API_VERSION) |
--os-consumer-key <auth-consumer-key> | With v3oauth1: oauth コンシューマー id/キー (env: OS_CONSUMER_KEY) |
--os-url <auth-url> | token_endpoint: 使用する特定のサービスエンドポイント(Env: OS_URL) |
--os-openid-scope <auth-openid-scope> | v3oidcauthcode: 認可サーバーからリクエストされた openid 接続スコープ。OpenID Connect 仕様には、openid を常に指定する必要があります。v3oidcclientcredentials: OpenID Connect 範囲が認可サーバーから要求されます。OpenID Connect 仕様には、openid を常に指定する必要があります。v3oidcpassword: 認可サーバーから要求される OpenID Connect 範囲。OpenID Connect 仕様には、openid を常に指定する必要があります。(Env: OS_OPENID_SCOPE) |
--os-username <auth-username> | v3password: ユーザー名。v3totp: ユーザー名。password: ユーザー名。 v3applicationcredential: ユーザー名。 v1password: ログインするユーザー名。v3MYBACKUPDIRpassword: ユーザー名。 v2password: ログインするユーザー名 v3oidcpassword: ユーザー名。 v3adfspassword: ユーザー名 (Env: OS_USERNAME) |
第2章 acl
本章では、acl
コマンドに含まれるコマンドについて説明します。
2.1. acl delete
Href で特定されたシークレットまたはコンテナーの ACL を削除します。
使用方法
openstack acl delete [-h] URI
表2.1 位置引数
値 | 概要 |
---|---|
URI | シークレットまたはコンテナーの URI 参照。 |
表2.2 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
2.2. acl get
Href を指定して、シークレットまたはコンテナーの ACL を取得します。
使用方法
openstack acl get [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] URI
表2.3 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表2.4 位置引数
値 | 概要 |
---|---|
URI | シークレットまたはコンテナーの URI 参照。 |
表2.5 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表2.6 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表2.7 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表2.8 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
2.3. acl submit
Href で特定されたシークレットまたはコンテナーに ACL を送信します。
使用方法
openstack acl submit [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--user [USERS]] [--project-access | --no-project-access] [--operation-type {read}] URI
表2.9 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表2.10 位置引数
値 | 概要 |
---|---|
URI | シークレットまたはコンテナーの URI 参照。 |
表2.11 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表2.12 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表2.13 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表2.14 その他の引数 (オプション):
値 | 概要 |
---|---|
--project-access | プロジェクトアクセスの動作を有効にするフラグ。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--user [USERS], -u [USERS] | ACL の keystone ユーザー ID。 |
--operation-type {read}, -o {read} | 設定される Barbican 操作の acl のタイプ。 |
--no-project-access | プロジェクトアクセスの動作を無効にするフラグ。 |
2.4. acl user add
Href で特定されたシークレットまたはコンテナーに ACL ユーザーを追加します。
使用方法
openstack acl user add [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--user [USERS]] [--project-access | --no-project-access] [--operation-type {read}] URI
表2.15 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表2.16 位置引数
値 | 概要 |
---|---|
URI | シークレットまたはコンテナーの URI 参照。 |
表2.17 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表2.18 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表2.19 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表2.20 その他の引数 (オプション):
値 | 概要 |
---|---|
--project-access | プロジェクトアクセスの動作を有効にするフラグ。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--user [USERS], -u [USERS] | ACL の keystone ユーザー ID。 |
--operation-type {read}, -o {read} | 設定される Barbican 操作の acl のタイプ。 |
--no-project-access | プロジェクトアクセスの動作を無効にするフラグ。 |
2.5. acl user remove
Href で特定されたシークレットまたはコンテナーから ACL ユーザーを削除します。
使用方法
openstack acl user remove [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--user [USERS]] [--project-access | --no-project-access] [--operation-type {read}] URI
表2.21 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表2.22 位置引数
値 | 概要 |
---|---|
URI | シークレットまたはコンテナーの URI 参照。 |
表2.23 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表2.24 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表2.25 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表2.26 その他の引数 (オプション):
値 | 概要 |
---|---|
--project-access | プロジェクトアクセスの動作を有効にするフラグ。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--user [USERS], -u [USERS] | ACL の keystone ユーザー ID。 |
--operation-type {read}, -o {read} | 設定される Barbican 操作の acl のタイプ。 |
--no-project-access | プロジェクトアクセスの動作を無効にするフラグ。 |
第3章 action
本章では、action
コマンドに含まれるコマンドについて説明します。
3.1. action definition create
新しいアクションを作成します。
使用方法
openstack action definition create [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--public] definition
表3.1 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表3.2 位置引数
値 | 概要 |
---|---|
定義 | アクション定義ファイル |
表3.3 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表3.4 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表3.5 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表3.6 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--public | このフラグを使用した場合には、アクションにはパブリックのマークが付けられます。 |
3.2. action definition definition show
アクション定義を表示します。
使用方法
openstack action definition definition show [-h] name
表3.7 位置引数
値 | 概要 |
---|---|
name | アクション名 |
表3.8 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
3.3. action definition delete
アクションを削除します。
使用方法
openstack action definition delete [-h] action [action ...]
表3.9 位置引数
値 | 概要 |
---|---|
action | アクションの名前または ID。 |
表3.10 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
3.4. action definition list
すべてのアクションを一覧表示します。
使用方法
openstack action definition list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--filter FILTERS]
表3.11 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表3.12 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表3.13 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表3.14 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表3.15 その他の引数 (オプション):
値 | 概要 |
---|---|
--filter FILTERS | フィルター。繰り返し使用できます。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
3.5. action definition show
特定のアクションを表示します。
使用方法
openstack action definition show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] action
表3.16 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表3.17 位置引数
値 | 概要 |
---|---|
action | アクション (名前または ID) |
表3.18 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表3.19 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表3.20 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
表3.21 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
3.6. action definition update
アクションを更新します。
使用方法
openstack action definition update [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--id ID] [--public] definition
表3.22 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表3.23 位置引数
値 | 概要 |
---|---|
定義 | アクション定義ファイル |
表3.24 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表3.25 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表3.26 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表3.27 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--id ID | アクション ID。 |
--public | このフラグを使用した場合には、アクションにはパブリックのマークが付けられます。 |
3.7. action execution delete
アクション実行を削除します。
使用方法
openstack action execution delete [-h] action_execution [action_execution ...]
表3.28 位置引数
値 | 概要 |
---|---|
action_execution | アクション実行識別子の ID。 |
表3.29 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
3.8. action execution input show
Action 実行入力データを表示します。
使用方法
openstack action execution input show [-h] id
表3.30 位置引数
値 | 概要 |
---|---|
id | アクション実行 ID。 |
表3.31 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
3.9. action execution list
すべてのアクション実行を一覧表示します。
使用方法
openstack action execution list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--limit [LIMIT]] [task_execution_id]
表3.32 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表3.33 位置引数
値 | 概要 |
---|---|
task_execution_id | タスクの実行 ID。 |
表3.34 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表3.35 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表3.36 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表3.37 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--limit [LIMIT] | 単一の結果で返すアクション実行の最大数。制限はデフォルトで 100 に設定されます。--limit -1 を使用して完全な結果セットを取得します。 |
3.10. action execution output show
アクション実行の出力データを表示します。
使用方法
openstack action execution output show [-h] id
表3.38 位置引数
値 | 概要 |
---|---|
id | アクション実行 ID。 |
表3.39 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
3.11. action execution run
新しいアクションの実行を作成するか、または特定のアクションを実行します。
使用方法
openstack action execution run [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-s] [--run-sync] [-t TARGET] name [input]
表3.40 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表3.41 位置引数
値 | 概要 |
---|---|
input | アクション入力。 |
name | 実行するアクション名。 |
表3.42 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表3.43 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表3.44 その他の引数 (オプション):
値 | 概要 |
---|---|
-s, --save-result | 結果を db に保存します。 |
-t TARGET, --target TARGET | アクションは <target> エグゼキューターで実行されます。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--run-sync | アクションを同期的に実行します。 |
表3.45 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
3.12. action execution show
特定のアクション実行を表示します。
使用方法
openstack action execution show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] action_execution
表3.46 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表3.47 位置引数
値 | 概要 |
---|---|
action_execution | アクション実行 ID。 |
表3.48 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表3.49 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表3.50 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
表3.51 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
3.13. action execution update
特定のアクション実行を更新します。
使用方法
openstack action execution update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--state {IDLE,RUNNING,SUCCESS,ERROR,CANCELLED}] [--output OUTPUT] id
表3.52 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表3.53 位置引数
値 | 概要 |
---|---|
id | アクション実行 ID。 |
表3.54 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表3.55 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表3.56 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--output OUTPUT | アクション実行の出力 |
--state {IDLE,RUNNING,SUCCESS,ERROR,CANCELLED} | アクション実行の状態 |
表3.57 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
第4章 address
本章では、address
コマンドに含まれるコマンドについて説明します。
4.1. address scope create
新しいアドレススコープを作成します。
使用方法
openstack address scope create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--ip-version {4,6}] [--project <project>] [--project-domain <project-domain>] [--share | --no-share] <name>
表4.1 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表4.2 位置引数
値 | 概要 |
---|---|
<name> | 新しいアドレススコープ名 |
表4.3 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表4.4 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表4.5 その他の引数 (オプション):
値 | 概要 |
---|---|
--share | プロジェクト間でアドレススコープを共有します。 |
--ip-version {4,6} | IP バージョン (デフォルトは 4) |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
--no-share | プロジェクト間でアドレススコープを共有しません (デフォルト) |
-h, --help | ヘルプメッセージを表示して終了します。 |
--project <project> | 所有者のプロジェクト (名前または ID) |
表4.6 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
4.2. address scope delete
アドレススコープを削除します。
使用方法
openstack address scope delete [-h] <address-scope> [<address-scope> ...]
表4.7 位置引数
値 | 概要 |
---|---|
<address-scope> | 削除するアドレススコープ (名前または ID) |
表4.8 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
4.3. address scope list
アドレススコープを一覧表示します。
使用方法
openstack address scope list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--name <name>] [--ip-version <ip-version>] [--project <project>] [--project-domain <project-domain>] [--share | --no-share]
表4.9 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表4.10 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表4.11 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表4.12 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表4.13 その他の引数 (オプション):
値 | 概要 |
---|---|
--share | プロジェクト間で共有されているアドレススコープを一覧表示します。 |
--ip-version <ip-version> | 指定した IP バージョンネットワークのアドレススコープを一覧表示します (4 または 6)。 |
--name <name> | 出力に、指定された名前のアドレススコープのみを一覧表示します。 |
--project <project> | プロジェクト (名前または ID) に合わせてアドレススコープを一覧表示します。 |
--no-share | プロジェクト間で共有されていないアドレススコープを一覧表示します。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--project-domain <project-domain> | プロジェクトが所属するドメイン (名前または ID)。プロジェクト名の競合が発生してしまった場合に、使用できます。 |
4.4. address scope set
アドレススコープのプロパティーを設定します。
使用方法
openstack address scope set [-h] [--name <name>] [--share | --no-share] <address-scope>
表4.14 位置引数
値 | 概要 |
---|---|
<address-scope> | 変更するアドレススコープ (名前または ID) |
表4.15 その他の引数 (オプション):
値 | 概要 |
---|---|
--share | プロジェクト間でアドレススコープを共有します。 |
--name <name> | アドレススコープ名を設定します。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--no-share | プロジェクト間でアドレススコープを共有しません。 |
4.5. address scope show
アドレススコープの詳細を表示します。
使用方法
openstack address scope show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] <address-scope>
表4.16 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表4.17 位置引数
値 | 概要 |
---|---|
<address-scope> | 表示するアドレススコープ (名前または ID) |
表4.18 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表4.19 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表4.20 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
表4.21 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
第5章 aggregate
本章では、aggregate
コマンドに含まれるコマンドについて説明します。
5.1. aggregate add host
ホストアグリゲートにホストを追加します。
使用方法
openstack aggregate add host [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] <aggregate> <host>
表5.1 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表5.2 位置引数
値 | 概要 |
---|---|
<aggregate> | アグリゲート (名前または ID) |
<host> | <aggregate> に追加するホスト |
表5.3 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表5.4 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表5.5 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
表5.6 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
5.2. aggregate create
新規アグリゲートを作成します。
使用方法
openstack aggregate create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--zone <availability-zone>] [--property <key=value>] <name>
表5.7 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表5.8 位置引数
値 | 概要 |
---|---|
<name> | 新しいアグリゲート名 |
表5.9 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表5.10 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表5.11 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--zone <availability-zone> | アベイラビリティーゾーン名 |
--property <key=value> | このアグリゲートに追加するプロパティー (複数のプロパティーを設定する場合は repeat オプション) |
表5.12 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
5.3. aggregate delete
既存のアグリゲートを削除します。
使用方法
openstack aggregate delete [-h] <aggregate> [<aggregate> ...]
表5.13 位置引数
値 | 概要 |
---|---|
<aggregate> | 削除するアグリゲート (名前または ID) |
表5.14 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
5.4. aggregate list
すべてのアグリゲートを一覧表示します。
使用方法
openstack aggregate list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--long]
表5.15 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表5.16 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表5.17 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表5.18 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表5.19 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--long | 出力の追加フィールドを一覧表示します。 |
5.5. aggregate remove host
アグリゲートからホストを削除します。
使用方法
openstack aggregate remove host [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] <aggregate> <host>
表5.20 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表5.21 位置引数
値 | 概要 |
---|---|
<aggregate> | アグリゲート (名前または ID) |
<host> | <aggregate> から削除するホスト |
表5.22 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表5.23 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表5.24 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
表5.25 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
5.6. aggregate set
アグリゲートプロパティーを設定します。
使用方法
openstack aggregate set [-h] [--name <name>] [--zone <availability-zone>] [--property <key=value>] [--no-property] <aggregate>
表5.26 位置引数
値 | 概要 |
---|---|
<aggregate> | 変更するアグリゲート (名前または ID) |
表5.27 その他の引数 (オプション):
値 | 概要 |
---|---|
--name <name> | アグリゲート名を設定します。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--zone <availability-zone> | アベイラビリティーゾーン名を設定します。 |
--no-property | <aggregate> からすべてのプロパティーを削除します (--property と --no-property の両方を指定して現在のプロパティーを上書きします)。 |
--property <key=value> | <aggregate> に設定するプロパティー (複数のプロパティーを設定する場合はオプションを繰り返し使用します) |
5.7. aggregate show
アグリゲートの詳細を表示します。
使用方法
openstack aggregate show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] <aggregate>
表5.28 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表5.29 位置引数
値 | 概要 |
---|---|
<aggregate> | 表示へのアグリゲート (名前または ID) |
表5.30 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表5.31 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表5.32 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
表5.33 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
5.8. aggregate unset
アグリゲートプロパティーの設定を解除します。
使用方法
openstack aggregate unset [-h] [--property <key>] <aggregate>
表5.34 位置引数
値 | 概要 |
---|---|
<aggregate> | 変更するアグリゲート (名前または ID) |
表5.35 その他の引数 (オプション):
値 | 概要 |
---|---|
--property <key> | アグリゲートから削除するプロパティー (複数のプロパティーを設定する場合はオプションを繰り返し使用します) |
-h, --help | ヘルプメッセージを表示して終了します。 |
第6章 alarm
本章では、alarm
コマンドに含まれるコマンドについて説明します。
6.1. alarm create
アラームの作成
使用方法
openstack alarm create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] --name <NAME> -t <TYPE> [--project-id <PROJECT_ID>] [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--query <QUERY>] [--comparison-operator <OPERATOR>] [--evaluation-periods <EVAL_PERIODS>] [--threshold <THRESHOLD>] [--metric <METRIC>] [--event-type <EVENT_TYPE>] [--granularity <GRANULARITY>] [--aggregation-method <AGGR_METHOD>] [--resource-type <RESOURCE_TYPE>] [--resource-id <RESOURCE_ID>] [--metrics <METRICS>] [--composite-rule <COMPOSITE_RULE>]
表6.1 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表6.2 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表6.3 common gnocchi alarm rules
値 | 概要 |
---|---|
--aggregation-method <AGGR_METHOD> | しきい値と比較する aggregation_method |
--granularity <GRANULARITY> | クエリーを行う時間範囲 (秒単位)。 |
表6.4 event alarm
値 | 概要 |
---|---|
--event-type <EVENT_TYPE> | 評価対象のイベントタイプ |
表6.5 gnocchi resource threshold alarm
値 | 概要 |
---|---|
--resource-id <RESOURCE_ID> | リソースの ID。 |
--resource-type <RESOURCE_TYPE> | リソースのタイプ。 |
表6.6 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表6.7 composite alarm
値 | 概要 |
---|---|
--composite-rule <COMPOSITE_RULE> | Json 形式の複合しきい値ルール。形式として、"and"や"or" で gnocchi ルールを組み合わせた、ネスト化ディクショナリーを指定できます。形式例: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}。 |
表6.8 その他の引数 (オプション):
値 | 概要 |
---|---|
--ok-action <Webhook URL> | 状態が ok に切り替わったときに呼び出す URL。複数回使用できます。 |
--user-id <USER_ID> | アラームに関連付けるユーザー (管理ユーザーだけが設定可能) |
--name <NAME> | アラームの名前 |
-t <TYPE>, --type <TYPE> | アラームのタイプ:event、composite、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold のいずれかです。 |
--repeat-actions {True | False} |
アラームがターゲット状態にある時にアクションを繰り返し通知する場合は True | --state <STATE> |
アラームの状態。以下のいずれか:[ok, alarm, insufficient data] | --time-constraint <Time Constraint> |
評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]] です。 | --project-id <PROJECT_ID> |
アラームに関連付けるプロジェクト (管理ユーザーだけが設定可能) | --insufficient-data-action <Webhook URL> |
状態が insufficient data に切り替わったときに呼び出す URL。複数回の使用が可能です。 | --severity <SEVERITY> |
アラームの重大度。以下のいずれか [low, moderate,critical] | --alarm-action <Webhook URL> |
状態が alarm に切り替わったときに呼び出す URL。複数回使用できます。 | -h, --help |
ヘルプメッセージを表示して終了します。 | --description <DESCRIPTION> |
アラームのフリーテキストの説明 | --enabled {True |
False} | アラーム評価が有効な場合は true。 |
表6.9 common alarm rules
値 | 概要 |
---|---|
--evaluation-periods <EVAL_PERIODS> | 評価する期間の数 |
--query <QUERY> | アラームのイベントタイプ: key[op]data_type::value; list。data_type はオプションですが、指定する場合には、文字列、整数、浮動またはブール型にする必要があります。gnocchi_aggregation_by_resources_threshold タイプのアラーム: {"and": [{"=": {"ended_at": null}}, …]} のように、複雑なクエリー json 文字列を指定する必要があります。 |
--comparison-operator <OPERATOR> | 比較するオペレーター:[lt,le,eq,ne,ge,gt] のいずれか。 |
--metric <METRIC> | 評価対象のメトリック。 |
--threshold <THRESHOLD> | 評価するしきい値。 |
表6.10 メトリクスアラームによる Gnocchi の集計
値 | 概要 |
---|---|
--metrics <METRICS> | メトリクス ID の一覧。 |
表6.11 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
6.2. alarm delete
アラームを削除します。
使用方法
openstack alarm delete [-h] [--name <NAME>] [<ALARM ID or NAME>]
表6.12 位置引数
値 | 概要 |
---|---|
<ALARM ID または NAME> | アラームの ID または名前。 |
表6.13 その他の引数 (オプション):
値 | 概要 |
---|---|
--name <NAME> | アラームの名前 |
-h, --help | ヘルプメッセージを表示して終了します。 |
6.3. alarm-history search
クエリーに基づいてすべてのアラームの履歴を表示します。
使用方法
openstack alarm-history search [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--query QUERY]
表6.14 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表6.15 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表6.16 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表6.17 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表6.18 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--query QUERY | aodh がサポートする立地クエリー。例: project_id!=my-id user_id=foo or user_id=bar |
6.4. alarm-history show
アラームの履歴を表示します。
使用方法
openstack alarm-history show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT_KEY:SORT_DIR>] alarm_id
表6.19 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表6.20 位置引数
値 | 概要 |
---|---|
<alarm-id> | アラームの ID |
表6.21 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表6.22 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表6.23 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表6.24 その他の引数 (オプション):
値 | 概要 |
---|---|
--sort <SORT_KEY:SORT_DIR> | リソース属性をソートします (例:timestamp:desc)。 |
--limit <LIMIT> | 返すリソースの数 (デフォルトはサーバーのデフォルトです)。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--marker <MARKER> | 前の一覧の最後のアイテム。この値の後に来る結果を返します。サポート対象のマーカーは event_id です。 |
6.5. alarm list
アラームを一覧表示します。
使用方法
openstack alarm list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--query QUERY | --filter <KEY1=VALUE1;KEY2=VALUE2...>] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT_KEY:SORT_DIR>]
表6.25 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表6.26 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表6.27 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表6.28 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表6.29 その他の引数 (オプション):
値 | 概要 |
---|---|
--sort <SORT_KEY:SORT_DIR> | リソース属性をソートします (例:name:asc)。 |
--filter <KEY1=VALUE1;KEY2=VALUE2…> | 返されたアラームに適用するパラメーターをフィルターします。 |
--query QUERY | aodh がサポートする立地クエリー。例: project_id!=my-id user_id=foo or user_id=bar |
--marker <MARKER> | 前の一覧の最後のアイテム。この値の後に来る結果を返します。サポート対象のマーカーは alarm_id です。 |
--limit <LIMIT> | 返すリソースの数 (デフォルトはサーバーのデフォルトです)。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
6.6. alarm show
アラームを表示します。
使用方法
openstack alarm show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--name <NAME>] [<ALARM ID or NAME>]
表6.30 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表6.31 位置引数
値 | 概要 |
---|---|
<ALARM ID または NAME> | アラームの ID または名前。 |
表6.32 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表6.33 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表6.34 その他の引数 (オプション):
値 | 概要 |
---|---|
--name <NAME> | アラームの名前 |
-h, --help | ヘルプメッセージを表示して終了します。 |
表6.35 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
6.7. alarm state get
アラームの状態を取得します。
使用方法
openstack alarm state get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--name <NAME>] [<ALARM ID or NAME>]
表6.36 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表6.37 位置引数
値 | 概要 |
---|---|
<ALARM ID または NAME> | アラームの ID または名前。 |
表6.38 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表6.39 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表6.40 その他の引数 (オプション):
値 | 概要 |
---|---|
--name <NAME> | アラームの名前 |
-h, --help | ヘルプメッセージを表示して終了します。 |
表6.41 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
6.8. alarm state set
アラームの状態を設定します。
使用方法
openstack alarm state set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--name <NAME>] --state <STATE> [<ALARM ID or NAME>]
表6.42 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表6.43 位置引数
値 | 概要 |
---|---|
<ALARM ID または NAME> | アラームの ID または名前。 |
表6.44 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表6.45 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表6.46 その他の引数 (オプション):
値 | 概要 |
---|---|
--name <NAME> | アラームの名前 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--state <STATE> | アラームの状態。以下のいずれか:[ok, alarm, insufficient data] |
表6.47 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
6.9. alarm update
アラームを更新します。
使用方法
openstack alarm update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--name <NAME>] [-t <TYPE>] [--project-id <PROJECT_ID>] [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--query <QUERY>] [--comparison-operator <OPERATOR>] [--evaluation-periods <EVAL_PERIODS>] [--threshold <THRESHOLD>] [--metric <METRIC>] [--event-type <EVENT_TYPE>] [--granularity <GRANULARITY>] [--aggregation-method <AGGR_METHOD>] [--resource-type <RESOURCE_TYPE>] [--resource-id <RESOURCE_ID>] [--metrics <METRICS>] [--composite-rule <COMPOSITE_RULE>] [<ALARM ID or NAME>]
表6.48 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表6.49 位置引数
値 | 概要 |
---|---|
<ALARM ID または NAME> | アラームの ID または名前。 |
表6.50 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表6.51 common gnocchi alarm rules
値 | 概要 |
---|---|
--aggregation-method <AGGR_METHOD> | しきい値と比較する aggregation_method |
--granularity <GRANULARITY> | クエリーを行う時間範囲 (秒単位)。 |
表6.52 event alarm
値 | 概要 |
---|---|
--event-type <EVENT_TYPE> | 評価対象のイベントタイプ |
表6.53 gnocchi resource threshold alarm
値 | 概要 |
---|---|
--resource-id <RESOURCE_ID> | リソースの ID。 |
--resource-type <RESOURCE_TYPE> | リソースのタイプ。 |
表6.54 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表6.55 composite alarm
値 | 概要 |
---|---|
--composite-rule <COMPOSITE_RULE> | Json 形式の複合しきい値ルール。形式として、"and"や"or" で gnocchi ルールを組み合わせた、ネスト化ディクショナリーを指定できます。形式例: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}。 |
表6.56 その他の引数 (オプション):
値 | 概要 |
---|---|
--ok-action <Webhook URL> | 状態が ok に切り替わったときに呼び出す URL。複数回使用できます。 |
--user-id <USER_ID> | アラームに関連付けるユーザー (管理ユーザーだけが設定可能) |
--name <NAME> | アラームの名前 |
-t <TYPE>, --type <TYPE> | アラームのタイプ:event、composite、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold のいずれかです。 |
--repeat-actions {True | False} |
アラームがターゲット状態にある時にアクションを繰り返し通知する場合は True | --state <STATE> |
アラームの状態。以下のいずれか:[ok, alarm, insufficient data] | --time-constraint <Time Constraint> |
評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]] です。 | --project-id <PROJECT_ID> |
アラームに関連付けるプロジェクト (管理ユーザーだけが設定可能) | --insufficient-data-action <Webhook URL> |
状態が insufficient data に切り替わったときに呼び出す URL。複数回の使用が可能です。 | --severity <SEVERITY> |
アラームの重大度。以下のいずれか [low, moderate,critical] | --alarm-action <Webhook URL> |
状態が alarm に切り替わったときに呼び出す URL。複数回使用できます。 | -h, --help |
ヘルプメッセージを表示して終了します。 | --description <DESCRIPTION> |
アラームのフリーテキストの説明 | --enabled {True |
False} | アラーム評価が有効な場合は true。 |
表6.57 common alarm rules
値 | 概要 |
---|---|
--evaluation-periods <EVAL_PERIODS> | 評価する期間の数 |
--query <QUERY> | アラームのイベントタイプ: key[op]data_type::value; list。data_type はオプションですが、指定する場合には、文字列、整数、浮動またはブール型にする必要があります。gnocchi_aggregation_by_resources_threshold タイプのアラーム: {"and": [{"=": {"ended_at": null}}, …]} のように、複雑なクエリー json 文字列を指定する必要があります。 |
--comparison-operator <OPERATOR> | 比較するオペレーター:[lt,le,eq,ne,ge,gt] のいずれか。 |
--metric <METRIC> | 評価対象のメトリック。 |
--threshold <THRESHOLD> | 評価するしきい値。 |
表6.58 メトリクスアラームによる Gnocchi の集計
値 | 概要 |
---|---|
--metrics <METRICS> | メトリクス ID の一覧。 |
表6.59 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
第7章 アラーム
本章では、alarming
コマンドに含まれるコマンドについて説明します。
7.1. alarming capabilities list
アラームサービスの機能を一覧表示します。
使用方法
openstack alarming capabilities list [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX]
表7.1 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表7.2 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表7.3 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表7.4 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
表7.5 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
第8章 availability
本章では、availability
コマンドに含まれるコマンドについて説明します。
8.1. availability zone list
アベイラビリティーゾーンとそのステータスを一覧表示します。
使用方法
openstack availability zone list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--compute] [--network] [--volume] [--long]
表8.1 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表8.2 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表8.3 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表8.4 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表8.5 その他の引数 (オプション):
値 | 概要 |
---|---|
--compute | コンピュートアベイラビリティーゾーンを一覧表示します。 |
--volume | ボリュームのアベイラビリティーゾーンを一覧表示します。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--network | ネットワークアベイラビリティーゾーンを一覧表示します。 |
--long | 出力の追加フィールドを一覧表示します。 |
第9章 baremetal
本章では、baremetal
コマンドに含まれるコマンドについて説明します。
9.1. baremetal chassis create
新しいシャーシを作成します。
使用方法
openstack baremetal chassis create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--description <description>] [--extra <key=value>] [--uuid <uuid>]
表9.1 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.2 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表9.3 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.4 その他の引数 (オプション):
値 | 概要 |
---|---|
--uuid <uuid> | シャーシの一意の UUID |
-h, --help | ヘルプメッセージを表示して終了します。 |
--description <description> | シャーシの説明 |
--extra <key=value> | 任意のキー/値のメタデータを記録します。複数回指定できます。 |
表9.5 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
9.2. baremetal chassis delete
シャーシを削除します。
使用方法
openstack baremetal chassis delete [-h] <chassis> [<chassis> ...]
表9.6 位置引数
値 | 概要 |
---|---|
<chassis> | 削除するシャーシの UUID |
表9.7 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.3. ベアメタルシャーシの一覧
シャーシを一覧表示します。
使用方法
openstack baremetal chassis list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--fields <field> [<field> ...]] [--limit <limit>] [--long] [--marker <chassis>] [--sort <key>[:<direction>]]
表9.8 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.9 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.10 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.11 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.12 その他の引数 (オプション):
値 | 概要 |
---|---|
--marker <chassis> | シャーシ uuid(以前の要求リストにある最後のシャーシなど)。この UUID の後にシャーシの一覧を返します。 |
--long | シャーシに関する詳細情報を表示します。 |
--limit <limit> | 要求ごとに返すシャーシの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。 |
--fields <field> [<field> …] | 1 つ以上のシャーシフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。 |
--sort <key>[:<direction>] | 指定したシャシーフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
9.4. baremetal chassis set
シャーシのプロパティーを設定します。
使用方法
openstack baremetal chassis set [-h] [--description <description>] [--extra <key=value>] <chassis>
表9.13 位置引数
値 | 概要 |
---|---|
<chassis> | シャーシの UUID |
表9.14 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--description <description> | シャーシの説明を設定します。 |
--extra <key=value> | このシャーシに設定する追加項目 (複数の追加項目を設定する場合は、オプションを繰り返し使用します。) |
9.5. baremetal chassis show
シャーシの詳細を表示します。
使用方法
openstack baremetal chassis show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--fields <field> [<field> ...]] <chassis>
表9.15 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.16 位置引数
値 | 概要 |
---|---|
<chassis> | シャーシの UUID |
表9.17 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表9.18 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.19 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--fields <field> [<field> …] | 1 つ以上のシャーシフィールド。これらのフィールドのみがサーバーから取得されます。 |
表9.20 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
9.6. baremetal chassis unset
シャーシのプロパティーの設定を解除します。
使用方法
openstack baremetal chassis unset [-h] [--description] [--extra <key>] <chassis>
表9.21 位置引数
値 | 概要 |
---|---|
<chassis> | シャーシの UUID |
表9.22 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--extra <key> | このシャーシの設定を解除する追加項目 (複数の追加項目の設定を解除する場合は、オプションを繰り返し使用します。) |
--description | シャーシの説明を消去します。 |
9.7. baremetal create
ファイルからのリソースを作成します。
使用方法
openstack baremetal create [-h] <file> [<file> ...]
表9.23 位置引数
値 | 概要 |
---|---|
<file> | 作成するリソースの説明が記載されているファイル (.yaml または .json)。複数回指定できます。 |
表9.24 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.8. baremetal driver list
有効なドライバーを一覧表示します。
使用方法
openstack baremetal driver list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--type <type>] [--long]
表9.25 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.26 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.27 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.28 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.29 その他の引数 (オプション):
値 | 概要 |
---|---|
--type <type> | ドライバーのタイプ (classic または dynamic)。デフォルトでは、すべてのドライバーが一覧表示されます。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--long | ドライバーに関する詳細情報を表示します。 |
9.9. baremetal driver passthru call
ドライバーのベンダーパススルーメソッドを呼び出します。
使用方法
openstack baremetal driver passthru call [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--arg <key=value>] [--http-method <http-method>] <driver> <method>
表9.30 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.31 位置引数
値 | 概要 |
---|---|
<method> | 呼び出すベンダーパススルーメソッド |
<driver> | ドライバーの名前。 |
表9.32 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表9.33 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.34 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--http-method <http-method> | パススルー要求で使用する http メソッド。DELETE、GET、PATCH、POST、PUT のいずれか。デフォルトは POST です。 |
--arg <key=value> | Passthru メソッドに渡す引数 (複数の引数を指定する場合は、オプションを繰り返し使用します)。 |
表9.35 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
9.10. baremetal driver passthru list
ドライバーで利用可能なベンダーパススルー方法を一覧表示します。
使用方法
openstack baremetal driver passthru list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] <driver>
表9.36 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.37 位置引数
値 | 概要 |
---|---|
<driver> | ドライバーの名前。 |
表9.38 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.39 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.40 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.41 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.11. baremetal driver property list
ドライバープロパティーを一覧表示します。
使用方法
openstack baremetal driver property list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] <driver>
表9.42 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.43 位置引数
値 | 概要 |
---|---|
<driver> | ドライバーの名前。 |
表9.44 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.45 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.46 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.47 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.12. baremetal driver raid property list
ドライバーの RAID 論理ネットワークプロパティーを一覧表示します。
使用方法
openstack baremetal driver raid property list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] <driver>
表9.48 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.49 位置引数
値 | 概要 |
---|---|
<driver> | ドライバーの名前。 |
表9.50 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.51 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.52 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.53 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.13. baremetal driver show
ドライバーに関する情報を表示します。
使用方法
openstack baremetal driver show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] <driver>
表9.54 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.55 位置引数
値 | 概要 |
---|---|
<driver> | ドライバーの名前。 |
表9.56 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表9.57 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.58 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
表9.59 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
9.14. baremetal introspection abort
ノードのイントロスペクションの実行を中止します。
使用方法
openstack baremetal introspection abort [-h] node
表9.60 位置引数
値 | 概要 |
---|---|
node | ベアメタルノードの uuid または名前 |
表9.61 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.15. baremetal introspection data save
未加工のイントロスペクションデータを保存または表示します。
使用方法
openstack baremetal introspection data save [-h] [--file <filename>] node
表9.62 位置引数
値 | 概要 |
---|---|
node | ベアメタルノードの uuid または名前 |
表9.63 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--file <filename> | ダウンロードするイントロスペクションデータのファイル名 (デフォルト:stdout) |
9.16. baremetal introspection interface list
接続されたスイッチポート情報を含むインターフェイスデータを一覧表示します。
使用方法
openstack baremetal introspection interface list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--vlan VLAN] [--long | --fields <field> [<field> ...]] node_ident
表9.64 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.65 位置引数
値 | 概要 |
---|---|
node_ident | ベアメタルノードの uuid または名前 |
表9.66 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.67 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.68 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.69 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--vlan VLAN | この vlan ID 用に設定されたインターフェイスのみを一覧表示します。繰り返し使用できます。 |
--long | インターフェイスに関する詳細情報を表示します。 |
--fields <field> [<field> …] | 1 つ以上のフィールドを表示します。-- long が指定されている場合は使用できません。 |
9.17. baremetal introspection interface show
接続されたスイッチポート情報が含まれるインターフェイスデータを表示します。
使用方法
openstack baremetal introspection interface show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--fields <field> [<field> ...]] node_ident interface
表9.70 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.71 位置引数
値 | 概要 |
---|---|
interface | インターフェイス名 |
node_ident | ベアメタルノードの uuid または名前 |
表9.72 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表9.73 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.74 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--fields <field> [<field> …] | 1 つ以上のフィールドを表示します。 |
表9.75 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
9.18. baremetal introspection list
イントロスペクションのステータスを一覧表示します。
使用方法
openstack baremetal introspection list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--marker MARKER] [--limit LIMIT]
表9.76 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.77 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.78 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.79 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.80 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--limit LIMIT | 返す項目数 |
--marker MARKER | 前のページにある最後の項目の UUID |
9.19. baremetal introspection reprocess
保存されたイントロスペクションデータを再処理します。
使用方法
openstack baremetal introspection reprocess [-h] node
表9.81 位置引数
値 | 概要 |
---|---|
node | ベアメタルノードの uuid または名前 |
表9.82 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.20. baremetal introspection rule delete
イントロスペクションルールを削除します。
使用方法
openstack baremetal introspection rule delete [-h] uuid
表9.83 位置引数
値 | 概要 |
---|---|
uuid | ルールの uuid |
表9.84 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.21. baremetal introspection rule import
JSON/YAML ファイルから 1 つまたは複数のイントロスペクションルールをインポートします。
使用方法
openstack baremetal introspection rule import [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] file
表9.85 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.86 位置引数
値 | 概要 |
---|---|
file | インポートする JSON ファイル。1 つまたは複数のルールを含めることができます。 |
表9.87 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.88 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.89 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.90 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.22. baremetal introspection rule list
全イントロスペクションルールを一覧表示します。
使用方法
openstack baremetal introspection rule list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN]
表9.91 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.92 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.93 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.94 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.95 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.23. baremetal introspection rule purge
すべてのイントロスペクションルールを破棄します。
使用方法
openstack baremetal introspection rule purge [-h]
表9.96 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.24. baremetal introspection rule show
イントロスペクションルールを表示します。
使用方法
openstack baremetal introspection rule show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] uuid
表9.97 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.98 位置引数
値 | 概要 |
---|---|
uuid | ルールの uuid |
表9.99 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表9.100 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.101 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
表9.102 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
9.25. baremetal introspection start
イントロスペクションを開始します。
使用方法
openstack baremetal introspection start [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--wait] node [node ...]
表9.103 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.104 位置引数
値 | 概要 |
---|---|
node | ベアメタルノードの uuid または名前 |
表9.105 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.106 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.107 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.108 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--wait | イントロスペクションが完了するまで待機します。結果は最後に表示されます。 |
9.26. baremetal introspection status
イントロスペクションのステータスを取得します。
使用方法
openstack baremetal introspection status [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] node
表9.109 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.110 位置引数
値 | 概要 |
---|---|
node | ベアメタルノードの uuid または名前 |
表9.111 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表9.112 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.113 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
表9.114 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
9.27. baremetal node abort
ベアメタルノードのプロビジョニング状態を abort に設定します。
使用方法
openstack baremetal node abort [-h] <node>
表9.115 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.116 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.28. baremetal node add trait
ノードに特性を追加します。
使用方法
openstack baremetal node add trait [-h] <node> <trait> [<trait> ...]
表9.117 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
<trait> | 追加する特性 |
表9.118 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.29. baremetal node adopt
ベアメタルノードのプロビジョニング状態を adopt に設定します。
使用方法
openstack baremetal node adopt [-h] [--wait [<time-out>]] <node>
表9.119 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.120 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--wait [<time-out>] | ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
9.30. baremetal node boot device set
ノードのブートデバイスを設定します。
使用方法
openstack baremetal node boot device set [-h] [--persistent] <node> <device>
表9.121 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
<device> | Bios、cdrom、disk、pxe、safe、wanboot のいずれか |
表9.122 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--persistent | 今後の起動時にすべての変更を永続化します。 |
9.31. baremetal node boot device show
ノードのブートデバイス情報を表示します。
使用方法
openstack baremetal node boot device show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--supported] <node>
表9.123 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.124 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表9.125 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表9.126 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.127 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--supported | サポート対象のブートデバイスを表示します。 |
表9.128 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
9.32. baremetal node clean
ベアメタルノードのプロビジョニング状態を clean に設定します。
使用方法
openstack baremetal node clean [-h] [--wait [<time-out>]] --clean-steps <clean-steps> <node>
表9.129 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.130 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--wait [<time-out>] | ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
--clean-steps <clean-steps> | Json 形式の消去手順。消去手順が含まれるファイルへのパス、- (消去手順が標準入力から読み取る)、または文字列になります。値は clean-step ディクショナリーの一覧である必要があります。各ディクショナリーには、キーの interface および step、任意のキーの args が必要です。 |
9.33. baremetal node console disable
ノードのコンソールアクセスを無効化します。
使用方法
openstack baremetal node console disable [-h] <node>
表9.131 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表9.132 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.34. baremetal node console enable
ノードのコンソールアクセスを有効化します。
使用方法
openstack baremetal node console enable [-h] <node>
表9.133 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表9.134 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.35. baremetal node console show
ノードのコンソール情報を表示します。
使用方法
openstack baremetal node console show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] <node>
表9.135 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.136 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表9.137 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表9.138 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.139 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
表9.140 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
9.36. baremetal node create
新規ノードを baremetal サービスに登録します。
使用方法
openstack baremetal node create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--chassis-uuid <chassis>] --driver <driver> [--driver-info <key=value>] [--property <key=value>] [--extra <key=value>] [--uuid <uuid>] [--name <name>] [--boot-interface <boot_interface>] [--console-interface <console_interface>] [--deploy-interface <deploy_interface>] [--inspect-interface <inspect_interface>] [--management-interface <management_interface>] [--network-interface <network_interface>] [--power-interface <power_interface>] [--raid-interface <raid_interface>] [--storage-interface <storage_interface>] [--vendor-interface <vendor_interface>] [--resource-class <resource_class>]
表9.141 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.142 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表9.143 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.144 その他の引数 (オプション):
値 | 概要 |
---|---|
--inspect-interface <inspect_interface> | ノードのドライバーで使用されるインスペクトインターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--boot-interface <boot_interface> | ノードのドライバーで使用される起動インターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--management-interface <management_interface> | ノードのドライバーで使用される管理インターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--driver <driver> | ノードの制御に使用されるドライバー [必須]。 |
--deploy-interface <deploy_interface> | ノードのドライバーで使用されるデプロイインターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--uuid <uuid> | ノードの一意の UUID。 |
--console-interface <console_interface> | ノードのドライバーで使用されるコンソールインターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--chassis-uuid <chassis> | このノードが属するシャーシの UUID。 |
--network-interface <network_interface> | クリーニング/プロビジョニングネットワークへのノードの切り替えに使用するネットワークインターフェイス |
--property <key=value> | ノードの物理的な特性を記述するキー/値のペア。これは Nova にエクスポートされ、スケジューラーが使用します。複数回指定できます。 |
--vendor-interface <vendor_interface> | ノードのドライバーで使用されるベンダーインターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--resource-class <resource_class> | ノードを nova フレーバーにマッピングするためのリソースクラス |
--raid-interface <raid_interface> | ノードのドライバーで使用される RAID インターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--storage-interface <storage_interface> | ノードのドライバーが使用するストレージインターフェイス。 |
--power-interface <power_interface> | ノードのドライバーで使用される電源インターフェイス。これは、指定の --driver がハードウェアタイプである場合にのみ適用できます。 |
--name <name> | ノードの一意名。 |
--driver-info <key=value> | アウトバウンド管理認証情報など、ドライバーが使用するキー/値のペア。複数回指定できます。 |
--extra <key=value> | 任意のキー/値のメタデータを記録します。複数回指定できます。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
表9.145 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
9.37. baremetal node delete
ベアメタルノードの登録を解除します。
使用方法
openstack baremetal node delete [-h] <node> [<node> ...]
表9.146 位置引数
値 | 概要 |
---|---|
<node> | 削除するノード (名前または uuid) |
表9.147 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.38. baremetal node deploy
ベアメタルノードのプロビジョニングの状態を deploy に設定します。
使用方法
openstack baremetal node deploy [-h] [--wait [<time-out>]] [--config-drive <config-drive>] <node>
表9.148 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.149 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--wait [<time-out>] | ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
--config-drive <config-drive> | gzipped, base64 でエンコードされたコンフィグドライブの文字列、またはコンフィグドライブファイルへのパス、またはコンフィグドライブファイルを含むディレクトリーへのパス。ディレクトリーの場合には、コンフィグドライブはそのディレクトリーで生成されます。 |
9.39. baremetal node inject nmi
NMI をベアメタルノードに注入します。
使用方法
openstack baremetal node inject nmi [-h] <node>
表9.150 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.151 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.40. baremetal node inspect
ベアメタルノードのプロビジョニング状態を inspect に設定します。
使用方法
openstack baremetal node inspect [-h] [--wait [<time-out>]] <node>
表9.152 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.153 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--wait [<time-out>] | ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
9.41. baremetal node list
ベアメタルノードを一覧表示します。
使用方法
openstack baremetal node list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--limit <limit>] [--marker <node>] [--sort <key>[:<direction>]] [--maintenance | --no-maintenance] [--associated | --unassociated] [--provision-state <provision state>] [--driver <driver>] [--resource-class <resource class>] [--chassis <chassis UUID>] [--long | --fields <field> [<field> ...]]
表9.154 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.155 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.156 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.157 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.158 その他の引数 (オプション):
値 | 概要 |
---|---|
--sort <key>[:<direction>] | 指定したノードフィールドおよび方向 (asc または desc、asc がデフォルト) で出力を並べ替えます。複数のフィールドと方向をコンマで区切って指定できます。 |
--chassis <chassis UUID> | このシャーシのノードのみに一覧を制限します。 |
--resource-class <resource class> | リソースクラスが <resource class> のノードのみに一覧を制限します。 |
--marker <node> | ノードの uuid(例: 以前の要求リストにある最後のノード)。UUID の後にノードの一覧を返します。 |
--long | ノードの詳細情報を表示します。 |
--provision-state <provision state> | 指定したプロビジョニング状態のノードを一覧表示します。 |
--limit <limit> | 要求ごとに返すノードの最大数。0 は制限なしです。デフォルトは、Baremetal API サービスが使用する最大数です。 |
--fields <field> [<field> …] | 1 つ以上のノードフィールド。これらのフィールドのみがサーバーから取得されます。--long が指定されている場合は使用できません。 |
--maintenance | メンテナーンスモードのノードだけにリストを制限します。 |
--unassociated | インスタンスに関連付けられていないノードのみを一覧表示します。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--associated | インスタンスに関連付けられているノードのみを一覧表示します。 |
--no-maintenance | メンテナーンスモード以外のノードだけにリストを制限します。 |
--driver <driver> | ドライバーが <driver> のノードのみに一覧を制限します。 |
9.42. baremetal node maintenance set
ベアメタルノードをメンテナーンスモードに設定します。
使用方法
openstack baremetal node maintenance set [-h] [--reason <reason>] <node>
表9.159 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.160 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--reason <reason> | メンテナーンスモードを設定する理由。 |
9.43. baremetal node maintenance unset
メンテナーンスモードのベアメタルノードの設定を解除します。
使用方法
openstack baremetal node maintenance unset [-h] <node>
表9.161 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.162 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.44. baremetal node manage
ベアメタルノードのプロビジョニングの状態を manage に設定します。
使用方法
openstack baremetal node manage [-h] [--wait [<time-out>]] <node>
表9.163 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.164 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--wait [<time-out>] | ノードが必要な状態 (manageable) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
9.45. baremetal node passthru call
ノードのベンダーパススルーメソッドを呼び出します。
使用方法
openstack baremetal node passthru call [-h] [--arg <key=value>] [--http-method <http-method>] <node> <method>
表9.165 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
<method> | 実行するベンダーパススルーメソッド |
表9.166 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--http-method <http-method> | パススルー要求で使用する http メソッド。DELETE、GET、PATCH、POST、PUT のいずれか。デフォルトは POST です。 |
--arg <key=value> | Passthru メソッドに渡す引数 (複数の引数を指定する場合は、オプションを繰り返し使用します)。 |
9.46. baremetal node passthru list
ノードのベンダーパススルー方法を一覧表示します。
使用方法
openstack baremetal node passthru list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] <node>
表9.167 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.168 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表9.169 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.170 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.171 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.172 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.47. baremetal node power off
ノードの電源をオフにします。
使用方法
openstack baremetal node power off [-h] [--power-timeout <power-timeout>] [--soft] <node>
表9.173 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.174 その他の引数 (オプション):
値 | 概要 |
---|---|
--soft | 正常な電源オフを要求します。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--power-timeout <power-timeout> | エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間 (秒単位、正の整数)。 |
9.48. baremetal node power on
ノードの電源をオンにします。
使用方法
openstack baremetal node power on [-h] [--power-timeout <power-timeout>] <node>
表9.175 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.176 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--power-timeout <power-timeout> | エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間 (秒単位、正の整数)。 |
9.49. baremetal node provide
ベアメタルノードのプロビジョニングの状態を provide に設定します。
使用方法
openstack baremetal node provide [-h] [--wait [<time-out>]] <node>
表9.177 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.178 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--wait [<time-out>] | ノードが必要な状態 (available) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
9.50. baremetal node reboot
ベアメタルノードを再起動します。
使用方法
openstack baremetal node reboot [-h] [--soft] [--power-timeout <power-timeout>] <node>
表9.179 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.180 その他の引数 (オプション):
値 | 概要 |
---|---|
--soft | 正常な再起動を要求します。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--power-timeout <power-timeout> | エラーで終了するまで、ターゲットとなる電源状態になるのを待機する時間 (秒単位、正の整数)。 |
9.51. baremetal node rebuild
ベアメタルノードのプロビジョニングの状態を rebuild に設定します。
使用方法
openstack baremetal node rebuild [-h] [--wait [<time-out>]] [--config-drive <config-drive>] <node>
表9.181 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.182 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--wait [<time-out>] | ノードが必要な状態 (active) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
--config-drive <config-drive> | gzipped, base64 でエンコードされたコンフィグドライブの文字列、またはコンフィグドライブファイルへのパス、またはコンフィグドライブファイルを含むディレクトリーへのパス。ディレクトリーの場合には、コンフィグドライブはそのディレクトリーで生成されます。 |
9.52. baremetal node remove trait
ノードから特性を削除します。
使用方法
openstack baremetal node remove trait [-h] [--all] <node> [<trait> [<trait> ...]]
表9.183 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
<trait> | 削除する特性 |
表9.184 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--all | すべての特性を削除します。 |
9.53. baremetal node set
ベアメタルのプロパティーを設定します。
使用方法
openstack baremetal node set [-h] [--instance-uuid <uuid>] [--name <name>] [--chassis-uuid <chassis UUID>] [--driver <driver>] [--boot-interface <boot_interface>] [--console-interface <console_interface>] [--deploy-interface <deploy_interface>] [--inspect-interface <inspect_interface>] [--management-interface <management_interface>] [--network-interface <network_interface>] [--power-interface <power_interface>] [--raid-interface <raid_interface>] [--storage-interface <storage_interface>] [--vendor-interface <vendor_interface>] [--resource-class <resource_class>] [--target-raid-config <target_raid_config>] [--property <key=value>] [--extra <key=value>] [--driver-info <key=value>] [--instance-info <key=value>] <node>
表9.185 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.186 その他の引数 (オプション):
値 | 概要 |
---|---|
--instance-uuid <uuid> | ノードのインスタンスの uuid を <uuid> に設定します。 |
--inspect-interface <inspect_interface> | ノードの検査インターフェイスを設定します。 |
--boot-interface <boot_interface> | ノードの起動インターフェイスを設定します。 |
--management-interface <management_interface> | ノードの管理インターフェイスを設定します。 |
--driver <driver> | ノードのドライバーを設定します。 |
--extra <key=value> | このベアメタルノードに設定する追加項目 (複数のプロパティーを設定する場合はオプションを繰り返し使用します) |
--deploy-interface <deploy_interface> | ノードのデプロイインターフェイスを設定します。 |
--name <name> | ノードの名前。 |
--console-interface <console_interface> | ノードのコンソールインターフェイスを設定します。 |
--power-interface <power_interface> | ノードの電源インターフェイスを設定します。 |
--network-interface <network_interface> | ノードのネットワークインターフェイスを設定します。 |
--property <key=value> | このベアメタルノードに設定するプロパティー (複数のプロパティーを設定する場合はオプションを繰り返し使用します) |
--vendor-interface <vendor_interface> | ノードのベンダーインターフェイスを設定します。 |
--resource-class <resource_class> | ノードのリソースクラスを設定します。 |
--chassis-uuid <chassis UUID> | ノードのシャーシを設定します。 |
--raid-interface <raid_interface> | ノードの RAID インターフェイスを設定します。 |
--storage-interface <storage_interface> | ノードのストレージインターフェイスを設定します。 |
--instance-info <key=value> | このベアメタルノードに設定するインスタンス情報 (複数のインスタンス情報を設定する場合はオプションを繰り返し使用します) |
--driver-info <key=value> | このベアメタルノードに設定するドライバー情報 (複数のドライバー情報を設定する場合はオプションを繰り返し使用します) |
-h, --help | ヘルプメッセージを表示して終了します。 |
--target-raid-config <target_raid_config> | ノードのターゲット RAID 設定 (json) を設定します。これには、以下のいずれかを使用できます。1. RAID 設定の JSON データを含むファイル、2. 標準入力からコンテンツを読み取る "-"、3、有効な JSON 文字列。 |
9.54. baremetal node show
ベアメタルノードの詳細を表示します。
使用方法
openstack baremetal node show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--instance] [--fields <field> [<field> ...]] <node>
表9.187 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.188 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または uuid(または --instance が指定されている場合のインスタンスの uuid) |
表9.189 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表9.190 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.191 その他の引数 (オプション):
値 | 概要 |
---|---|
--instance | <node> はインスタンスの uuid です。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--fields <field> [<field> …] | 1 つ以上のノードフィールド。これらのフィールドのみがサーバーから取得されます。 |
表9.192 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
9.55. baremetal node trait list
ノードの特性を一覧表示します。
使用方法
openstack baremetal node trait list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] <node>
表9.193 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.194 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表9.195 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.196 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.197 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.198 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.56. baremetal node undeploy
ベアメタルノードのプロビジョニングの状態を deleted に設定します。
使用方法
openstack baremetal node undeploy [-h] [--wait [<time-out>]] <node>
表9.199 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.200 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--wait [<time-out>] | ノードが必要な状態 (available) に到達するまで待機します。オプションでタイムアウト値 (秒単位) を指定できます。デフォルト値は 0 で、無期限に待機します。 |
9.57. baremetal node unset
ベアメタルプロパティーの設定を解除します。
使用方法
openstack baremetal node unset [-h] [--instance-uuid] [--name] [--resource-class] [--target-raid-config] [--property <key>] [--extra <key>] [--driver-info <key>] [--instance-info <key>] [--chassis-uuid] [--boot-interface] [--console-interface] [--deploy-interface] [--inspect-interface] [--management-interface] [--network-interface] [--power-interface] [--raid-interface] [--storage-interface] [--vendor-interface] <node>
表9.201 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID。 |
表9.202 その他の引数 (オプション):
値 | 概要 |
---|---|
--property <key> | このベアメタルノードで設定を解除するプロパティー (複数のプロパティーの設定を解除する場合はオプションを繰り返し使用します) |
--storage-interface | このベアメタルノードでのストレージインターフェイスの設定を解除します。 |
--instance-uuid | このベアメタルノードでのインスタンスの uuid の設定を解除します。 |
--deploy-interface | このベアメタルノードでのデプロイインターフェイスの設定を解除します。 |
--vendor-interface | このベアメタルノードでのベンダーインターフェイスの設定を解除します。 |
--network-interface | このベアメタルノードでのネットワークインターフェイスの設定を解除します。 |
--instance-info <key> | このベアメタルノードでの設定を解除するインスタンス情報 (複数のインスタンス情報の設定を解除する場合はオプションを繰り返し使用します) |
--driver-info <key> | このベアメタルノードでの設定を解除するドライバー情報 (複数のドライバー情報の設定を解除する場合はオプションを繰り返し使用します) |
--extra <key> | このベアメタルノードの設定を追加で解除する項目 (複数のプロパティーを設定する場合はオプションを繰り返し使用します) |
--resource-class | ノードのリソースクラスの設定を解除します。 |
--management-interface | このベアメタルノードでの管理インターフェイスの設定を解除します。 |
--boot-interface | このベアメタルノードでのブートインターフェイスの設定を解除します。 |
--raid-interface | このベアメタルノードでの RAID インターフェイスの設定を解除します。 |
--console-interface | このベアメタルノードでのコンソールインターフェイスの設定を解除します。 |
--target-raid-config | ノードのターゲット RAID 設定の設定を解除します。 |
--name | ノードの名前の設定を解除します。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--inspect-interface | このベアメタルノードでの検査インターフェイスの設定を解除します。 |
--chassis-uuid | このベアメタルノードでのシャーシ UUID の設定を解除します。 |
--power-interface | このベアメタルノードの電源インターフェイスの設定を解除します。 |
9.58. baremetal node validate
ノードのドライバーインターフェイスを検証します。
使用方法
openstack baremetal node validate [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] <node>
表9.203 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.204 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表9.205 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.206 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.207 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.208 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.59. baremetal node vif attach
VIF を指定ノードに接続します。
使用方法
openstack baremetal node vif attach [-h] [--vif-info <key=value>] <node> <vif-id>
表9.209 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
<vif-id> | ノードに割り当てる vif の名前または UUID。 |
表9.210 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
--vif-info <key=value> | 任意のキー/値のメタデータを記録します。複数回指定できます。必須の id パラメーターはキーとして指定できません。 |
9.60. baremetal node vif detach
指定のノードから VIF を切断します。
使用方法
openstack baremetal node vif detach [-h] <node> <vif-id>
表9.211 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
<vif-id> | ノードから切り離す vif の名前または UUID。 |
表9.212 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.61. baremetal node vif list
ノードに接続された VIF を表示します。
使用方法
openstack baremetal node vif list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] <node>
表9.213 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.214 位置引数
値 | 概要 |
---|---|
<node> | ノードの名前または UUID |
表9.215 CSV 書式設定
値 | 概要 |
---|---|
--quote {all,minimal,none,nonnumeric} | 引用符を含める場合に使用します。デフォルトで数字以外の数値に設定されます。 |
表9.216 出力形式の設定
値 | 概要 |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
--sort-column SORT_COLUMN | データを並べ替えるコラムを指定します (最初に指定した列には優先順位があり、存在しない列は無視されます)。 |
表9.217 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.218 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.62. baremetal port create
新規ポートの作成
使用方法
openstack baremetal port create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] --node <uuid> [--uuid <uuid>] [--extra <key=value>] [--local-link-connection <key=value>] [-l <key=value>] [--pxe-enabled <boolean>] [--port-group <uuid>] [--physical-network <physical network>] <address>
表9.219 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.220 位置引数
値 | 概要 |
---|---|
<address> | このポートの MAC アドレス。 |
表9.221 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表9.222 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.223 その他の引数 (オプション):
値 | 概要 |
---|---|
--extra <key=value> | 任意のキー/値のメタデータを記録します。複数回指定できます。 |
--physical-network <physical network> | このポートを接続する物理ネットワークの名前。 |
--uuid <uuid> | ポートの UUID |
--port-group <uuid> | このポートが属するポートグループの UUID。 |
--local-link-connection <key=value> | ローカルリンク接続情報を記述するキー/値のメタデータ。有効なキーは switch_info、switch_id、および port_id です。switch_id と port_id キーは必須です。複数回指定できます。 |
--pxe-enabled <boolean> | このノードの PXE の起動時にこのポートを使用するかどうかを指定します。 |
-l <key=value> | 非推奨です。代わりに --local-link-connection を使用してください。ローカルリンク接続情報を記述するキー/値のメタデータ。有効なキーは switch_info、switch_id、および port_id です。switch_id と port_id キーは必須です。複数回指定できます。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--node <uuid> | このポートが属するノードの UUID。 |
表9.224 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
9.63. baremetal port delete
ポートを削除します。
使用方法
openstack baremetal port delete [-h] <port> [<port> ...]
表9.225 位置引数
値 | 概要 |
---|---|
<port> | 削除するポートの UUID |
表9.226 その他の引数 (オプション):
値 | 概要 |
---|---|
-h, --help | ヘルプメッセージを表示して終了します。 |
9.64. baremetal port group create
新規ベアメタルポートグループを作成します。
使用方法
openstack baremetal port group create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] --node <uuid> [--address <mac-address>] [--name NAME] [--uuid UUID] [--extra <key=value>] [--mode MODE] [--property <key=value>] [--support-standalone-ports | --unsupport-standalone-ports]
表9.227 表の書式設定
値 | 概要 |
---|---|
--print-empty | 表示するデータがない場合は空のテーブルを出力します。 |
--max-width <integer> | 表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。 |
--fit-width | 表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。 |
表9.228 出力形式の設定
値 | 概要 |
---|---|
出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 出力形式。デフォルトは table です。 |
-c COLUMN, --column COLUMN | 追加する列を指定します。繰り返すことができます。 |
表9.229 JSON 書式設定
値 | 概要 |
---|---|
--noindent | Json のインデントを無効にするかどうか。 |
表9.230 その他の引数 (オプション):
値 | 概要 |
---|---|
--support-standalone-ports | このポートグループのメンバーであるポートはスタンドアロンのポートとして使用できます (デフォルト)。 |
--extra <key=value> | 任意のキー/値のメタデータを記録します。複数回指定できます。 |
--address <mac-address> | このポートグループの MAC アドレス。 |
--unsupport-standalone-ports | このポートグループのメンバーであるポートは、スタンドアロンのポートとしては使用できません。 |
--property <key=value> | このポートグループの設定に関連するキー/値プロパティー。複数回指定できます。 |
--mode MODE | ポートグループのモード。使用できる値は https://www.kernel.org/doc/Documentation/networking/bo nding.txt を参照してください。 |
--name NAME | ポートグループの名前。 |
-h, --help | ヘルプメッセージを表示して終了します。 |
--uuid UUID | ポートグループの UUID |
--node <uuid> | このポートグループが属するノードの UUID。 |
表9.231 Shell フォーマッター
値 | 概要 |
---|---|
UNIX シェルが解析できる形式(variable="value")--prefix PREFIX | すべての変数名に接頭辞を追加します。 |
9.65. baremetal port group delete
ベ