第1章 OpenStack クライアント

--version

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

-v、--verbose

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

-q, --quiet

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

--log-file LOG_FILE

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

-h, --help

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

--debug

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

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

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

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

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

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

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

--os-cert <certificate-file>

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

--os-key <key-file>

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

--verify

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

--insecure

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

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

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

--os-interface <interface>

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

--os-service-provider <service_provider>

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

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

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

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

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

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

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

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

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

--timing

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

--os-beta-command

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

--os-profile hmac-key

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

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

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

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

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

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

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

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

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

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

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

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

volume api version, default=2(env: OS_VOLUME_API_VERSION)

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

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

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

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

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

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

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

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

--os-data-processing-url OS_DATA_PROCESSING_URL

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

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

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

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

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

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

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

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

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

--inspector-api-version INSPECTOR_API_VERSION

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

--inspector-url INSPECTOR_URL

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

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

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

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

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

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

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

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

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

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

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

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

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

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

パスワードを使用した v3oidcpassword: 認証 URL の場合： v3totp を使用した認証 URL: v3oidcclientcredentials を使用する認証 URL: v3oauth1 を使用した認証 URL: v3tokenlessauth を使用した認証 URL: v3token を使用した認証 URL: v3applicationcredential を使用した認証 URL: v2password を使用した認証 URL: v3password を使用した認証 URL: v2token を使用した認証 URL: v3oidcauthcode を使用する認証 URL: v3adfspassword を使用した認証 URL: v3samlpassword を使用する認証 URL: v1password を使用する認証 URL: トークンのある認証 URL: v3oidcaccesstoken を使用する認証 URL: 認証 URL(Env): OS_AUTH_URL）

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

パスワードを持つシステム操作の v3oidcpassword: 範囲は以下のようになります。 v3totp を使用したシステム操作の範囲： v3oidcclientcredentials を使用するシステム操作の範囲： v3token を使用するシステム操作の範囲： v3applicationcredential を使用するシステム操作の範囲： v3password を使用するシステム操作の範囲： v3oidcauthcode を使用するシステム操作の範囲： v3adfspassword を使用するシステム操作の範囲： v3samlpassword を使用するシステム操作の範囲： トークンを使用するシステム操作の範囲： v3oidcaccesstoken を使用するシステム操作のスコープ。 システム操作のスコープ（Env: SYSTEM_SYSTEM_SCOPE）

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

パスワードでスコープを v3oidcpassword: domain id に置き換えます。 v3totp にバインドするドメイン ID: v3oidcclientcredentials のスコープに設定するドメイン ID: v3tokenlessauth にバインドするドメイン ID: v3token のスコープに設定するドメイン ID: v3applicationcredential のスコープに設定するドメイン ID: v3password のスコープに設定するドメイン ID: v3oidcauthcode のスコープに設定するドメイン ID: v3adfspassword のスコープに設定するドメイン ID: v3samlpassword のスコープに設定するドメイン ID: トークンのあるスコープに設定するドメイン ID: v3oidcaccesstoken のスコープに設定するドメイン ID: スコープするドメイン ID（Env: os_DOMAIN_ID）

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

パスワードスコープに v3oidcpassword: ドメイン名を指定して設定します。 v3totp にバインドするドメイン名 v3oidcclientcredentials のスコープに設定するドメイン名 v3tokenlessauth にバインドするドメイン名 With v3token にバインドするドメイン名 v3applicationcredential に適用するドメイン名 v3password のスコープに設定するドメイン名 v3oidcauthcode のスコープに設定するドメイン名： v3adfspassword のスコープに設定するドメイン名 v3samlpassword のスコープに設定するドメイン名 スコープ指定に使用するドメイン名(with token): v3oidcaccesstoken のスコープに設定するドメイン名： スコープするドメイン名(Env: Env): os_domain_name）

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

パスワードスコープに v3oidcpassword: プロジェクト ID を指定します。 v3totp にバインドするプロジェクト ID: noauth にバインドするプロジェクト ID: v3oidcclientcredentials を使用するプロジェクト ID: v3tokenlessauth のスコープに設定するプロジェクト ID: With v3token にバインドするプロジェクト ID: gnocchi-noauth のスコープに設定するプロジェクト ID: v3applicationcredential を使用したプロジェクト ID: aodh-noauth のスコープに設定するプロジェクト ID: v3password を使用したプロジェクト ID: v3oidcauthcode のスコープに設定するプロジェクト ID: v3adfspassword のスコープに設定するプロジェクト ID: v3samlpassword のスコープに設定するプロジェクト ID: With token にバインドするプロジェクト ID: V3oidcaccesstoken のスコープに設定するプロジェクト ID: スコープするプロジェクト ID（Env: os_PROJECT_ID）

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

パスワードスコープに v3oidcpassword: プロジェクト名を指定します。 スコープを v3totp に指定するプロジェクト名 スコープを指定するプロジェクト名(With v3oidcclientcredentials): v3tokenlessauth スコープに設定するプロジェクト名： With v3token にバインドするプロジェクト名： v3applicationcredential のスコープに設定するプロジェクト名 スコープを設定するプロジェクト名(With v3password): v3oidcauthcode のスコープに設定するプロジェクト名： v3adfspassword のスコープに設定するプロジェクト名： v3samlpassword のスコープに設定するプロジェクト名： スコープを指定するプロジェクト名(v1password): トークンと共に使用する Swift アカウント： Project name to scope to With v3oidcaccesstoken: スコープするプロジェクト名（Env: os_PROJECT_NAME）

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

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

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

v3oidcpassword: プロジェクトが含まれるドメイン名(password)に置き換えます。 プロジェクトが含まれるドメイン名(v3totp): プロジェクトが含まれるドメイン名(v3oidcclientcredentials): v3tokenlessauth が含まれるプロジェクトが含まれるドメイン名： v3token を含むプロジェクトが含まれるドメイン名： プロジェクトが含まれるドメイン名(v3applicationcredential): プロジェクトが含まれるドメイン名(v3password): プロジェクトが含まれるドメイン名(v3oidcauthcode): プロジェクトが含まれるドメイン名(v3adfspassword): プロジェクトが含まれるドメイン名(v3samlpassword): トークンが含まれるプロジェクトが含まれるドメイン名。 プロジェクトが含まれるドメイン名(v3oidcaccesstoken): プロジェクトが含まれるドメイン名（Env: OS_PROJECT_DOMAIN_NAME）

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

password: trust id With v3totp で、v3oidcpassword: trust id に置き換えます。 v3oidcclientcredentials を使用した信頼 ID: v3token を使用した信頼 ID: v3applicationcredential を使用した信頼 ID: v2password を使用した信頼 ID: v3password を使用した信頼 ID v2token を使用した信頼 ID: v3oidcauthcode を使用する信頼 ID: v3adfspassword を使用した信頼 ID v3samlpassword を使用した信頼 ID: トークンのある信頼 ID: v3oidcaccesstoken を使用した信頼 ID: 信頼 ID（Env: os_TRUST_ID）

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

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

--os-protocol <auth-protocol>

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

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

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

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

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

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

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

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

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

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

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

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

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

--os-username <auth-username>

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

--os-password <auth-password>

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

--os-endpoint <auth-endpoint>

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

--os-token <auth-token>

admin_token: 常に v3token: Token で認証されるトークンで、With v2token: Token With token_endpoint: Token With token: Token to authenticate with token: Token to authenticate(Env: OS_TOKEN)で認証します。

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

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

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

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

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

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

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

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

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

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

--os-passcode <auth-passcode>

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

--os-user <auth-user>

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

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

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

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

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

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

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

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

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

--os-roles <auth-roles>

gnocchi-noauth: ロールのある gnocchi-noauth: ロールのあるロール(Env: OS_ROLES)

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

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

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

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

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

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

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

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

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

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

--os-code <auth-code>

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

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

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

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

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

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

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

--os-url <auth-url>

token_endpoint: 使用する特定のサービスエンドポイント(Env: OS_URL)

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

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