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

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

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

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

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

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

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

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

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

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

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

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

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

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

--os-data-processing-url OS_DATA_PROCESSING_URL

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

--inspector-api-version INSPECTOR_API_VERSION

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

--inspector-url INSPECTOR_URL

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

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

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

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

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

--os-endpoint <auth-endpoint>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

--os-username <auth-username>

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

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

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

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

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

--os-password <auth-password>

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

--os-token <auth-token>

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

--os-user <auth-user>

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

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

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

--os-protocol <auth-protocol>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

--os-roles <auth-roles>

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

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

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

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

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

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

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

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

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

--os-passcode <auth-passcode>

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

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

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

--os-code <auth-code>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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