第 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=default. (env: OS_DEFAULT_DOMAIN)

--os-interface <interface>

选择一个接口类型。有效的接口类型： [admin, public, internal]. default=public,(Env: OS_INTERFACE)

--os-service-provider <service_provider>

使用 Keystone-to-keystone 联邦在服务提供商上进行身份验证。还必须指定远程项目选项。

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

如果使用 Keystone 到 Keystone 联邦，在向服务提供商进行身份验证时的项目名称。

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

如果使用 Keystone 到 Keystone 联邦，在向服务提供商进行身份验证时的项目 ID。

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

在向服务提供商进行身份验证（如果使用 Keystone 到Keystone 联合）时的域名。

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

在向服务提供商进行身份验证时的项目域 ID （如果使用 Keystone 到 Keystone 联合）。

--timing

print api 调用计时信息

--os-beta-command

启用可能会更改的 beta 命令

--os-profile hmac-key

用于加密性能分析上下文数据的 HMAC 密钥

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

Compute api 版本 default=2.1 (env: OS_COMPUTE_API_VERSION)

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

Identity api version, default=3 (env: OS_IDENTITY_API_VERSION)

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

Image api version, default=2 (env: OS_IMAGE_API_VERSION)

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

Network api version, default=2.0 (env: OS_NETWORK_API_VERSION)

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

Object api version, default=1 (env: OS_OBJECT_API_VERSION)

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

卷 api 版本 default=3 (env: OS_VOLUME_API_VERSION)

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

Metrics api version, default=1 (env: OS_METRICS_API_VERSION)

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

DNS api version, default=2 (env: os_dns_api_version)

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

barbican api version, default=1 (env: OS_KEY_MANAGER_API_VERSION)

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

orchestration api version, default=1 (env: OS_ORCHESTRATION_API_VERSION)

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

osc plugin api version, default=2.0 (env: OS_LOADBALANCER_API_VERSION)

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

Data processing api version, default=1.1 (env: OS_DATA_PROCESSING_API_VERSION)

--os-data-processing-url OS_DATA_PROCESSING_URL

数据处理 api url,(env: OS_DATA_PROCESSING_API_URL)

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

工作流 api 版本 default=2 (env: OS_WORKFLOW_API_VERSION)

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

Database api version, default=1 (env: OS_DATABASE_API_VERSION)

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

共享文件系统 api 版本 default=2.63version 由客户端和服务器支持。(Env: OS_SHARE_API_VERSION)

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

tripleo client api version, default=2 (env: OS_TRIPLEOCLIENT_API_VERSION)

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

Queue api version, default=2 (env: OS_QUEUES_API_VERSION)

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

container-infra api version, default=1 (env: OS_CONTAINER_INFRA_API_VERSION)

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

裸机 api 版本 default="latest" （客户端和服务器支持的最大版本）。(env: OS_BAREMETAL_API_VERSION)

--inspector-api-version INSPECTOR_API_VERSION

现在只支持检查器 api 版本(env: INSPECTOR_VERSION)。

--inspector-url INSPECTOR_URL

检查器 url，默认为 localhost (env: INSPECTOR_URL)。

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

queues api version, default=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, 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>

无：始终与 gnocchi-basic: Gnocchi 端点一起使用的端点，带有 noauth: Cinder 端点（带有 http_basic）：始终使用 gnocchi-noauth: Gnocchi 端点（带有 admin_token 的 Gnocchi 端点）：将始终使用端点(Env: OS_ENDPOINT)

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

使用密码：使用 v3password 进行身份验证 url： 使用 v3token 的身份验证 URL： 使用 v2password 的身份验证 URL： 使用 v3tokenlessauth 的身份验证 URL： 使用 v3oidcpassword 的身份验证 URL： 带有 v3 多因素的身份验证 URL： 使用 v3adfspassword 的身份验证 URL： 使用 v3totp 的身份验证 URL： 使用 v3oidcauthcode 的身份验证 URL： 使用 v3applicationcredential 的身份验证 URL： 使用 v2token 的身份验证 URL： 使用 v3oauth1 的身份验证 URL： 使用 v3oidcclientcredentials 的身份验证 URL： 使用令牌的身份验证 URL： 使用 v3oidcaccesstoken 的身份验证 URL： 使用 v1password 的身份验证 URL： 使用 v3samlpassword 的身份验证 URL： 身份验证 URL （Env: OS_AUTH_URL）

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

使用 password: 使用 v3password 的系统操作的范围： 使用 v3token 的系统操作的范围： 使用 v3oidcpassword 的系统操作范围： 使用 v3multifactor 的系统操作的范围： 使用 v3adfspassword 的系统操作范围： 使用 v3totp 的系统操作的范围： 使用 v3oidcauthcode 的系统操作范围： 使用 v3applicationcredential 的系统操作范围： 使用 v3oidcclientcredentials 的系统操作范围： 使用令牌的系统操作的范围： 使用 v3oidcaccesstoken 的系统操作的范围： 使用 v3samlpassword 的系统操作的范围： 系统操作的范围（Env: os_SYSTEM_SCOPE）

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

使用 password: domain id to scope to with v3password: 使用 v3token 范围的域 ID： 使用 v3tokenlessauth 范围的域 ID： 使用 v3oidcpassword 范围的域 ID： 使用 v3multifactor 的域 ID： 使用 v3adfspassword 范围的域 ID： 使用 v3totp 的范围的域 ID： 使用 v3oidcauthcode 范围的域 ID： 使用 v3applicationcredential 范围的域 ID： 使用 v3oidcclientcredentials 范围的域 ID： 使用令牌范围的域 ID： 使用 v3oidcaccesstoken 范围的域 ID： 使用 v3samlpassword 范围的域 ID： 域 ID 范围为（Env: os_DOMAIN_ID）

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

使用 password: 使用 v3password 的域名： 使用 v3token 范围的域名： 使用 v3tokenlessauth 的域名范围： 使用 v3oidcpassword 范围的域名： 使用 v3multifactor 的域名： 使用 v3adfspassword 的域名范围： 使用 v3totp 的域名范围： 使用 v3oidcauthcode 范围的域名： 使用 v3applicationcredential 的域名范围： 使用 v3oidcclientcredentials 的域名范围： 使用令牌范围的域名： 使用 v3oidcaccesstoken 的域名范围： 使用 v3samlpassword 的域名范围： 范围范围的域名（Env: OS_DOMAIN_NAME）

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

使用 password: project id to scope to with v3password: 使用 v3token 的项目 ID 的范围： 使用 noauth 范围的项目 ID： 带有 v3tokenlessauth 的项目 ID： 使用 v3oidcpassword 范围的项目 ID： 使用 v3multifactor 的项目 ID： 使用 aodh-noauth 的项目 ID 范围： 带有 v3adfspassword 的项目 ID： 使用 v3totp 的项目 ID 范围： 使用 v3oidcauthcode 范围的项目 ID： 使用 v3applicationcredential 的项目 ID： 使用 v3oidcclientcredentials 的项目 ID 范围： 使用 gnocchi-noauth 的项目 ID 范围： 带有令牌的项目 ID： 使用 v3oidcaccesstoken 的项目 ID 范围： 使用 v3samlpassword 的项目 ID 的范围： 项目 ID 的范围为（Env: os_PROJECT_ID）

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

使用 password: 使用 v3password 的项目名称： 使用 v3token 的项目名称： 使用 v3tokenlessauth 的项目名称： 使用 v3oidcpassword 的项目名称： 使用 v3multifactor 的项目名称： 使用 v3adfspassword 的项目名称： 使用 v3totp 的项目名称： 使用 v3oidcauthcode 范围的项目名称： 使用 v3applicationcredential 的项目名称： 使用 v3oidcclientcredentials 的项目名称范围： 使用令牌的项目名称： 使用 v3oidcaccesstoken 的项目名称： 使用 v1password 的项目名称： 用于 v3samlpassword 的 Swift 帐户： 将项目名称范围为（Env: os_PROJECT_NAME）

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

使用 password: 包含 v3password 的项目的域 id ： 包含带有 v3token 的项目的域 ID： 包含带有 v3tokenlessauth 的项目的域 ID： 包含带有 v3oidcpassword 的项目的域 ID： 包含带有 v3 多因素的项目的域 ID： 包含带有 v3adfspassword 的项目的域 ID： 包含带有 v3totp 的项目的域 ID： 包含带有 v3oidcauthcode 的项目的域 ID： 包含带有 v3applicationcredential 的项目的域 ID： 包含带有 v3oidcclientcredentials 的项目的域 ID： 包含带有令牌的项目的域 ID： 包含带有 v3oidcaccesstoken 的项目的域 ID： 包含 v3samlpassword 的项目的域 ID： 包含项目的域 ID （Env: os_PROJECT_DOMAIN_ID）

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

使用密码：包含带有 v3password 的项目的域名： 包含带有 v3token 的项目的域名： 包含带有 v3tokenlessauth 的项目的域名： 包含 v3oidcpassword 的项目的域名： 包含 v3multifactor 的项目的域名： 包含 v3adfspassword 的项目的域名： 包含带有 v3totp 的项目的域名： 包含 v3oidcauthcode 的项目的域名： 包含 v3applicationcredential 的项目的域名： 包含带有 v3oidcclientcredentials 的项目的域名： 包含带有令牌的项目的域名： 包含带有 v3oidcaccesstoken 的项目的域名： 包含 v3samlpassword 的项目的域名： 包含项目的域名（Env: os_PROJECT_DOMAIN_NAME）

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

使用 password: trust id with v3password: trust id with v3token: 使用 v2password 的信任 ID： 带有 v3oidcpassword 的信任 ID： 带有 v3 多因素的信任 ID： 使用 v3adfspassword 的信任 ID： 使用 v3totp 的信任 ID： 使用 v3oidcauthcode 的信任 ID： 使用 v3applicationcredential 的信任 ID： 带有 v2token 的信任 ID： 带有 v3oidcclientcredentials 的信任 ID： 带有令牌的信任 ID： 带有 v3oidcaccesstoken 的信任 ID： 使用 v3samlpassword 的信任 ID： 信任 ID （Env: os_TRUST_ID）

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

使用 password：用于 v3 和 v2 参数的可选域 id。它将用于 v3 中的用户和项目域，并在 v2 身份验证中忽略。使用令牌：用于 v3 和 v2 参数的可选域 ID。它将用于 v3 中的用户和项目域，并在 v2 身份验证中忽略。(Env: OS_DEFAULT_DOMAIN_ID)

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

使用 password：用于 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 v3password: user id with v2password: User ID with noauth: User ID with aodh-noauth: User ID with v3totp: User ID with v3applicationcredential: User ID with gnocchi-noauth: User ID (Env: OS_USER_ID)

--os-username <auth-username>

使用 password: username with v3password: username with v2password: Username to login with v3oidcpassword: Username With v3adfspassword: Username With v3applicationcredential: Username with http_basic: Username With v1password: Username using with v3samlpassword: Username (Env: OS_USERNAME)

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

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

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

使用密码：用户域名的 v3password: User's domain name with v3totp: User's domain name with v3applicationcredential: User's domain name (Env: OS_USER_DOMAIN_NAME)

--os-password <auth-password>

使用 password: password 为 v3password: 用户密码的 v2password: Password to use v3oidcpassword: Password with v3adfspassword: Password with http_basic: User's password with v1password: Password to use with v3samlpassword: Password (Env: OS_PASSWORD)

--os-token <auth-token>

使用 v3token: 令牌与 v2token 进行身份验证： Token with token: Token to with With admin_token: always 使用 admin_token 进行身份验证的令牌(Env: OS_TOKEN)

--os-user <auth-user>

使用 gnocchi-basic: user (env: os_user)

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

使用 v3oidcpassword: 身份提供程序的名称带有 v3adfspassword: Identity Provider's name with v3oidcauthcode: Identity Provider's name With v3oidcclientcredentials: Identity Provider's name With v3oidcaccesstoken: Identity Provider's name with v3samlpassword: Identity Provider's name (Env: OS_IDENTITY_PROVIDER)

--os-protocol <auth-protocol>

使用 v3oidcpassword: 使用 v3adfspassword: 协议进行联邦插件的协议，带有 v3oidcauthcode: federated 插件的联邦插件协议，带有 v3oidcaccesstoken: Protocol for federated plugin with v3samlpassword: Protocol for federated plugin (Env: OS_PROTOCOL)

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

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

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

使用 v3oidcpassword: oauth 2.0 客户端 secret with v3oidcauthcode: OAuth 2.0 Client Secret With v3oidcclientcredentials: OAuth 2.0 Client Secret (Env: OS_CLIENT_SECRET)

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

使用 v3oidcpassword：从授权服务器请求的 openid 连接范围。请注意，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 连接供应商令牌端点。请注意，如果传递了发现文档，这个选项将覆盖发现文档中服务器提供的端点。使用 v3oidcauthcode: OpenID Connect Provider Token Endpoint.请注意，如果传递了发现文档，这个选项将覆盖发现文档中服务器提供的端点。使用 v3oidcclientcredentials: OpenID Connect Provider Token Endpoint。请注意，如果传递了发现文档，这个选项将覆盖发现文档中服务器提供的端点。(env: OS_ACCESS_TOKEN_ENDPOINT)

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

使用 v3oidcpassword: openid connect discovery document URL。发现文档将用于获取访问令牌端点和身份验证端点的值。这个 URL 应该类似于带有 v3oidcauthcode: OpenID Connect Discovery Document URL 的 https://idp.example.org/.well-known/openid- 配置。发现文档将用于获取访问令牌端点和身份验证端点的值。此 URL 应该类似于带有 v3oidcclientcredentials: OpenID Connect Discovery Document URL 的 https://idp.example.org/.well-known/openid- 配置。发现文档将用于获取访问令牌端点和身份验证端点的值。此 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" with v3oidcauthcode: OAuth 2.0 Authorization Server Introspection 令牌类型，它用于决定在处理令牌内省时将使用哪个类型的令牌。有效值为："access_token"或 "id_token" with v3oidcclientcredentials: OAuth 2.0 Authorization Server Introspection 令牌类型，它用于决定在处理令牌内省时将使用哪个类型的令牌。有效值为： "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: roles with gnocchi-noauth: roles (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_IDENTITY_PROVIDER_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 passcode (env: os_passcode)

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

使用 v3oidcauthcode: openid connect redirect url (env: OS_REDIRECT_URI)

--os-code <auth-code>

使用 v3oidcauthcode: oauth 2.0 授权代码(Env: OS_CODE)

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

使用 v3applicationcredential: 应用程序凭证身份验证 secret (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>

使用 v3oauth1：oauth consumer id/key (env: OS_CONSUMER_KEY)

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

使用 v3oauth1 时：oauth consumer secret (env: OS_CONSUMER_SECRET)

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

使用 v3oauth1 时：oauth access key (env: os_access_key)

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

使用 v3oauth1 时：oauth access secret (env: OS_ACCESS_SECRET)

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

使用 v3oidcaccesstoken: oauth 2.0 访问令牌(env: OS_ACCESS_TOKEN)