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

选择一个接口 type. valid interface type: [admin, public, internal]. default=public,(Env: OS_INTERFACE)

--os-service-provider <service_provider>

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

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

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

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

如果使用 Keystone-to-rhcs 联邦，在向服务提供商进行身份验证时项目 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

启用可能会更改的 beta 命令

--os-profile hmac-key

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

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

Compute api version, 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>

对象 api 版本，default=1 (env: OS_OBJECT_API_VERSION)

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

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

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

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

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

数据库 api 版本，default=1 (env: OS_DATABASE_API_VERSION)

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

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

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

数据处理 api 版本，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-loadbalancer-api-version <loadbalancer-api-version>

osc 插件 api 版本, default=2.0 (env: OS_LOADBALANCER_API_VERSION)

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

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

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

container-infra api 版本，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 版本现在只支持 1 (env: INSPECTOR_VERSION)。

--inspector-url INSPECTOR_URL

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

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

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

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

DNS api 版本，default=2 (env: os_dns_api_version)

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

barbican api 版本，default=1 (env: OS_KEY_MANAGER_API_VERSION)

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

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

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

queue api version, default=2 (env: OS_ALARMING_API_VERSION)

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

选择身份验证类型。可用类型： v2password, aodh-noauth, v3oidcaccesstoken, token, v3adfspassword, v3token, v3applicationcredential, v3totp, v3oidcauthcode, noauth, v3multifactor, password, v3password, v3oidcclientcredentials, gnocchi-noauth, v3oidcpassword, v2token, gnocchi- basic, v3tokenlessauth, v1password, v3samlpassword, none, v3oauth1, admin_token.默认：根据 --os-username/--os-token (Env: OS_AUTH_TYPE)选择

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

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

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

使用 v2password: trust id with v3oidcaccesstoken: 带有令牌的信任 ID： 带有 v3adfspassword 的信任 ID： 使用 v3token 的信任 ID： 带有 v3applicationcredential 的信任 ID： 带有 v3totp 的信任 ID： 带有 v3oidcauthcode 的信任 ID： 带有 v3multifactor 的信任 ID： 带有密码的信任 ID： 使用 v3password 的信任 ID： 带有 v3oidcclientcredentials 的信任 ID： 带有 v3oidcpassword 的信任 ID： 使用 v2token 的信任 ID： 带有 v3samlpassword 的信任 ID： 信任 ID （Env ： os_TRUST_ID）

--os-username <auth-username>

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

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

使用 v2password: 用户 ID 来使用 aodh- noauth: User ID with v3applicationcredential: User ID with v3totp: User ID with noauth: User ID with password: User id with v3password: User ID with gnocchi-noauth: User ID (Env: OS_USER_ID)

--os-password <auth-password>

使用 v2password: 密码用于 v3adfspassword: Password with password: User's password with v3password: User's password with v3oidcpassword: Password With v1password: Password to use with v3samlpassword: Password (Env: OS_PASSWORD)

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

使用 aodh-noauth: project id with v3oidcaccesstoken: 项目 ID 的范围为具有令牌： 项目 ID 的范围为 v3adfspassword: 项目 ID 的范围为 v3token： 项目 ID 的范围为 v3applicationcredential： 项目 ID 的范围为 v3totp： 项目 ID 的范围为 v3oidcauthcode: 项目 ID 的范围为没有身份验证： 带有 v3multifactor 的项目 ID： 项目 ID 的范围为使用密码： 项目 ID 的范围为 v3password： 项目 ID 的范围为 v3oidcclientcredentials: 项目 ID 的范围为使用 gnocchi-noauth ： 带有 v3oidcpassword 的项目 ID： 项目 ID 的范围为 v3tokenlessauth: 项目 ID 的范围为 v3samlpassword： 范围的项目 ID （Env: os_PROJECT_ID）

--os-roles <auth-roles>

使用 aodh-noauth: 角色，带有 gnocchi-noauth: 角色(Env: OS_ROLES)

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

使用 aodh-noauth: aodh 端点(env: OS_AODH_ENDPOINT)

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

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

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

使用 v3oidcaccesstoken: domain id to scope to with token: 的范围为使用 v3adfspassword 的域 ID： 的范围为 v3token 的域 ID： 域 ID 的范围为 v3applicationcredential： 的范围为 v3 到tp 的域 ID： 的范围为 v3oidcauthcode 的范围 ID： 域 ID 的范围为使用 v3multifactor： 域 ID 的范围为使用密码： 的范围为 v3password 的域 ID： 域 ID 的范围为 v3oidcclientcredentials: 的范围为 v3oidcpassword 的域 ID： 的范围为使用 v3tokenlessauth 的域 ID： 的范围限制为使用 v3samlpassword 的域 ID： 范围到的域 ID （Env ： os_DOMAIN_ID）

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

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

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

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

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

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

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

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

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

使用 v3oidcaccesstoken: 身份供应商的名称，其 v3adfspassword: Identity Provider's name with v3oidcauthcode: Identity Provider's name with v3oidcclientcredentials: Identity Provider's name with v3oidcpassword: Identity Provider's name with v3samlpassword: Identity Provider 的 name (Env: OS_IDENTITY_PROVIDER)

--os-protocol <auth-protocol>

使用 v3oidcaccesstoken: 协议带有 v3adfspassword: 协议 v3oidcauthcode: 协议带有 v3oidcclientcredentials: 协议带有 v3oidcpassword: 协议的联邦插件协议，使用 v3samlpassword: 协议联邦插件(Env: OS_PROTOCOL)

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

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

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

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

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

使用 token：用于 v3 api 和 v2 参数的可选域名。它将用于 v3 中的用户和项目域，并在 v2 身份验证中忽略。使用 password：用于 v3 API 和 v2 参数的可选域名。它将用于 v3 中的用户和项目域，并在 v2 身份验证中忽略。(Env: OS_DEFAULT_DOMAIN_NAME)

--os-token <auth-token>

使用 token: token to authenticate with v3token: Token to with v2token: Token With admin_token: 令牌 With admin_token: the token that be used (Env: OS_TOKEN)

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

使用 v3adfspassword ：一个身份提供程序 url，将发送 SAML 身份验证请求。使用 v3samlpassword ：一个身份提供程序 URL，其中将发送 SAML2 身份验证请求。(Env: OS_IDENTITY_PROVIDER_URL)

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

使用 v3adfspassword: service provider's endpoint (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-user-domain-id <auth-user-domain-id>

使用 v3applicationcredential: 用户的域 ID 带有 v3totp ：用户的域 ID，密码为 password: User's domain id with v3password: User's domain id (Env: OS_USER_DOMAIN_ID)

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

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

--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-passcode <auth-passcode>

使用 v3totp：用户的 totp passcode (env: os_passcode)

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

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

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

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

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

使用 v3oidcauthcode: openid connect 范围，该范围从授权服务器请求。请注意，OpenID Connect 规格指出必须始终指定 "openid"。使用 v3oidcclientcredentials：从授权服务器请求的 OpenID Connect 范围。请注意，OpenID Connect 规格指出必须始终指定 "openid"。使用 v3oidcpassword：从授权服务器请求的 OpenID Connect 范围。请注意，OpenID Connect 规格指出必须始终指定 "openid"。(Env: OS_OPENID_SCOPE)

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

使用 v3oidcauthcode: openid connect provider token Endpoint。请注意，如果通过此选项，则此选项将覆盖发现文档中服务器提供的端点。使用 v3oidcclientcredentials：OpenID Connect Provider Token Endpoint。请注意，如果通过此选项，则此选项将覆盖发现文档中服务器提供的端点。使用 v3oidcpassword: OpenID Connect Provider Token Endpoint。请注意，如果通过此选项，则此选项将覆盖发现文档中服务器提供的端点。(Env: OS_ACCESS_TOKEN_ENDPOINT)

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

使用 v3oidcauthcode: openid connect discovery 文档 URL。发现文档将用于获取访问令牌端点和身份验证端点的值。这个 URL 应该类似带有 v3oidcclientcredentials 的 https://idp.example.org/.well-known/openid- 配置：OpenID Connect Discovery 文档 URL。发现文档将用于获取访问令牌端点和身份验证端点的值。这个 URL 应该类似于使用 v3oidcpassword: OpenID Connect Discovery Document URL 的 https://idp.example.org/.well- known/openid-configuration。发现文档将用于获取访问令牌端点和身份验证端点的值。此 URL 应该类似于 https://idp.example.org/.well- known/openid-configuration (Env: OS_DISCOVERY_ENDPOINT)

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

使用 v3oidcauthcode: oauth 2.0 授权服务器内省令牌类型，它用于决定在处理令牌内省时将使用哪个令牌类型。有效值为："access_token" 或 "id_token" with v3oidcclientcredentials: OAuth 2.0 Authorization Server Introspection 令牌类型，它用于决定在处理令牌内省时使用哪个类型的令牌。有效值为："access_token" 或 "id_token" with v3oidcpassword: OAuth 2.0 Authorization Server Introspection 令牌类型，它用于决定处理令牌内省时将使用哪个类型的令牌。有效值为："access_token" 或 "id_token" (Env: OS_ACCESS_TOKEN_TYPE)

--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-endpoint <auth-endpoint>

使用 noauth: cinder 端点带有 gnocchi-noauth: Gnocchi 端点，带有 gnocchi-basic: Gnocchi 端点，其端点将始终与 admin_token 一起使用：将始终使用的端点(Env: OS_ENDPOINT)

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

使用 v3multifactor：使用方法进行验证。(Env: OS_AUTH_METHODS)

--os-user <auth-user>

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

--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 访问密钥(env: os_access_key)

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

使用 v3oauth1：oauth 访问 secret (env: OS_ACCESS_SECRET)