第 1 章 OpenStack 客户端
openstack
客户端是 OpenStack 命令行界面(CLI)。本章记录了 openstack
版本 3.14.3 的主要选项。:leveloffset: +1
OpenStack API 的命令行界面
使用方法:
值 | 概述 |
---|---|
--inspector-url INSPECTOR_URL | inspector url,默认为 localhost (env: INSPECTOR_URL)。 |
--os-cacert <ca-bundle-file> | CA 证书捆绑包文件(env: os_cacert) |
--os-baremetal-api-version <baremetal-api-version> | 裸机 api 版本 default="latest" (客户端和服务器支持的最大值)。(Env: OS_BAREMETAL_API_VERSION) |
--inspector-api-version INSPECTOR_API_VERSION | inspector api 版本,现在只支持 1 (env: INSPECTOR_VERSION)。 |
--os-redirect-uri <auth-redirect-uri> | 使用 v3oidcauthcode: openid connect redirect url (env: OS_REDIRECT_URI) |
--os-cloud <cloud-config-name> | clouds.yaml 中的云名称(env: os_cloud) |
--os-container-infra-api-version <container-infra-api-version> | Container-infra api version, default=1 (env: OS_CONTAINER_INFRA_API_VERSION) |
--OS-alarming-api-version <alarming-api-version> | Queue api 版本, default=2 (env: OS_ALARMING_API_VERSION) |
--os-user-id <auth-user-id> | 使用 v2password: user ID with v3password: User ID With v3totp: User ID With aodh-noauth: User ID with gnocchi-noauth: User ID with password: User id With v3applicationcredential: User ID (Env: OS_USER_ID) |
-h, --help | 显示帮助信息并退出。 |
--os-project-name <auth-project-name> | 使用 v3adfspassword: project name to scope to with v3password: 要超出使用 v3token 的项目名称: 要使用 v3oidcauthcode 范围的项目名称: 使用 v3samlpassword 范围的项目名称: 要使用 v1 密码的范围的项目名称: 要使用 v3totp 的 Swift 帐户: 要使用 v3tokenlessauth 范围的项目名称: 要使用 v3oidcclientcredentials 的范围的项目名称: 要使用密码的项目名称: 要通过 v3oidcaccesstoken 范围的项目名称: 要使用 v3oidcpassword 范围的项目名称: 要用于使用令牌的项目名称: 要超出使用 v3applicationcredential 的项目名称: 要范围为(Env)的项目名称: os_PROJECT_NAME) |
--os-trust-id <auth-trust-id> | 使用 v2token: trust id with v3adfspassword: trust id With v2password: Trust ID With v3token: Trust ID with v3oidcauthcode: Trust ID with v3samlpassword: Trust ID with v3totp: Trust ID with v3oidc clientcredentials: Trust ID with password: Trust ID with v3oidcaccesstoken: Trust ID with v3oidcpassword: Trust ID with token: Trust ID with v3applicationcredential: Trust ID (Env: os_TRUST_ID) |
--os-identity-api-version <identity-api-version> | Identity api version, default=3 (env: OS_IDENTITY_API_VERSION) |
--os-remote-project-name <remote_project_name> | 使用 Keystoneto-Keystone 联合向服务提供商进行身份验证时的项目名称。 |
--verify | 验证服务器证书(默认) |
--os-remote-project-domain-id <remote_project_domain_id> | 如果使用 Keystone 到Keystone 联合向服务提供商进行身份验证时,项目的域 ID。 |
--os-system-scope <auth-system-scope> | 使用 v3adfspassword:使用 v3password 的系统操作范围: 使用 v3token 进行系统操作范围: 使用 v3oidcauthcode 进行系统操作范围: 使用 v3samlpassword 进行系统操作范围: 使用 v3totp 的系统操作范围: 使用 v3oidcclientcredentials 进行系统操作范围: 使用密码进行系统操作范围: 使用 v3oidcaccesstoken 进行系统操作范围: 使用 v3oidcpassword 进行系统操作范围: 使用令牌的系统操作范围: 使用 v3applicationcredential 进行系统操作范围: 系统操作范围(Env: os_SYSTEM_SCOPE) |
--os-auth-type <auth-type> | 选择 Authentication type. available type: v2token, v3adfspassword, admin_token, v2password, v3password, noauth, v3token, v3oauth1, v3oidcauthcode, v3samlpassword, token_endpoint, v1password, v3totp, aodh-noauth, v3tokenless, v3tokenauth, v3oidcclientcredentials, gnocchi-basic, gnocchi-noauth, password, none, v3oidcaccesstoken, v3oidcpassword, 令牌, v3applicationcredential.默认:根据 --os-username/--os-token (Env: OS_AUTH_TYPE)选定. |
--os-remote-project-domain-name <remote_project_domain_name> | 如果使用 Keystoneto-Keystone 联合向服务提供商进行身份验证时,项目的域名。 |
--os-project-domain-name <auth-project-domain-name> | 使用 v3adfspassword:包含项目使用 v3password 的域名: 包含使用 v3token 的项目的域名: 包含使用 v3oidcauthcode 的项目的域名: 包含使用 v3samlpassword 的项目的域名: 包含使用 v3totp 的项目的域名: 包含使用 v3tokenlessauth 的项目的域名: 包含使用 v3oidcclientcredentials 的项目名称: 包含使用密码的项目的域名: 包含使用 v3oidcaccesstoken 的项目名称: 包含使用 v3oidcpassword 的项目的域名: 包含使用令牌的项目的域名: 包含项目 With v3applicationcredential 的域名: 包含项目的域名(Env: os_PROJECT_DOMAIN_NAME) |
--os-endpoint <auth-endpoint> | 使用 admin_token:通过 gnocchi-basic: Gnocchi 端点带有 gnocchi-noauth: Gnocchi 端点的端点(Env: OS_ENDPOINT)的端点(Env: OS_ENDPOINT) |
--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-aodh-endpoint <auth-aodh-endpoint> | 使用 aodh-noauth: aodh endpoint (env: OS_AODH_ENDPOINT) |
--os-roles <auth-roles> | 使用 aodh-noauth: role with gnocchi-noauth: role (Env: OS_ROLES) |
--os-application-credential-name <auth-application-credential-name> | v3applicationcredential: application credential name (Env: OS_APPLICATION_CREDENTIAL_NAME) |
--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-data-processing-api-version <data-processing-api-version> | Data processing api version, default=1.1 (env: OS_DATA_PROCESSING_API_VERSION) |
--os-service-provider-entity-id <auth-service-provider-entity-id> | 使用 v3adfspassword:服务提供商的 saml 实体 id (Env: OS_SERVICE_PROVIDER_ENTITY_ID) |
--os-access-secret <auth-access-secret> | 使用 v3oauth1: oauth 访问 secret (env: OS_ACCESS_SECRET) |
--os-beta-command | 启用可能更改的 beta 命令 |
--os-orchestration-api-version <orchestration-api-version> | Orchestration api version, default=1 (env: OS_ORCHESTRATION_API_VERSION) |
--os-service-provider-endpoint <auth-service-provider-endpoint> | 使用 v3adfspassword:服务提供商的端点(env: OS_SERVICE_PROVIDER_ENDPOINT) |
--timing | print api 调用时间信息 |
--os-tripleoclient-api-version <tripleoclient-api-version> | tripleo client api version, default=1 (env: OS_TRIPLEOCLIENT_API_VERSION) |
--os-loadbalancer-api-version <loadbalancer-api-version> | osc 插件 api 版本, default=2.0 (env: OS_LOADBALANCER_API_VERSION) |
--os-protocol <auth-protocol> | 使用 v3adfspassword:用于联合插件的协议与 v3oidcauthcode: Protocol for federated 插件使用 v3samlpassword: Protocol for federated 插件使用 v3oidcclientcredentials: Protocol for federated 插件使用 v3oidcaccesstoken: Protocol for federated 插件(Env: OS_PROTOCOL) |
--os-auth-url <auth-auth-url> | 使用 v2token: 使用 v3adfspassword 验证 url: 使用 v2 密码的身份验证 URL: 使用 v3password 的身份验证 URL: 使用 v3token 的身份验证 URL: 使用 v3oauth1 的身份验证 URL: 使用 v3oidcauthcode 的身份验证 URL: 带有 v3samlpassword 的身份验证 URL: 使用 v1 密码的身份验证 URL: 使用 v3totp 验证 URL: 使用 v3tokenlessauth 的身份验证 URL: 使用 v3oidcclientcredentials 的身份验证 URL: 使用密码进行身份验证 URL: 使用 v3oidcaccesstoken 的身份验证 URL: 带有 v3oidcpassword 的身份验证 URL: 使用令牌的身份验证 URL: 使用 v3applicationcredential 的身份验证 URL: 身份验证 URL (Env): OS_AUTH_URL) |
--os-user <auth-user> | 使用 gnocchi-basic: user (env: os_user) |
--os-client-secret <auth-client-secret> | 使用 v3oidcauthcode: oauth 2.0 客户端 secret with v3oidcclientcredentials: OAuth 2.0 Client Secret with v3oidcpassword: OAuth 2.0 Client Secret (Env: OS_CLIENT_SECRET) |
--os-project-domain-id <auth-project-domain-id> | 使用 v3adfspassword:包含带有 v3password 的项目的域 ID: 包含使用 v3token 的项目的域 ID: 使用 v3oidcauthcode 包含项目的域 ID: 包含使用 v3samlpassword 的项目的域 ID: 包含使用 v3totp 的项目的域 ID: 包含使用 v3tokenlessauth 的项目的域 ID: 包含使用 v3oidcclientcredentials 的项目的域 ID: 包含使用密码的项目的域 ID: 包含使用 v3oidcaccesstoken 的项目的域 ID: 包含使用 v3oidcpassword 的项目的域 ID: 包含使用令牌的项目的域 ID: 包含项目的域 ID With v3applicationcredential: 包含项目的域 ID (Env: os_PROJECT_DOMAIN_ID) |
--insecure | 禁用服务器证书验证 |
--os-network-api-version <network-api-version> | Network api version, default=2.0 (env: OS_NETWORK_API_VERSION) |
--os-password <auth-password> | 使用 v3adfspassword: password with v2password: Password to use With v3password: User password with v3samlpassword: Password With v1password: Password with password: User's password with v3oidcpassword: Password (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 consumer secret (env: OS_CONSUMER_SECRET) |
--os-compute-api-version <compute-api-version> | Compute api version, default=2.1 (env: OS_COMPUTE_API_VERSION) |
--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-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> | Queue api 版本, default=2 (env: OS_QUEUES_API_VERSION) |
--os-identity-provider-url <auth-identity-provider-url> | 使用 v3adfspassword:身份提供程序 url,其中将发送 SAML 身份验证请求。使用 v3samlpassword:身份提供程序 URL,其中将发送 SAML2 身份验证请求。(Env: OS_IDENTITY_PROVIDER_URL) |
--os-application-credential-secret <auth-application-credential-secret> | v3applicationcredential: application credential auth secret (Env: OS_APPLICATION_CREDENTIAL_SECRET) |
--os-passcode <auth-passcode> | 使用 v3totp:用户的 totp passcode (env: os_passcode) |
--os-profile hmac-key | 用于加密性能分析上下文数据的 HMAC 密钥 |
--os-domain-id <auth-domain-id> | 使用 v3adfspassword: 域 ID 以范围为 v3password: 使用 v3token 范围的域 ID: 使用 v3oidcauthcode 范围的域 ID: 使用 v3samlpassword 范围的域 ID: 使用 v3totp 范围的域 ID: 使用 v3tokenlessauth 范围的域 ID: 使用 v3oidcclientcredentials 范围的域 ID: 要使用密码范围的域 ID: 要通过 v3oidcaccesstoken 范围的域 ID: 使用 v3oidcpassword 范围的域 ID: 用于使用令牌的域 ID: 要超出使用 v3applicationcredential 的域 ID: 要范围的域 ID (Env): os_DOMAIN_ID) |
--os-discovery-endpoint <auth-discovery-endpoint> | 使用 v3oidcauthcode:openid 连接发现文档 URL。发现文档将用于获取访问令牌端点和验证端点的值。此 URL 应类似于使用 v3oidcclientcredentials: OpenID Connect Discovery 文档 URL 的 https://idp.example.org/.well-known/openid- 配置。发现文档将用于获取访问令牌端点和验证端点的值。这个 URL 应该类似于 https://idp.example.org/.well-known /openid-configuration with v3oidcpassword: 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> | 使用 v3oidcauthcode: oauth 2.0 授权服务器 Introspection 令牌类型,它用于确定处理令牌内省时将使用哪一种令牌类型。有效值为: "access_token" 或 "id_token" with v3oidcclientcredentials: OAuth 2.0 Authorization Server Introspection 令牌类型,它用于确定处理令牌内省时将使用哪些令牌类型。有效值为: "access_token" 或 "id_token" with v3oidcpassword: OAuth 2.0 Authorization Server Introspection 令牌类型,它用于确定处理令牌内省时将使用哪一种令牌类型。Valid values are: "access_token" or "id_token" (Env: OS_ACCESS_TOKEN_TYPE) |
-v, --verbose | 增加输出的详细程度。可以重复。 |
--os-workflow-api-version <workflow-api-version> | workflow api 版本, default=2 (env: OS_WORKFLOW_API_VERSION) |
--os-application-credential-id <auth-application-credential-id> | v3applicationcredential: application credential ID (Env: OS_APPLICATION_CREDENTIAL_ID) |
--os-data-processing-url OS_DATA_PROCESSING_URL | Data processing api url,(env: OS_DATA_PROCESSING_API_URL) |
--os-service-provider <service_provider> | 使用 Keystone-to-keystone 联合在服务提供商上进行验证,并执行 命令。还必须指定远程项目选项。 |
--os-image-api-version <image-api-version> | image api 版本, default=2 (env: OS_IMAGE_API_VERSION) |
--os-user-domain-name <auth-user-domain-name> | 使用 v3password: user 的域名(带有 v3totp: User 的域名 with password: User 的域名 With v3applicationcredential: User 的域名(Env: OS_USER_DOMAIN_NAME) |
--os-remote-project-id <remote_project_id> | 如果使用 Keystoneto-Keystone 联合向服务提供商进行身份验证时项目 ID。 |
--os-key <key-file> | 客户端证书密钥文件(env: os_key) |
--os-identity-provider <auth-identity-provider> | 使用 v3adfspassword: 身份提供程序的名称 with v3oidcauthcode: Identity Provider's name with v3samlpassword: Identity Provider's name with v3oidcclientcredentials: Identity Provider's name with v3oidcaccesstoken: Provider Identity's name with v3oidcpassword: Identity Provider's name (Env_IDENT_ITY) |
--os-user-domain-id <auth-user-domain-id> | 使用 v3password:用户域 ID 带有 v3totp:用户的域 ID with password: User's domain id with v3applicationcredential: User's domain id (Env: OS_USER_DOMAIN_ID) |
--os-default-domain <auth-domain> | 默认域 ID, default=default. (env: OS_DEFAULT_DOMAIN) |
--os-volume-api-version <volume-api-version> | volume api 版本, default=2 (env: OS_VOLUME_API_VERSION) |
--log-file LOG_FILE | 指定要日志输出的文件。默认禁用。 |
--os-access-key <auth-access-key> | With v3oauth1: oauth access key (env: os_access_key) |
--debug | 显示错误的回溯信息。 |
--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-domain-name <auth-domain-name> | 使用 v3adfspassword: 域名以范围为 v3password: 要使用 v3token 范围的域名: 使用 v3oidcauthcode 范围的域名: 使用 v3samlpassword 范围的域名: 要使用 v3totp 范围的域名: 使用 v3tokenlessauth 范围的域名: 要使用 v3oidcclientcredentials 范围的域名: 要使用密码的范围的域名: 要通过 v3oidcaccesstoken 范围的域名: 要使用 v3oidcpassword 范围的域名: 要使用令牌的范围的域名: 要超出使用 v3applicationcredential 的域名: 要范围为(Env)的域名: OS_DOMAIN_NAME) |
--os-project-id <auth-project-id> | 使用 v3adfspassword: project id to scope to with v3password: 要使用 noauth 的范围的项目 ID: 使用 v3token 的项目 ID: 使用 v3oidcauthcode 范围的项目 ID: 使用 v3samlpassword 范围的项目 ID: 使用 v3totp 范围的项目 ID: 使用 aodh-noauth 范围的项目 ID: 使用 v3tokenlessauth 的项目 ID: 使用 v3oidcclientcredentials 范围的项目 ID: 要使用 gnocchi-noauth 范围的项目 ID: 使用密码的项目 ID: 使用 v3oidcaccesstoken 范围的项目 ID: 使用 v3oidcpassword 范围的项目 ID: 要使用令牌的范围的项目 ID: 要使用 v3applicationcredential 的范围的项目 ID: 要范围的项目 ID (Env): os_PROJECT_ID) |
-q, --quiet | 抑制输出,但警告和错误除外。 |
--version | 显示程序的版本号并退出 |
--os-metrics-api-version <metrics-api-version> | Metrics api version, default=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 with v3oidcclientcredentials: OAuth 2.0 Client ID with v3oidcpassword: OAuth 2.0 Client ID (Env: OS_CLIENT_ID) |
--os-token <auth-token> | v2token: 带有 admin_token 的令牌:将始终通过 v3token: Token 使用令牌与 token_endpoint: Authentication 令牌进行身份验证,以便与 token: Token 用于与(Env: OS_TOKEN)进行身份验证。 |
--os-object-api-version <object-api-version> | Object api version, default=1 (env: OS_OBJECT_API_VERSION) |
--os-database-api-version <database-api-version> | Database api version, default=1 (env: OS_DATABASE_API_VERSION) |
--os-consumer-key <auth-consumer-key> | 使用 v3oauth1: oauth consumer id/key (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> | 使用 v3adfspassword: username with v2password: Username to login with v3password: Username With v3samlpassword: Username With v1password: Username with With v3totp: Username with password: Username with v3oidcpassword: Username with v3applicationcredential: Username (Env: OS_USERNAME) |