命令行界面参考


Red Hat OpenStack Platform 16.2

Red Hat OpenStack Platform 的命令行客户端

OpenStack Documentation Team

摘要

对统一的 OpenStack 命令行客户端使用的命令的引用。

使开源包含更多

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。我们从这四个术语开始:master、slave、黑名单和白名单。由于此项工作十分艰巨,这些更改将在即将推出的几个发行版本中逐步实施。详情请查看 CTO Chris Wright 的信息

对红帽文档提供反馈

我们感谢您对文档提供反馈信息。与我们分享您的成功秘诀。

使用直接文档反馈(DDF)功能

使用 添加反馈 DDF 功能,用于特定句子、段落或代码块上的直接注释。

  1. Multi-page HTML 格式查看文档。
  2. 请确定您看到文档右上角的 反馈 按钮。
  3. 用鼠标指针高亮显示您想评论的文本部分。
  4. 添加反馈
  5. 添加反馈项中输入您的意见。
  6. 可选:添加您的电子邮件地址,以便文档团队可以联系您以讨论您的问题。
  7. Submit

第 1 章 OpenStack 客户端

openstack 客户端是一个通用的 OpenStack 命令行界面(CLI)。本章记录了 openstack 版本 4.0.2 的主要选项。

OpenStack API 的命令行界面

使用方法:

openstack [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
                 [--os-cloud <cloud-config-name>]
                 [--os-region-name <auth-region-name>]
                 [--os-cacert <ca-bundle-file>] [--os-cert <certificate-file>]
                 [--os-key <key-file>] [--verify | --insecure]
                 [--os-default-domain <auth-domain>]
                 [--os-interface <interface>]
                 [--os-service-provider <service_provider>]
                 [--os-remote-project-name <remote_project_name> | --os-remote-project-id <remote_project_id>]
                 [--os-remote-project-domain-name <remote_project_domain_name> | --os-remote-project-domain-id <remote_project_domain_id>]
                 [--timing] [--os-beta-command] [--os-profile hmac-key]
                 [--os-compute-api-version <compute-api-version>]
                 [--os-identity-api-version <identity-api-version>]
                 [--os-image-api-version <image-api-version>]
                 [--os-network-api-version <network-api-version>]
                 [--os-object-api-version <object-api-version>]
                 [--os-volume-api-version <volume-api-version>]
                 [--os-queues-api-version <queues-api-version>]
                 [--os-database-api-version <database-api-version>]
                 [--os-tripleoclient-api-version <tripleoclient-api-version>]
                 [--os-data-processing-api-version <data-processing-api-version>]
                 [--os-data-processing-url OS_DATA_PROCESSING_URL]
                 [--os-loadbalancer-api-version <loadbalancer-api-version>]
                 [--os-workflow-api-version <workflow-api-version>]
                 [--os-container-infra-api-version <container-infra-api-version>]
                 [--os-baremetal-api-version <baremetal-api-version>]
                 [--inspector-api-version INSPECTOR_API_VERSION]
                 [--inspector-url INSPECTOR_URL]
                 [--os-orchestration-api-version <orchestration-api-version>]
                 [--os-dns-api-version <dns-api-version>]
                 [--os-key-manager-api-version <key-manager-api-version>]
                 [--os-metrics-api-version <metrics-api-version>]
                 [--os-alarming-api-version <alarming-api-version>]
                 [--os-auth-type <auth-type>] [--os-auth-url <auth-auth-url>]
                 [--os-trust-id <auth-trust-id>]
                 [--os-username <auth-username>] [--os-user-id <auth-user-id>]
                 [--os-password <auth-password>]
                 [--os-project-id <auth-project-id>] [--os-roles <auth-roles>]
                 [--os-aodh-endpoint <auth-aodh-endpoint>]
                 [--os-system-scope <auth-system-scope>]
                 [--os-domain-id <auth-domain-id>]
                 [--os-domain-name <auth-domain-name>]
                 [--os-project-name <auth-project-name>]
                 [--os-project-domain-id <auth-project-domain-id>]
                 [--os-project-domain-name <auth-project-domain-name>]
                 [--os-identity-provider <auth-identity-provider>]
                 [--os-protocol <auth-protocol>]
                 [--os-access-token <auth-access-token>]
                 [--os-default-domain-id <auth-default-domain-id>]
                 [--os-default-domain-name <auth-default-domain-name>]
                 [--os-token <auth-token>]
                 [--os-identity-provider-url <auth-identity-provider-url>]
                 [--os-service-provider-endpoint <auth-service-provider-endpoint>]
                 [--os-service-provider-entity-id <auth-service-provider-entity-id>]
                 [--os-user-domain-id <auth-user-domain-id>]
                 [--os-user-domain-name <auth-user-domain-name>]
                 [--os-application-credential-secret <auth-application-credential-secret>]
                 [--os-application-credential-id <auth-application-credential-id>]
                 [--os-application-credential-name <auth-application-credential-name>]
                 [--os-passcode <auth-passcode>]
                 [--os-client-id <auth-client-id>]
                 [--os-client-secret <auth-client-secret>]
                 [--os-openid-scope <auth-openid-scope>]
                 [--os-access-token-endpoint <auth-access-token-endpoint>]
                 [--os-discovery-endpoint <auth-discovery-endpoint>]
                 [--os-access-token-type <auth-access-token-type>]
                 [--os-redirect-uri <auth-redirect-uri>]
                 [--os-code <auth-code>] [--os-endpoint <auth-endpoint>]
                 [--os-auth-methods <auth-auth-methods>]
                 [--os-user <auth-user>]
                 [--os-consumer-key <auth-consumer-key>]
                 [--os-consumer-secret <auth-consumer-secret>]
                 [--os-access-key <auth-access-key>]
                 [--os-access-secret <auth-access-secret>]

表 1.1. 命令参数
概述

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

第 2 章 access

本章描述了 access 命令下的命令。

2.1. 访问令牌创建

创建访问令牌

使用方法:

openstack access token create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     --consumer-key <consumer-key>
                                     --consumer-secret <consumer-secret>
                                     --request-key <request-key>
                                     --request-secret <request-secret>
                                     --verifier <verifier>

表 2.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--consumer-key <consumer-key>

consumer key (必需)

--consumer-secret <consumer-secret>

消费者 secret (必需)

--request-key <request-key>

请求令牌以交换访问令牌(必需)

--request-secret <request-secret>

与 <request-key> 关联的 secret (必需)

--verifier <verifier>

与 <request-key> 关联的验证器(必需)

表 2.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 2.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 2.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 2.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 3 章 acl

本章描述了 acl 命令下的命令。

3.1. ACL 删除

删除由 href 标识的 secret 或容器的 ACL。

使用方法:

openstack acl delete [-h] URI

表 3.1. positional 参数
概述

URI

secret 或容器的 uri 引用。

表 3.2. 命令参数
概述

-h, --help

显示帮助信息并退出

3.2. ACL 获取

通过提供其 href,检索 secret 或容器的 ACL。

使用方法:

openstack acl get [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                         [--quote {all,minimal,none,nonnumeric}] [--noindent]
                         [--max-width <integer>] [--fit-width] [--print-empty]
                         [--sort-column SORT_COLUMN]
                         URI

表 3.3. positional 参数
概述

URI

secret 或容器的 uri 引用。

表 3.4. 命令参数
概述

-h, --help

显示帮助信息并退出

表 3.5. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 3.6. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 3.7. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 3.8. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

3.3. ACL 提交

根据 href 标识,在 secret 或容器上提交 ACL。

使用方法:

openstack acl submit [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--user [USERS]]
                            [--project-access | --no-project-access]
                            [--operation-type {read}]
                            URI

表 3.9. positional 参数
概述

URI

secret 或容器的 uri 引用。

表 3.10. 命令参数
概述

-h, --help

显示帮助信息并退出

--user [USERS], -u [USERS]

acl 的 Keystone userid。

--project-access

用于启用项目访问行为的标志。

--no-project-access

用于禁用项目访问行为的标志。

--operation-type {read}, -o {read}

为 barbican 操作 acl 设置了 barbican 操作类型

表 3.11. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 3.12. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 3.13. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 3.14. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

3.4. ACL 用户添加

根据 href 标识,将 ACL 用户添加到 secret 或容器中。

使用方法:

openstack acl user add [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN] [--user [USERS]]
                              [--project-access | --no-project-access]
                              [--operation-type {read}]
                              URI

表 3.15. positional 参数
概述

URI

secret 或容器的 uri 引用。

表 3.16. 命令参数
概述

-h, --help

显示帮助信息并退出

--user [USERS], -u [USERS]

acl 的 Keystone userid。

--project-access

用于启用项目访问行为的标志。

--no-project-access

用于禁用项目访问行为的标志。

--operation-type {read}, -o {read}

为 barbican 操作 acl 设置了 barbican 操作类型

表 3.17. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 3.18. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 3.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 3.20. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

3.5. ACL 用户删除

根据 href 标识的 secret 或容器中删除 ACL 用户。

使用方法:

openstack acl user remove [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN] [--user [USERS]]
                                 [--project-access | --no-project-access]
                                 [--operation-type {read}]
                                 URI

表 3.21. positional 参数
概述

URI

secret 或容器的 uri 引用。

表 3.22. 命令参数
概述

-h, --help

显示帮助信息并退出

--user [USERS], -u [USERS]

acl 的 Keystone userid。

--project-access

用于启用项目访问行为的标志。

--no-project-access

用于禁用项目访问行为的标志。

--operation-type {read}, -o {read}

为 barbican 操作 acl 设置了 barbican 操作类型

表 3.23. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 3.24. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 3.25. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 3.26. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 4 章 action

本章描述了 action 命令下的命令。

4.1. 操作定义 create

创建新操作。

使用方法:

openstack action definition create [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          [--marker [MARKER]]
                                          [--limit [LIMIT]]
                                          [--sort_keys [SORT_KEYS]]
                                          [--sort_dirs [SORT_DIRS]]
                                          [--filter FILTERS] [--public]
                                          definition

表 4.1. positional 参数
概述

定义

操作定义文件

表 4.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

上一页的最后执行 uuid 显示在"marker"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

以逗号分隔的排序键列表,按以下方式对结果进行排序。默认: created_at。示例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序方向列表。默认为 asc。示例:mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

filters. 可以重复。

--public

使用这个标志操作,将标记为"public"。

表 4.3. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 4.4. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 4.5. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 4.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

4.2. 操作定义显示

显示操作定义。

使用方法:

openstack action definition definition show [-h] name

表 4.7. positional 参数
概述

name

操作名称

表 4.8. 命令参数
概述

-h, --help

显示帮助信息并退出

4.3. 操作定义删除

删除操作。

使用方法:

openstack action definition delete [-h] action [action ...]

表 4.9. positional 参数
概述

action

操作的名称或 ID。

表 4.10. 命令参数
概述

-h, --help

显示帮助信息并退出

4.4. 操作定义列表

列出所有操作。

使用方法:

openstack action definition list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--marker [MARKER]] [--limit [LIMIT]]
                                        [--sort_keys [SORT_KEYS]]
                                        [--sort_dirs [SORT_DIRS]]
                                        [--filter FILTERS]

表 4.11. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

上一页的最后执行 uuid 显示在"marker"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

以逗号分隔的排序键列表,按以下方式对结果进行排序。默认: created_at。示例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序方向列表。默认为 asc。示例:mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

filters. 可以重复。

表 4.12. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 4.13. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 4.14. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 4.15. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

4.5. 操作定义显示

显示特定的操作。

使用方法:

openstack action definition show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        action

表 4.16. positional 参数
概述

action

操作(名称或 id)

表 4.17. 命令参数
概述

-h, --help

显示帮助信息并退出

表 4.18. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 4.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 4.20. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 4.21. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

4.6. 操作定义更新

更新操作。

使用方法:

openstack action definition update [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          [--marker [MARKER]]
                                          [--limit [LIMIT]]
                                          [--sort_keys [SORT_KEYS]]
                                          [--sort_dirs [SORT_DIRS]]
                                          [--filter FILTERS] [--id ID]
                                          [--public]
                                          definition

表 4.22. positional 参数
概述

定义

操作定义文件

表 4.23. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

上一页的最后执行 uuid 显示在"marker"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

以逗号分隔的排序键列表,按以下方式对结果进行排序。默认: created_at。示例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序方向列表。默认为 asc。示例:mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

filters. 可以重复。

--id ID

操作 ID。

--public

使用这个标志操作,将标记为"public"。

表 4.24. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 4.25. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 4.26. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 4.27. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

4.7. 操作执行删除

删除操作执行。

使用方法:

openstack action execution delete [-h]
                                         action_execution
                                         [action_execution ...]

表 4.28. positional 参数
概述

action_execution

操作执行标识符的 ID。

表 4.29. 命令参数
概述

-h, --help

显示帮助信息并退出

4.8. 操作执行输入显示

显示操作执行输入数据。

使用方法:

openstack action execution input show [-h] id

表 4.30. positional 参数
概述

id

操作执行 ID。

表 4.31. 命令参数
概述

-h, --help

显示帮助信息并退出

4.9. 操作执行列表

列出所有操作执行。

使用方法:

openstack action execution list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--marker [MARKER]] [--limit [LIMIT]]
                                       [--sort_keys [SORT_KEYS]]
                                       [--sort_dirs [SORT_DIRS]]
                                       [--filter FILTERS] [--oldest]
                                       [task_execution_id]

表 4.32. positional 参数
概述

task_execution_id

任务执行 ID。

表 4.33. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

上一页的最后执行 uuid 显示在"marker"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

以逗号分隔的排序键列表,按以下方式对结果进行排序。默认: created_at。示例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序方向列表。默认为 asc。示例:mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

filters. 可以重复。

--oldest

显示从最旧的条目而不是最新的条目开始的执行

表 4.34. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 4.35. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 4.36. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 4.37. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

4.10. 操作执行输出显示

显示 Action 执行输出数据。

使用方法:

openstack action execution output show [-h] id

表 4.38. positional 参数
概述

id

操作执行 ID。

表 4.39. 命令参数
概述

-h, --help

显示帮助信息并退出

4.11. 操作执行运行

创建新的 Action 执行,或只运行特定的操作。

使用方法:

openstack action execution run [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [-s] [--run-sync]
                                      [-t TARGET]
                                      name [input]

表 4.40. positional 参数
概述

name

要执行的操作名称。

输入

操作输入。

表 4.41. 命令参数
概述

-h, --help

显示帮助信息并退出

-s, --save-result

将结果保存到 db 中。

--run-sync

同步运行该操作。

-t TARGET, --target TARGET

操作将在 <target> executor 上执行。

表 4.42. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 4.43. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 4.44. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 4.45. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

4.12. 操作执行显示

显示特定的 Action 执行。

使用方法:

openstack action execution show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       action_execution

表 4.46. positional 参数
概述

action_execution

操作执行 ID。

表 4.47. 命令参数
概述

-h, --help

显示帮助信息并退出

表 4.48. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 4.49. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 4.50. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 4.51. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

4.13. 操作执行更新

更新特定的 Action 执行。

使用方法:

openstack action execution update [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         [--state {PAUSED,RUNNING,SUCCESS,ERROR,CANCELLED}]
                                         [--output OUTPUT]
                                         id

表 4.52. positional 参数
概述

id

操作执行 ID。

表 4.53. 命令参数
概述

-h, --help

显示帮助信息并退出

--state {PAUSED,RUNNING,SUCCESS,ERROR,CANCELLED}

操作执行状态

--output OUTPUT

操作执行输出

表 4.54. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 4.55. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 4.56. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 4.57. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 5 章 address

本章描述了 address 命令下的命令。

5.1. 创建地址范围

创建新地址范围

使用方法:

openstack address scope create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--ip-version {4,6}]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--share | --no-share]
                                      <name>

表 5.1. positional 参数
概述

<name>

新地址范围名称

表 5.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--ip-version {4,6}

IP 版本(默认为 4)

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--share

在项目间共享地址范围

--no-share

不要在项目间共享地址范围(默认)

表 5.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 5.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 5.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 5.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

5.2. 地址范围删除

删除地址范围

使用方法:

openstack address scope delete [-h]
                                      <address-scope> [<address-scope> ...]

表 5.7. positional 参数
概述

<address-scope>

要删除的地址范围(名称或 id)

表 5.8. 命令参数
概述

-h, --help

显示帮助信息并退出

5.3. 地址范围列表

列出地址范围

使用方法:

openstack address scope list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--name <name>]
                                    [--ip-version <ip-version>]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--share | --no-share]

表 5.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

在输出中只列出指定名称的地址范围

--ip-version <ip-version>

列出给定 ip 版本网络(4 或 6)的 地址范围

--project <project>

根据项目(名称或 ID)列出地址范围

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--share

列出项目间共享的地址范围

--no-share

列出项目之间没有共享的地址范围

表 5.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 5.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 5.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 5.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

5.4. 地址范围集

设置地址范围属性

使用方法:

openstack address scope set [-h] [--name <name>] [--share | --no-share]
                                   <address-scope>

表 5.14. positional 参数
概述

<address-scope>

要修改的地址范围(名称或 id)

表 5.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置地址范围名称

--share

在项目间共享地址范围

--no-share

不要在项目间共享地址范围

5.5. 地址范围显示

显示地址范围详情

使用方法:

openstack address scope show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <address-scope>

表 5.16. positional 参数
概述

<address-scope>

要显示的地址范围(名称或 id)

表 5.17. 命令参数
概述

-h, --help

显示帮助信息并退出

表 5.18. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 5.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 5.20. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 5.21. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 6 章 聚合

本章描述了 aggregate 命令下的命令。

6.1. 聚合添加主机

将主机添加到聚合

使用方法:

openstack aggregate add host [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <aggregate> <host>

表 6.1. positional 参数
概述

<aggregate>

聚合(名称或 id)

<host>

要添加到 <aggregate> 的主机

表 6.2. 命令参数
概述

-h, --help

显示帮助信息并退出

表 6.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 6.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 6.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 6.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

6.2. 聚合创建

创建新聚合

使用方法:

openstack aggregate create [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--zone <availability-zone>]
                                  [--property <key=value>]
                                  <name>

表 6.7. positional 参数
概述

<name>

新聚合名称

表 6.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--zone <availability-zone>

可用区名称

--property <key=value>

要添加到此聚合的属性(重复选项来设置多个属性)

表 6.9. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 6.10. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 6.11. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 6.12. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

6.3. 聚合删除

删除现有的聚合

使用方法:

openstack aggregate delete [-h] <aggregate> [<aggregate> ...]

表 6.13. positional 参数
概述

<aggregate>

要删除的聚合(名称或 id)

表 6.14. 命令参数
概述

-h, --help

显示帮助信息并退出

6.4. 聚合列表

列出所有聚合

使用方法:

openstack aggregate list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--noindent] [--max-width <integer>]
                                [--fit-width] [--print-empty]
                                [--sort-column SORT_COLUMN] [--long]

表 6.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 6.16. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 6.17. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 6.18. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 6.19. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

6.5. 聚合删除主机

从聚合中删除主机

使用方法:

openstack aggregate remove host [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <aggregate> <host>

表 6.20. positional 参数
概述

<aggregate>

聚合(名称或 id)

<host>

要从 <aggregate> 中删除的主机

表 6.21. 命令参数
概述

-h, --help

显示帮助信息并退出

表 6.22. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 6.23. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 6.24. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 6.25. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

6.6. 聚合集

设置聚合属性

使用方法:

openstack aggregate set [-h] [--name <name>]
                               [--zone <availability-zone>]
                               [--property <key=value>] [--no-property]
                               <aggregate>

表 6.26. positional 参数
概述

<aggregate>

要修改的聚合(名称或 id)

表 6.27. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置聚合名称

--zone <availability-zone>

设置可用区名称

--property <key=value>

要在 <aggregate> 上设置的属性(用于设置多个属性)

--no-property

从 <aggregate> 中删除所有属性(指定 --property 和 --no-property 来覆盖当前属性)

6.7. 聚合显示

显示聚合详情

使用方法:

openstack aggregate show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                <aggregate>

表 6.28. positional 参数
概述

<aggregate>

要显示的聚合(名称或 id)

表 6.29. 命令参数
概述

-h, --help

显示帮助信息并退出

表 6.30. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 6.31. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 6.32. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 6.33. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

6.8. 聚合未设置

取消设置聚合属性

使用方法:

openstack aggregate unset [-h] [--property <key>] <aggregate>

表 6.34. positional 参数
概述

<aggregate>

要修改的聚合(名称或 id)

表 6.35. 命令参数
概述

-h, --help

显示帮助信息并退出

--property <key>

从聚合中删除的属性(重复选项来删除多个属性)

第 7 章 警报

本章描述了 警报 命令下的命令。

7.1. 警告创建

创建警报

使用方法:

openstack alarm create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] --name <NAME> -t <TYPE>
                              [--project-id <PROJECT_ID>]
                              [--user-id <USER_ID>]
                              [--description <DESCRIPTION>] [--state <STATE>]
                              [--severity <SEVERITY>] [--enabled {True|False}]
                              [--alarm-action <Webhook URL>]
                              [--ok-action <Webhook URL>]
                              [--insufficient-data-action <Webhook URL>]
                              [--time-constraint <Time Constraint>]
                              [--repeat-actions {True|False}]
                              [--query <QUERY>]
                              [--comparison-operator <OPERATOR>]
                              [--evaluation-periods <EVAL_PERIODS>]
                              [--threshold <THRESHOLD>]
                              [--event-type <EVENT_TYPE>]
                              [--granularity <GRANULARITY>]
                              [--aggregation-method <AGGR_METHOD>]
                              [--metric <METRIC>]
                              [--resource-type <RESOURCE_TYPE>]
                              [--resource-id <RESOURCE_ID>]
                              [--composite-rule <COMPOSITE_RULE>]

表 7.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

-t <TYPE>, --type <TYPE>

警报类型,应该是:event、comp、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold 之一。

--project-id <PROJECT_ID>

与警报关联的项目(仅可由管理员用户配置)

--user-id <USER_ID>

用户与警报关联(仅可由管理员用户配置)

--description <DESCRIPTION>

警报的自由文本描述

--state <STATE>

警报的状态,其中一个: [ok, alert, data]

--severity <SEVERITY>

警报的严重性,其中之一为: [low,moderate,critical]

--enabled {True|False}

如果启用了警报评估,则为 true

--sqlserver-action <Webhook URL>

当状态转换为警报时调用的 URL。可能会多次使用

--OK-action <Webhook URL>

当状态转换为 ok 时调用的 URL。可能会多次使用

--insufficient-data-action <Webhook URL>

当状态转换为数据不足时调用的 URL。可以多次使用

--time-constraint <Time Constraint>

仅在评估时评估警报在此时间约束中。约束的起点使用 cron 表达式指定,其持续时间以秒为单位。对于多个时间约束,可以多次指定时间限制,格式为: name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]]

--repeat-actions {True|False}

如果在警报处于目标状态时应重复通知,则为 true

表 7.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 7.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 7.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 7.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

表 7.6. 常见警报规则
概述

--query <QUERY>

对于类型 event: key[op]data_type::value 的警报;list.data_type 是可选的,但如果提供,必须是 string、整数、float 或 boolean。对于类型为 gnocchi_aggregation_by_resources_threshold 的警报:需要指定一个复杂的查询 json 字符串,例如: {"and": [{"=": {"ended_at": null}}, …​]}。

--comparison-operator <OPERATOR>

要比较的运算符,其中一个: [lt,le,eq,ne,ge,gt]

--evaluation-periods <EVAL_PERIODS>

要评估的周期数

--threshold <THRESHOLD>

要评估的阈值。

表 7.7. 事件警告
概述

--event-type <EVENT_TYPE>

要评估的事件类型

表 7.8. 常见 gnocchi 警报规则
概述

--granularity <GRANULARITY>

要查询的时间范围(以秒为单位)。

--aggregation-method <AGR_METHOD>

与阈值相比的 aggregate_method。

--metric <METRIC>, --metrics <METRIC>

指标 ID 或名称,具体取决于警报类型

表 7.9. gnocchi 资源阈值警报
概述

--resource-type <RESOURCE_TYPE>

资源类型。

--resource-id <RESOURCE_ID>

资源的 id。

表 7.10. 复合警报
概述

--composite-rule <COMPOSITE_RULE>

带有 json 格式的复合阈值规则,形式可以是嵌套的字典,它将 gnocchi 规则组合为 "and", "or"。例如,表单类似: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}。

7.2. 警告删除

删除警报

使用方法:

openstack alarm delete [-h] [--name <NAME>] [<ALARM ID or NAME>]

表 7.11. positional 参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

表 7.12. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

7.4. alert-history show

显示警报的历史记录

使用方法:

openstack alarm-history show [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--limit <LIMIT>] [--marker <MARKER>]
                                    [--sort <SORT_KEY:SORT_DIR>]
                                    <alarm-id>

表 7.18. positional 参数
概述

<alarm-id>

警报 ID

表 7.19. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit <LIMIT>

要返回的资源数量(默认为服务器默认)

--marker <MARKER>

上一个列表的最后一项。在此值后返回下一个结果,支持的标记是 event_id。

--sort <SORT_KEY:SORT_DIR>

资源属性的排序,如 timestamp:desc

表 7.20. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 7.21. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 7.22. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 7.23. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

7.5. 警报列表

列出警报

使用方法:

openstack alarm list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--query QUERY | --filter <KEY1=VALUE1;KEY2=VALUE2...>]
                            [--limit <LIMIT>] [--marker <MARKER>]
                            [--sort <SORT_KEY:SORT_DIR>]

表 7.24. 命令参数
概述

-h, --help

显示帮助信息并退出

--query QUERY

由 aodh 支持的丰富的查询,如 project_id!=my-id user_id=foo 或 user_id=bar

--filter <KEY1=VALUE1;KEY2=VALUE2…​>

过滤要在返回的警报上应用的参数。

--limit <LIMIT>

要返回的资源数量(默认为服务器默认)

--marker <MARKER>

上一次列表的最后一项。在此值后返回下一个结果,支持的标记是 alert_id。

--sort <SORT_KEY:SORT_DIR>

资源属性的排序,如 name:asc

表 7.25. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 7.26. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 7.27. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 7.28. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

7.6. 警报显示

显示警报

使用方法:

openstack alarm show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--name <NAME>]
                            [<ALARM ID or NAME>]

表 7.29. positional 参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

表 7.30. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

表 7.31. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 7.32. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 7.33. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 7.34. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

7.7. 警报状态 get

获取警报的状态

使用方法:

openstack alarm state get [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--name <NAME>]
                                 [<ALARM ID or NAME>]

表 7.35. positional 参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

表 7.36. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

表 7.37. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 7.38. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 7.39. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 7.40. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

7.8. 警报状态集

设置警报的状态

使用方法:

openstack alarm state set [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--name <NAME>] --state
                                 <STATE>
                                 [<ALARM ID or NAME>]

表 7.41. positional 参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

表 7.42. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

--state <STATE>

警报的状态,其中一个: [ok, alert, data]

表 7.43. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 7.44. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 7.45. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 7.46. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

7.9. 警告更新

更新警报

使用方法:

openstack alarm update [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--name <NAME>] [-t <TYPE>]
                              [--project-id <PROJECT_ID>]
                              [--user-id <USER_ID>]
                              [--description <DESCRIPTION>] [--state <STATE>]
                              [--severity <SEVERITY>] [--enabled {True|False}]
                              [--alarm-action <Webhook URL>]
                              [--ok-action <Webhook URL>]
                              [--insufficient-data-action <Webhook URL>]
                              [--time-constraint <Time Constraint>]
                              [--repeat-actions {True|False}]
                              [--query <QUERY>]
                              [--comparison-operator <OPERATOR>]
                              [--evaluation-periods <EVAL_PERIODS>]
                              [--threshold <THRESHOLD>]
                              [--event-type <EVENT_TYPE>]
                              [--granularity <GRANULARITY>]
                              [--aggregation-method <AGGR_METHOD>]
                              [--metric <METRIC>]
                              [--resource-type <RESOURCE_TYPE>]
                              [--resource-id <RESOURCE_ID>]
                              [--composite-rule <COMPOSITE_RULE>]
                              [<ALARM ID or NAME>]

表 7.47. positional 参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

表 7.48. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

-t <TYPE>, --type <TYPE>

警报类型,应该是:event、comp、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold 之一。

--project-id <PROJECT_ID>

与警报关联的项目(仅可由管理员用户配置)

--user-id <USER_ID>

用户与警报关联(仅可由管理员用户配置)

--description <DESCRIPTION>

警报的自由文本描述

--state <STATE>

警报的状态,其中一个: [ok, alert, data]

--severity <SEVERITY>

警报的严重性,其中之一为: [low,moderate,critical]

--enabled {True|False}

如果启用了警报评估,则为 true

--sqlserver-action <Webhook URL>

当状态转换为警报时调用的 URL。可能会多次使用

--OK-action <Webhook URL>

当状态转换为 ok 时调用的 URL。可能会多次使用

--insufficient-data-action <Webhook URL>

当状态转换为数据不足时调用的 URL。可以多次使用

--time-constraint <Time Constraint>

仅在评估时评估警报在此时间约束中。约束的起点使用 cron 表达式指定,其持续时间以秒为单位。对于多个时间约束,可以多次指定时间限制,格式为: name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]]

--repeat-actions {True|False}

如果在警报处于目标状态时应重复通知,则为 true

表 7.49. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 7.50. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 7.51. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 7.52. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

表 7.53. 常见警报规则
概述

--query <QUERY>

对于类型 event: key[op]data_type::value 的警报;list.data_type 是可选的,但如果提供,必须是 string、整数、float 或 boolean。对于类型为 gnocchi_aggregation_by_resources_threshold 的警报:需要指定一个复杂的查询 json 字符串,例如: {"and": [{"=": {"ended_at": null}}, …​]}。

--comparison-operator <OPERATOR>

要比较的运算符,其中一个: [lt,le,eq,ne,ge,gt]

--evaluation-periods <EVAL_PERIODS>

要评估的周期数

--threshold <THRESHOLD>

要评估的阈值。

表 7.54. 事件警告
概述

--event-type <EVENT_TYPE>

要评估的事件类型

表 7.55. 常见 gnocchi 警报规则
概述

--granularity <GRANULARITY>

要查询的时间范围(以秒为单位)。

--aggregation-method <AGR_METHOD>

与阈值相比的 aggregate_method。

--metric <METRIC>, --metrics <METRIC>

指标 ID 或名称,具体取决于警报类型

表 7.56. gnocchi 资源阈值警报
概述

--resource-type <RESOURCE_TYPE>

资源类型。

--resource-id <RESOURCE_ID>

资源的 id。

表 7.57. 复合警报
概述

--composite-rule <COMPOSITE_RULE>

带有 json 格式的复合阈值规则,形式可以是嵌套的字典,它将 gnocchi 规则组合为 "and", "or"。例如,表单类似: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}。

第 8 章 警告

本章描述了警告命令下的 命令

8.1. 警告能力列表

列出警告服务的功能

使用方法:

openstack alarming capabilities list [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]

表 8.1. 命令参数
概述

-h, --help

显示帮助信息并退出

表 8.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 8.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 8.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 8.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 9 章 application

本章描述了 应用程序 命令下的命令。

9.1. 应用程序凭证创建

创建新应用程序凭证

使用方法:

openstack application credential create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--secret <secret>]
                                               [--role <role>]
                                               [--expiration <expiration>]
                                               [--description <description>]
                                               [--unrestricted] [--restricted]
                                               <name>

表 9.1. positional 参数
概述

<name>

应用程序凭证的名称

表 9.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--secret <secret>

用于身份验证的 secret (如果没有提供,将生成一个)

--role <role>

要授权(名称或 id)的角色(重复选项来设置多个值)

--expiration <expiration>

为应用程序凭证设置过期日期,格式为 YYYY-mm-ddTHH:MM:SS (如果不提供,应用程序凭证不会过期)

--description <description>

应用程序凭证描述

--unrestricted

启用应用程序凭证来创建和删除其他应用程序凭证和信任(这可能是危险的行为,默认是禁用的)

--restricted

禁止应用程序凭证创建和删除其他应用程序凭证和信任(这是默认行为)

表 9.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 9.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 9.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 9.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

9.2. 应用程序凭证删除

删除应用程序凭证

使用方法:

openstack application credential delete [-h]
                                               <application-credential>
                                               [<application-credential> ...]

表 9.7. positional 参数
概述

<application-credential>

要删除的应用程序凭证(名称或 id)

表 9.8. 命令参数
概述

-h, --help

显示帮助信息并退出

9.3. 应用程序凭证列表

列出应用程序凭证

使用方法:

openstack application credential list [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--noindent]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--sort-column SORT_COLUMN]
                                             [--user <user>]
                                             [--user-domain <user-domain>]

表 9.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--user <user>

要列出的应用程序凭证的用户(名称或 ID)

--user-domain <user-domain>

用户所属的域(名称或 id)。这可用于在用户名之间存在冲突时使用。

表 9.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 9.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 9.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 9.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

9.4. 应用程序凭证显示

显示应用程序凭证详情

使用方法:

openstack application credential show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <application-credential>

表 9.14. positional 参数
概述

<application-credential>

要显示的应用程序凭证(名称或 id)

表 9.15. 命令参数
概述

-h, --help

显示帮助信息并退出

表 9.16. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 9.17. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 9.18. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 9.19. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 10 章 可用性

本章描述了 availability 命令下的命令。

10.1. 可用区列表

列出可用区及其状态

使用方法:

openstack availability zone list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--compute] [--network] [--volume]
                                        [--long]

表 10.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--compute

列出计算可用区

--network

列出网络可用区

--volume

列出卷可用区

--long

列出输出中的其他字段

表 10.2. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 10.3. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 10.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 10.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 11 章 baremetal

本章描述了 baremetal 命令下的命令。

11.1. 裸机分配创建

创建新的 baremetal 分配。

使用方法:

openstack baremetal allocation create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--resource-class RESOURCE_CLASS]
                                             [--trait TRAITS]
                                             [--candidate-node CANDIDATE_NODES]
                                             [--name NAME] [--uuid UUID]
                                             [--extra <key=value>]
                                             [--wait [<time-out>]]
                                             [--node NODE]

表 11.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--resource-class RESOURCE_CLASS

要请求的资源类。

--trait TRAITS

用于请求的特征。可多次指定。

--candidate-node CANDIDATE_NODES

此分配的候选节点。可以多次指定。如果至少指定了一个,则只有提供的候选节点被视为分配。

--name NAME

分配的唯一名称。

--UUID UUID

分配的 UUID。

--extra <key=value>

记录任意键/值元数据。可以多次指定。

--wait [<time-out>]

等待新分配变为活动状态。如果分配失败并且使用了 --wait,则返回错误。(可选)使用超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

--node NODE

从已部署的节点中回填此分配。绕过正常的分配过程。

表 11.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.2. 裸机分配删除

取消分配裸机。

使用方法:

openstack baremetal allocation delete [-h]
                                             <allocation> [<allocation> ...]

表 11.6. positional 参数
概述

<allocation>

要删除的分配(名称或 uuid)。

表 11.7. 命令参数
概述

-h, --help

显示帮助信息并退出

11.3. 裸机分配列表

列出裸机分配。

使用方法:

openstack baremetal allocation list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           [--limit <limit>]
                                           [--marker <allocation>]
                                           [--sort <key>[:<direction>]]
                                           [--node <node>]
                                           [--resource-class <resource_class>]
                                           [--state <state>]
                                           [--long | --fields <field> [<field> ...]]

表 11.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

每个请求返回的最大分配数,0 代表没有限制。默认是 Baremetal API Service 使用的最大数量。

--marker <allocation>

分配 uuid (例如,上一个请求列表中的最后一个分配)。在该 UUID 后返回分配列表。

--sort <key>[:<direction>]

根据指定的分配字段和方向(asc 或 desc)对输出进行排序(默认为 asc)。可以指定多个字段和方向,用逗号分开。

--node <node>

仅列出此节点的分配(name 或 uuid)。

--resource-class <resource_class>

仅列出此资源类型的分配。

--state <state>

仅列出处于此状态的分配。

--long

显示有关分配的详细信息。

--fields <field> [<field> …​]

一个或多个分配字段。只有这些字段将从服务器获取。指定 -- long 时无法使用。

表 11.9. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.10. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.11. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.12. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.4. 裸机分配集

设置裸机分配属性。

使用方法:

openstack baremetal allocation set [-h] [--name <name>]
                                          [--extra <key=value>]
                                          <allocation>

表 11.13. positional 参数
概述

<allocation>

分配的名称或 uuid

表 11.14. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置分配的名称

--extra <key=value>

在此分配上设置的额外属性(重复选项来设置多个额外属性)

11.5. 裸机分配显示

显示裸机分配详情。

使用方法:

openstack baremetal allocation show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--fields <field> [<field> ...]]
                                           <id>

表 11.15. positional 参数
概述

<id>

分配的 UUID 或名称

表 11.16. 命令参数
概述

-h, --help

显示帮助信息并退出

--fields <field> [<field> …​]

一个或多个分配字段。只有这些字段将从服务器获取。

表 11.17. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.18. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.19. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.20. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.6. 裸机分配未设置

取消设置 baremetal 分配属性。

使用方法:

openstack baremetal allocation unset [-h] [--name] [--extra <key>]
                                            <allocation>

表 11.21. positional 参数
概述

<allocation>

分配的名称或 uuid

表 11.22. 命令参数
概述

-h, --help

显示帮助信息并退出

--name

取消设置分配名称

--extra <key>

在此裸机分配时取消设置的额外属性(需要取消设置多个额外属性)。

11.7. baremetal chassis create

创建新的机箱。

使用方法:

openstack baremetal chassis create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--description <description>]
                                          [--extra <key=value>]
                                          [--uuid <uuid>]

表 11.23. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

机箱的描述

--extra <key=value>

记录任意键/值元数据。可以多次指定。

--uuid <uuid>

机箱的唯一 uuid

表 11.24. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.25. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.26. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.27. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.8. baremetal chassis delete

删除机箱。

使用方法:

openstack baremetal chassis delete [-h] <chassis> [<chassis> ...]

表 11.28. positional 参数
概述

<chassis>

要删除的 chassis 的 UUID

表 11.29. 命令参数
概述

-h, --help

显示帮助信息并退出

11.9. baremetal chassis list

列出机箱。

使用方法:

openstack baremetal chassis list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--fields <field> [<field> ...]]
                                        [--limit <limit>] [--long]
                                        [--marker <chassis>]
                                        [--sort <key>[:<direction>]]

表 11.30. 命令参数
概述

-h, --help

显示帮助信息并退出

--fields <field> [<field> …​]

一个或多个 chassis 字段。只有这些字段将从服务器获取。指定 --long 时无法使用。

--limit <limit>

每个请求返回的最大机箱数,0 代表没有限制。默认是 Baremetal API Service 使用的最大数量。

--long

显示有关机箱的详细信息

--marker <chassis>

机箱 uuid (例如,上一个请求列表中的最后一个机箱)。在该 UUID 后返回机箱列表。

--sort <key>[:<direction>]

由指定的 chassis 字段和方向(asc 或 desc)排序输出(默认为 asc)。可以指定多个字段和方向,用逗号分开。

表 11.31. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.32. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.33. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.34. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.10. baremetal chassis set

设置机箱属性。

使用方法:

openstack baremetal chassis set [-h] [--description <description>]
                                       [--extra <key=value>]
                                       <chassis>

表 11.35. positional 参数
概述

<chassis>

机箱的 UUID

表 11.36. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

设置机箱的描述

--extra <key=value>

在这个机箱上设置额外的设置(需要设置多个额外选项)

11.11. 裸机机箱显示

显示机箱详情。

使用方法:

openstack baremetal chassis show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--fields <field> [<field> ...]]
                                        <chassis>

表 11.37. positional 参数
概述

<chassis>

机箱的 UUID

表 11.38. 命令参数
概述

-h, --help

显示帮助信息并退出

--fields <field> [<field> …​]

一个或多个 chassis 字段。只有这些字段将从服务器获取。

表 11.39. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.40. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.41. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.42. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.12. baremetal chassis unset

取消设置机箱属性。

使用方法:

openstack baremetal chassis unset [-h] [--description] [--extra <key>]
                                         <chassis>

表 11.43. positional 参数
概述

<chassis>

机箱的 UUID

表 11.44. 命令参数
概述

-h, --help

显示帮助信息并退出

--description

清除 chassis 描述

--extra <key>

在这个机箱上取消设置的额外选项(用于取消设置多个额外的选项)

11.13. 裸机编排器列表

列出裸机编排器

使用方法:

openstack baremetal conductor list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          [--limit <limit>]
                                          [--marker <conductor>]
                                          [--sort <key>[:<direction>]]
                                          [--long | --fields <field> [<field> ...]]

表 11.45. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

每个请求返回的最大编排器数,0 代表没有限制。默认是 Baremetal API Service 使用的最大数量。

--marker <conductor>

编排器的主机名(例如,上一请求列表中的最后一个编排器)。在此编排器后返回编排器列表。

--sort <key>[:<direction>]

由指定的编排器字段和方向(asc 或 desc)排序输出(默认为 asc)。可以指定多个字段和方向,用逗号分开。

--long

显示有关编排器的详细信息。

--fields <field> [<field> …​]

一个或多个编排器字段。只有这些字段将从服务器获取。指定 -- long 时无法使用。

表 11.46. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.47. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.48. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.49. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.14. 裸机编排器显示

显示裸机编排器详情

使用方法:

openstack baremetal conductor show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--fields <field> [<field> ...]]
                                          <conductor>

表 11.50. positional 参数
概述

<conductor>

编排器的主机名

表 11.51. 命令参数
概述

-h, --help

显示帮助信息并退出

--fields <field> [<field> …​]

一个或多个编排器字段。只有这些字段将从服务器获取。

表 11.52. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.53. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.54. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.55. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.15. baremetal create

从文件创建资源

使用方法:

openstack baremetal create [-h] <file> [<file> ...]

表 11.56. positional 参数
概述

<file>

包含要创建的资源描述的文件(.yaml 或 .json)。可多次指定。

表 11.57. 命令参数
概述

-h, --help

显示帮助信息并退出

11.16. 裸机部署模板创建

创建新部署模板

使用方法:

openstack baremetal deploy template create [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--uuid <uuid>]
                                                  [--extra <key=value>]
                                                  --steps <steps>
                                                  <name>

表 11.58. positional 参数
概述

<name>

此部署模板的唯一名称。必须是有效的特征名称

表 11.59. 命令参数
概述

-h, --help

显示帮助信息并退出

--uuid <uuid>

部署模板的 UUID。

--extra <key=value>

记录任意键/值元数据。可以多次指定。

--steps <steps>

部署步骤可以是 json 格式的部署步骤。可以是包含部署步骤的文件的路径; OR -,带有从标准输入读取的部署步骤 ; 或字符串。该值应该是部署步骤字典的列表;每个字典都应该具有键 接口步骤 argspriority

表 11.60. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.61. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.62. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.63. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.17. 裸机部署模板删除

删除部署模板。

使用方法:

openstack baremetal deploy template delete [-h]
                                                  <template> [<template> ...]

表 11.64. positional 参数
概述

<template>

要删除的部署模板的名称或 uuid。

表 11.65. 命令参数
概述

-h, --help

显示帮助信息并退出

11.18. 裸机部署模板列表

列出裸机部署模板。

使用方法:

openstack baremetal deploy template list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--noindent]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                [--limit <limit>]
                                                [--marker <template>]
                                                [--sort <key>[:<direction>]]
                                                [--long | --fields <field> [<field> ...]]

表 11.66. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

每个请求返回的最大部署模板数,0 代表没有限制。默认是 Baremetal API Service 使用的最大数量。

--marker <template>

DeployTemplate uuid (例如,上一请求列表中的最后一个部署模板)。在此 UUID 后返回部署模板列表。

--sort <key>[:<direction>]

通过指定的部署模板字段和指示(asc 或 desc)对输出进行排序(默认为 asc)。可以指定多个字段和方向,用逗号分开。

--long

显示有关部署模板的详细信息。

--fields <field> [<field> …​]

一个或多个部署模板字段。只有这些字段将从服务器获取。指定 --long 时无法使用。

表 11.67. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.68. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.69. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.70. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.19. 裸机部署模板集

设置 baremetal 部署模板属性。

使用方法:

openstack baremetal deploy template set [-h] [--name <name>]
                                               [--steps <steps>]
                                               [--extra <key=value>]
                                               <template>

表 11.71. positional 参数
概述

<template>

部署模板的名称或 uuid

表 11.72. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置部署模板的唯一名称。必须是有效的特征名称。

--steps <steps>

部署步骤可以是 json 格式的部署步骤。可以是包含部署步骤的文件的路径; OR -,带有从标准输入读取的部署步骤 ; 或字符串。该值应该是部署步骤字典的列表;每个字典都应该具有键 接口步骤 argspriority

--extra <key=value>

在这个 baremetal 部署模板上设置额外的设置(需要设置多个额外选项)。

11.20. 裸机部署模板显示

显示裸机部署模板详情。

使用方法:

openstack baremetal deploy template show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--fields <field> [<field> ...]]
                                                <template>

表 11.73. positional 参数
概述

<template>

部署模板的名称或 uuid。

表 11.74. 命令参数
概述

-h, --help

显示帮助信息并退出

--fields <field> [<field> …​]

一个或多个部署模板字段。只有这些字段将从服务器获取。

表 11.75. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.76. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.77. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.78. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.21. 裸机部署模板未设置

取消设置 baremetal 部署模板属性。

使用方法:

openstack baremetal deploy template unset [-h] [--extra <key>]
                                                 <template>

表 11.79. positional 参数
概述

<template>

部署模板的名称或 uuid

表 11.80. 命令参数
概述

-h, --help

显示帮助信息并退出

--extra <key>

在这个 baremetal 部署模板上取消设置的额外设置(需要为取消设置多个额外选项)。

11.22. 裸机驱动程序列表

列出启用的驱动程序。

使用方法:

openstack baremetal driver list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--type <type>] [--long]

表 11.81. 命令参数
概述

-h, --help

显示帮助信息并退出

--type <type>

驱动程序类型("classic"或"dynamic")。默认是列出所有驱动程序。

--long

显示有关驱动程序的详细信息。

表 11.82. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.83. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.84. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.85. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.23. baremetal 驱动程序传递调用

调用某个驱动程序的供应商传递方法。

使用方法:

openstack baremetal driver passthru call [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--arg <key=value>]
                                                [--http-method <http-method>]
                                                <driver> <method>

表 11.86. positional 参数
概述

<driver>

驱动程序的名称。

<method>

要调用厂商传递方法。

表 11.87. 命令参数
概述

-h, --help

显示帮助信息并退出

--arg <key=value>

传递给 passthru 方法的参数(重复选项以指定多个参数)。

--http-method <http-method>

在 passthru 请求中使用的 http 方法。一个 DELETE、GET、PATCH、POST、PUT。默认为 POST

表 11.88. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.89. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.90. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.91. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.24. baremetal 驱动程序传递列表

列出驱动程序的可用厂商传递方法。

使用方法:

openstack baremetal driver passthru list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--noindent]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                <driver>

表 11.92. positional 参数
概述

<driver>

驱动程序的名称。

表 11.93. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.94. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.95. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.96. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.97. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.25. 裸机驱动程序属性列表

列出驱动程序属性。

使用方法:

openstack baremetal driver property list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--noindent]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                <driver>

表 11.98. positional 参数
概述

<driver>

驱动程序的名称。

表 11.99. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.100. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.101. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.102. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.103. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.26. baremetal 驱动程序 raid 属性列表

列出驱动程序的 RAID 逻辑磁盘属性。

使用方法:

openstack baremetal driver raid property list [-h]
                                                     [-f {csv,json,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--quote {all,minimal,none,nonnumeric}]
                                                     [--noindent]
                                                     [--max-width <integer>]
                                                     [--fit-width]
                                                     [--print-empty]
                                                     [--sort-column SORT_COLUMN]
                                                     <driver>

表 11.104. positional 参数
概述

<driver>

驱动程序的名称。

表 11.105. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.106. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.107. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.108. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.109. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.27. 裸机驱动程序显示

显示有关驱动程序的信息。

使用方法:

openstack baremetal driver show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <driver>

表 11.110. positional 参数
概述

<driver>

驱动程序的名称。

表 11.111. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.112. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.113. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.114. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.115. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.28. 裸机内省中止

中止为节点运行内省。

使用方法:

openstack baremetal introspection abort [-h] node

表 11.116. positional 参数
概述

node

baremetal node uuid 或 name

表 11.117. 命令参数
概述

-h, --help

显示帮助信息并退出

11.29. 保存裸机内省数据

保存或显示原始内省数据。

使用方法:

openstack baremetal introspection data save [-h] [--file <filename>]
                                                   node

表 11.118. positional 参数
概述

node

baremetal node uuid 或 name

表 11.119. 命令参数
概述

-h, --help

显示帮助信息并退出

--file <filename>

下载内省数据文件名(默认:stdout)

11.30. 裸机内省接口列表

列出包括附加交换机端口信息的接口数据。

使用方法:

openstack baremetal introspection interface list [-h]
                                                        [-f {csv,json,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--quote {all,minimal,none,nonnumeric}]
                                                        [--noindent]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--sort-column SORT_COLUMN]
                                                        [--vlan VLAN]
                                                        [--long | --fields <field> [<field> ...]]
                                                        node_ident

表 11.120. positional 参数
概述

node_ident

baremetal node uuid 或 name

表 11.121. 命令参数
概述

-h, --help

显示帮助信息并退出

--vlan VLAN

仅列出为此 vlan id 配置的接口,才能重复

--long

显示接口的详细信息。

--fields <field> [<field> …​]

显示一个或多个字段。指定 -- long 时无法使用

表 11.122. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.123. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.124. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.125. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.31. 裸机内省接口显示

显示包括附加交换机端口信息的接口数据。

使用方法:

openstack baremetal introspection interface show [-h]
                                                        [-f {json,shell,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--noindent]
                                                        [--prefix PREFIX]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--fields <field> [<field> ...]]
                                                        node_ident interface

表 11.126. positional 参数
概述

node_ident

baremetal node uuid 或 name

interface

接口名称

表 11.127. 命令参数
概述

-h, --help

显示帮助信息并退出

--fields <field> [<field> …​]

显示一个或多个字段。

表 11.128. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.129. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.130. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.131. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.32. 裸机内省列表

列出内省状态

使用方法:

openstack baremetal introspection list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              [--marker MARKER]
                                              [--limit LIMIT]

表 11.132. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker047ER

上一页上最后一个项目的 UUID

--limit LIMIT

要返回的项目数量

表 11.133. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.134. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.135. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.136. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.33. 裸机内省重新处理

重新处理存储内省数据

使用方法:

openstack baremetal introspection reprocess [-h] node

表 11.137. positional 参数
概述

node

baremetal node uuid 或 name

表 11.138. 命令参数
概述

-h, --help

显示帮助信息并退出

11.34. 裸机内省规则删除

删除内省规则。

使用方法:

openstack baremetal introspection rule delete [-h] uuid

表 11.139. positional 参数
概述

uuid

规则 uuid

表 11.140. 命令参数
概述

-h, --help

显示帮助信息并退出

11.35. 裸机内省规则导入

从 JSON/YAML 文件中导入一个或多个内省规则。

使用方法:

openstack baremetal introspection rule import [-h]
                                                     [-f {csv,json,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--quote {all,minimal,none,nonnumeric}]
                                                     [--noindent]
                                                     [--max-width <integer>]
                                                     [--fit-width]
                                                     [--print-empty]
                                                     [--sort-column SORT_COLUMN]
                                                     file

表 11.141. positional 参数
概述

file

要导入的 JSON 或 yaml 文件,可能包含一个或多个规则

表 11.142. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.143. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.144. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.145. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.146. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.36. 裸机内省规则列表

列出所有内省规则。

使用方法:

openstack baremetal introspection rule list [-h]
                                                   [-f {csv,json,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--quote {all,minimal,none,nonnumeric}]
                                                   [--noindent]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--sort-column SORT_COLUMN]

表 11.147. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.148. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.149. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.150. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.151. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.37. 裸机内省规则清除

丢弃所有内省规则。

使用方法:

openstack baremetal introspection rule purge [-h]

表 11.152. 命令参数
概述

-h, --help

显示帮助信息并退出

11.38. 裸机内省规则显示

显示内省规则。

使用方法:

openstack baremetal introspection rule show [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   uuid

表 11.153. positional 参数
概述

uuid

规则 uuid

表 11.154. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.155. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.156. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.157. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.158. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.39. 裸机内省开始

启动内省。

使用方法:

openstack baremetal introspection start [-h]
                                               [-f {csv,json,table,value,yaml}]
                                               [-c COLUMN]
                                               [--quote {all,minimal,none,nonnumeric}]
                                               [--noindent]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--sort-column SORT_COLUMN]
                                               [--wait] [--check-errors]
                                               node [node ...]

表 11.159. positional 参数
概述

node

裸机节点 uuid 或名称

表 11.160. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait

等待内省完成;结果将显示在结尾

--check-errors

检查内省过程中是否发生错误;如果只显示任何错误,则只能用于 --wait

表 11.161. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.162. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.163. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.164. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.40. 裸机内省状态

获取内省状态。

使用方法:

openstack baremetal introspection status [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                node

表 11.165. positional 参数
概述

node

baremetal node uuid 或 name

表 11.166. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.167. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.168. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.169. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.170. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.41. 裸机节点中止

将 baremetal 节点的置备状态设置为 abort

使用方法:

openstack baremetal node abort [-h] <node>

表 11.171. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.172. 命令参数
概述

-h, --help

显示帮助信息并退出

11.42. baremetal 节点添加特征

为节点添加特征。

使用方法:

openstack baremetal node add trait [-h] <node> <trait> [<trait> ...]

表 11.173. positional 参数
概述

<node>

节点的名称或 uuid

<trait>

要添加的特征

表 11.174. 命令参数
概述

-h, --help

显示帮助信息并退出

11.43. 裸机节点采用

设置要采用的 baremetal 节点的置备状态

使用方法:

openstack baremetal node adopt [-h] [--wait [<time-out>]] <node>

表 11.175. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.176. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点达到所需状态 active。(可选)使用超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

11.44. 裸机节点 bios 设置列表

列出节点的 BIOS 设置。

使用方法:

openstack baremetal node bios setting list [-h]
                                                  [-f {csv,json,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--quote {all,minimal,none,nonnumeric}]
                                                  [--noindent]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--sort-column SORT_COLUMN]
                                                  <node>

表 11.177. positional 参数
概述

<node>

节点的名称或 uuid

表 11.178. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.179. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.180. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.181. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.182. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.45. 裸机节点 bios 设置显示

显示节点的特定 BIOS 设置。

使用方法:

openstack baremetal node bios setting show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  <node> <setting name>

表 11.183. positional 参数
概述

<node>

节点的名称或 uuid

<setting name>

设置显示的名称

表 11.184. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.185. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.186. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.187. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.188. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.46. 裸机节点引导设备集

为节点设置引导设备

使用方法:

openstack baremetal node boot device set [-h] [--persistent]
                                                <node> <device>

表 11.189. positional 参数
概述

<node>

节点的名称或 uuid

<device>

bios、cdrom、disk、pxe、safe、wanboot 之一

表 11.190. 命令参数
概述

-h, --help

显示帮助信息并退出

--persistent

使所有以后引导的更改都会永久保留

11.47. 裸机节点引导设备显示

显示节点的引导设备信息

使用方法:

openstack baremetal node boot device show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--supported]
                                                 <node>

表 11.191. positional 参数
概述

<node>

节点的名称或 uuid

表 11.192. 命令参数
概述

-h, --help

显示帮助信息并退出

--supported

显示支持的引导设备

表 11.193. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.194. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.195. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.196. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.48. 裸机节点清理

将 baremetal 节点的置备状态设置为 clean

使用方法:

openstack baremetal node clean [-h] [--wait [<time-out>]] --clean-steps
                                      <clean-steps>
                                      <node>

表 11.197. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.198. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点进入所需的状态,可以管理。(可选)使用超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

--clean-steps <clean-steps>

json 格式的清理步骤可以是包含清理步骤的文件的路径; OR -,以及从标准输入中读取的清理步骤 ; 或字符串。该值应该是干净步骤字典的列表;每个字典都应该具有键 接口和 步骤,以及可选的键 args

11.49. 裸机节点控制台禁用

禁用节点的控制台访问

使用方法:

openstack baremetal node console disable [-h] <node>

表 11.199. positional 参数
概述

<node>

节点的名称或 uuid

表 11.200. 命令参数
概述

-h, --help

显示帮助信息并退出

11.50. 裸机节点控制台启用

为节点启用控制台访问

使用方法:

openstack baremetal node console enable [-h] <node>

表 11.201. positional 参数
概述

<node>

节点的名称或 uuid

表 11.202. 命令参数
概述

-h, --help

显示帮助信息并退出

11.51. 裸机节点控制台显示

显示节点的控制台信息

使用方法:

openstack baremetal node console show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <node>

表 11.203. positional 参数
概述

<node>

节点的名称或 uuid

表 11.204. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.205. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.206. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.207. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.208. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.52. 裸机节点创建

使用 baremetal 服务注册新节点

使用方法:

openstack baremetal node create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--chassis-uuid <chassis>] --driver
                                       <driver> [--driver-info <key=value>]
                                       [--property <key=value>]
                                       [--extra <key=value>] [--uuid <uuid>]
                                       [--name <name>]
                                       [--bios-interface <bios_interface>]
                                       [--boot-interface <boot_interface>]
                                       [--console-interface <console_interface>]
                                       [--deploy-interface <deploy_interface>]
                                       [--inspect-interface <inspect_interface>]
                                       [--management-interface <management_interface>]
                                       [--network-interface <network_interface>]
                                       [--power-interface <power_interface>]
                                       [--raid-interface <raid_interface>]
                                       [--rescue-interface <rescue_interface>]
                                       [--storage-interface <storage_interface>]
                                       [--vendor-interface <vendor_interface>]
                                       [--resource-class <resource_class>]
                                       [--conductor-group <conductor_group>]
                                       [--automated-clean] [--owner <owner>]
                                       [--description <description>]

表 11.209. 命令参数
概述

-h, --help

显示帮助信息并退出

--chassis-uuid <chassis>

此节点所属的机箱的 UUID。

--driver <driver>

用于控制节点 [必需] 的驱动。

--driver-info <key=value>

驱动程序使用的键/值对,如带外管理凭据。可多次指定。

--property <key=value>

描述节点的物理特征的键/值对。这会导出到 Nova,并由调度程序使用。可多次指定。

--extra <key=value>

记录任意键/值元数据。可以多次指定。

--uuid <uuid>

节点的唯一 uuid。

--name <name>

节点的唯一名称。

--bios-interface <bios_interface>

节点驱动程序使用的 BIOS 接口。这只在指定的 --driver 是硬件类型时才适用。

--boot-interface <boot_interface>

节点驱动程序使用的引导接口。这只在指定的 --driver 是硬件类型时才适用。

--console-interface <console_interface>

节点驱动程序使用的控制台界面。这只在指定的 --driver 是硬件类型时才适用。

--deploy-interface <deploy_interface>

部署节点驱动程序使用的接口。这只在指定的 --driver 是硬件类型时才适用。

--inspect-interface <inspect_interface>

检查节点驱动程序使用的接口。这只在指定的 --driver 是硬件类型时才适用。

--management-interface <management_interface>

节点驱动程序使用的管理界面。这只在指定的 --driver 是硬件类型时才适用。

--network-interface <network_interface>

用于切换节点以清理/置备网络的网络接口。

--power-interface <power_interface>

节点驱动程序使用的电源接口。这只在指定的 --driver 是硬件类型时才适用。

--raid-interface <raid_interface>

节点驱动程序使用的 RAID 接口。这只在指定的 --driver 是硬件类型时才适用。

--rescue-interface <rescue_interface>

节点驱动程序使用的救援接口。这只在指定的 --driver 是硬件类型时才适用。

--storage-interface <storage_interface>

节点驱动程序使用的存储接口。

--vendor-interface <vendor_interface>

节点驱动程序使用的厂商接口。这只在指定的 --driver 是硬件类型时才适用。

--resource-class <resource_class>

用于将节点映射到 nova 类型的资源类

--conductor-group <conductor_group>

节点所属的编排器组

--automated-clean

为节点启用自动清理

--owner <owner>

节点的所有者。

--description <description>

节点的描述。

表 11.210. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.211. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.212. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.213. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.53. 裸机节点删除

取消注册裸机节点

使用方法:

openstack baremetal node delete [-h] <node> [<node> ...]

表 11.214. positional 参数
概述

<node>

要删除的节点(名称或 uuid)

表 11.215. 命令参数
概述

-h, --help

显示帮助信息并退出

11.54. 裸机节点部署

设置 要部署的裸机节点的置备状态

使用方法:

openstack baremetal node deploy [-h] [--wait [<time-out>]]
                                       [--config-drive <config-drive>]
                                       <node>

表 11.216. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.217. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点达到所需状态 active。(可选)使用超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

--config-drive <config-drive>

gzipped, base64 编码的配置驱动器字符串,或者配置驱动器文件的路径,或者包含配置驱动器文件的目录的路径,或从中构建配置驱动器的 JSON 对象。如果是目录,则从中生成一个配置驱动器。如果是带有可选键 meta_datauser_datanetwork_data 的 JSON 对象,则会在服务器端生成配置驱动器(请参阅裸机 API 参考)。

11.55. 裸机节点注入 nmi

将 NMI 注入裸机节点

使用方法:

openstack baremetal node inject nmi [-h] <node>

表 11.218. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.219. 命令参数
概述

-h, --help

显示帮助信息并退出

11.56. 裸机节点检查

设置 要检查的裸机节点的 provision 状态

使用方法:

openstack baremetal node inspect [-h] [--wait [<time-out>]] <node>

表 11.220. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.221. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点进入所需的状态,可以管理。(可选)使用超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

11.57. 裸机节点列表

列出裸机节点

使用方法:

openstack baremetal node list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--limit <limit>] [--marker <node>]
                                     [--sort <key>[:<direction>]]
                                     [--maintenance | --no-maintenance]
                                     [--fault <fault>]
                                     [--associated | --unassociated]
                                     [--provision-state <provision state>]
                                     [--driver <driver>]
                                     [--resource-class <resource class>]
                                     [--conductor-group <conductor_group>]
                                     [--conductor <conductor>]
                                     [--chassis <chassis UUID>]
                                     [--owner <owner>]
                                     [--description-contains <description_contains>]
                                     [--long | --fields <field> [<field> ...]]

表 11.222. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

每个请求返回的最大节点数,0 代表没有限制。默认是 Baremetal API Service 使用的最大数量。

--marker <node>

节点 uuid (例如,来自上一个请求列表中的最后一个节点)。在此 UUID 后返回节点列表。

--sort <key>[:<direction>]

根据指定节点字段和方向(asc 或 desc)对输出进行排序(默认为 asc)。可以指定多个字段和方向,用逗号分开。

--maintenance

将列表限制为维护模式的节点

--no-maintenance

将列表限制为不处于维护模式的节点

--fault <fault>

列出指定错误中的节点。

--associated

仅列出与实例关联的节点。

--unassociated

仅列出未与实例关联的节点。

--provision-state <provision state>

列出具有指定置备状态的节点。

--driver <driver>

使用驱动程序 <driver> 将列表限制为节点

--resource-class <resource class>

使用资源类 <resource class> 将列表限制为节点

--conductor-group <conductor_group>

将列表限制为具有编排器组 <conductor group> 的节点

--conductor <conductor>

使用编排器 <conductor> 将列表限制为节点

--chassis <chassis UUID>

将列表限制为这个机箱的节点

--owner <owner>

使用所有者 <owner> 将列表限制为节点

--description-contains <description_contains>

将列表限制为带有描述信息的节点包含 <description_contains>

--long

显示节点的详细信息。

--fields <field> [<field> …​]

一个或多个节点字段。只有这些字段将从服务器获取。指定 --long 时无法使用。

表 11.223. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.224. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.225. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.226. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.58. 裸机节点维护集

将 baremetal 节点设置为维护模式

使用方法:

openstack baremetal node maintenance set [-h] [--reason <reason>]
                                                <node>

表 11.227. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.228. 命令参数
概述

-h, --help

显示帮助信息并退出

--reason <reason>

设置维护模式的原因。

11.59. 裸机节点维护未设置

从维护模式取消设置 baremetal 节点

使用方法:

openstack baremetal node maintenance unset [-h] <node>

表 11.229. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.230. 命令参数
概述

-h, --help

显示帮助信息并退出

11.60. 裸机节点管理

设置 要管理的裸机节点的置备状态

使用方法:

openstack baremetal node manage [-h] [--wait [<time-out>]] <node>

表 11.231. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.232. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点进入所需的状态,可以管理。(可选)使用超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

11.61. 裸机节点传递调用

为节点调用厂商传递方法

使用方法:

openstack baremetal node passthru call [-h] [--arg <key=value>]
                                              [--http-method <http-method>]
                                              <node> <method>

表 11.233. positional 参数
概述

<node>

节点的名称或 uuid

<method>

要执行的厂商传递方法

表 11.234. 命令参数
概述

-h, --help

显示帮助信息并退出

--arg <key=value>

传递给 passthru 方法的参数(重复选项以指定多个参数)

--http-method <http-method>

在 passthru 请求中使用的 http 方法。一个 DELETE、GET、PATCH、POST、PUT。默认为 POST。

11.62. 裸机节点传递列表

列出节点的供应商传递方法

使用方法:

openstack baremetal node passthru list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              <node>

表 11.235. positional 参数
概述

<node>

节点的名称或 uuid

表 11.236. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.237. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.238. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.239. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.240. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.63. 裸机节点关闭

关闭节点

使用方法:

openstack baremetal node power off [-h]
                                          [--power-timeout <power-timeout>]
                                          [--soft]
                                          <node>

表 11.241. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.242. 命令参数
概述

-h, --help

显示帮助信息并退出

--power-timeout <power-timeout>

超时(以秒为单位,正整数)在出错前等待目标电源状态。

--soft

请求安全电源。

11.64. 裸机节点电源

打开节点

使用方法:

openstack baremetal node power on [-h]
                                         [--power-timeout <power-timeout>]
                                         <node>

表 11.243. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.244. 命令参数
概述

-h, --help

显示帮助信息并退出

--power-timeout <power-timeout>

超时(以秒为单位,正整数)在出错前等待目标电源状态。

11.65. 裸机节点提供

设置提供的裸机节点的置备状态

使用方法:

openstack baremetal node provide [-h] [--wait [<time-out>]] <node>

表 11.245. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.246. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点达到所需的状态 available。(可选)使用超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

11.66. 裸机节点重新引导

重新引导裸机节点

使用方法:

openstack baremetal node reboot [-h] [--soft]
                                       [--power-timeout <power-timeout>]
                                       <node>

表 11.247. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.248. 命令参数
概述

-h, --help

显示帮助信息并退出

--soft

请求安全重启。

--power-timeout <power-timeout>

超时(以秒为单位,正整数)在出错前等待目标电源状态。

11.67. 裸机节点重建

设置要 重建的裸机节点的 provision 状态

使用方法:

openstack baremetal node rebuild [-h] [--wait [<time-out>]]
                                        [--config-drive <config-drive>]
                                        <node>

表 11.249. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.250. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点达到所需状态 active。(可选)使用超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

--config-drive <config-drive>

gzipped, base64 编码的配置驱动器字符串,或者配置驱动器文件的路径,或者包含配置驱动器文件的目录的路径,或从中构建配置驱动器的 JSON 对象。如果是目录,则从中生成一个配置驱动器。如果是带有可选键 meta_datauser_datanetwork_data 的 JSON 对象,则会在服务器端生成配置驱动器(请参阅裸机 API 参考)。

11.68. 裸机节点删除特征

从节点中删除特征。

使用方法:

openstack baremetal node remove trait [-h] [--all]
                                             <node> [<trait> [<trait> ...]]

表 11.251. positional 参数
概述

<node>

节点的名称或 uuid

<trait>

要删除的特征

表 11.252. 命令参数
概述

-h, --help

显示帮助信息并退出

--all

删除所有特征

11.69. 裸机节点救援

将 baremetal 节点的 provision 状态设置为 rescue

使用方法:

openstack baremetal node rescue [-h] [--wait [<time-out>]]
                                       --rescue-password <rescue-password>
                                       <node>

表 11.253. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.254. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点进入所需的状态 rescue。(可选)使用超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

--rescue-password <rescue-password>

用于登录到救援 ramdisk 的密码。该值应该是非空字符串。

11.70. 裸机节点集

设置裸机属性

使用方法:

openstack baremetal node set [-h] [--instance-uuid <uuid>]
                                    [--name <name>]
                                    [--chassis-uuid <chassis UUID>]
                                    [--driver <driver>]
                                    [--bios-interface <bios_interface> | --reset-bios-interface]
                                    [--boot-interface <boot_interface> | --reset-boot-interface]
                                    [--console-interface <console_interface> | --reset-console-interface]
                                    [--deploy-interface <deploy_interface> | --reset-deploy-interface]
                                    [--inspect-interface <inspect_interface> | --reset-inspect-interface]
                                    [--management-interface <management_interface> | --reset-management-interface]
                                    [--network-interface <network_interface> | --reset-network-interface]
                                    [--power-interface <power_interface> | --reset-power-interface]
                                    [--raid-interface <raid_interface> | --reset-raid-interface]
                                    [--rescue-interface <rescue_interface> | --reset-rescue-interface]
                                    [--storage-interface <storage_interface> | --reset-storage-interface]
                                    [--vendor-interface <vendor_interface> | --reset-vendor-interface]
                                    [--reset-interfaces]
                                    [--resource-class <resource_class>]
                                    [--conductor-group <conductor_group>]
                                    [--automated-clean] [--protected]
                                    [--protected-reason <protected_reason>]
                                    [--target-raid-config <target_raid_config>]
                                    [--property <key=value>]
                                    [--extra <key=value>]
                                    [--driver-info <key=value>]
                                    [--instance-info <key=value>]
                                    [--owner <owner>]
                                    [--description <description>]
                                    <node>

表 11.255. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.256. 命令参数
概述

-h, --help

显示帮助信息并退出

--instance-uuid <uuid>

将节点的 instance uuid 设置为 <uuid>

--name <name>

设置节点的名称

--chassis-uuid <chassis UUID>

为节点设置机箱

--driver <driver>

为节点设置驱动程序

--bios-interface <bios_interface>

为节点设置 bios 接口

--reset-bios-interface

将 bios 接口重置为其硬件类型 default

--boot-interface <boot_interface>

为节点设置引导接口

--reset-boot-interface

将引导接口重置为其硬件类型默认

--console-interface <console_interface>

为节点设置控制台接口

--reset-console-interface

将控制台接口重置为其硬件类型默认

--deploy-interface <deploy_interface>

为节点设置部署接口

--reset-deploy-interface

将部署接口重置为其硬件类型 default

--inspect-interface <inspect_interface>

为节点设置检查接口

--reset-inspect-interface

将检查接口重置为其硬件类型 default

--management-interface <management_interface>

为节点设置管理界面

--reset-management-interface

将管理界面重置为其硬件类型默认

--network-interface <network_interface>

为节点设置网络接口

--reset-network-interface

将网络接口重置为其硬件类型 default

--power-interface <power_interface>

为节点设置电源接口

--reset-power-interface

将电源接口重置为其硬件类型 default

--raid-interface <raid_interface>

为节点设置 raid 接口

--reset-raid-interface

将 raid 接口重置为其硬件类型 default

--rescue-interface <rescue_interface>

为节点设置救援接口

--reset-rescue-interface

将救援接口重置为其硬件类型默认

--storage-interface <storage_interface>

为节点设置存储接口

--reset-storage-interface

将存储接口重置为其硬件类型默认

--vendor-interface <vendor_interface>

为节点设置供应商接口

--reset-vendor-interface

将厂商接口重置为其硬件类型 default

--reset-interfaces

将未明确指定的所有接口重置为其默认实现。仅对 --driver 有效。

--resource-class <resource_class>

为节点设置资源类

--conductor-group <conductor_group>

为节点设置编排器组

--automated-clean

为节点启用自动清理

--protected

将节点标记为受保护的

--protected-reason <protected_reason>

将节点标记为受保护的原因

--target-raid-config <target_raid_config>

为节点设置目标 raid 配置(json)。这可以是:1。包含 RAID 配置的 JSON 数据的文件;2. "-" 从标准输入中读取内容;或 3。一个有效的 JSON 字符串。

--property <key=value>

在此裸机节点上设置的属性(重复选项来设置多个属性)

--extra <key=value>

在这个裸机节点上设置的额外设置(重复选项来设置多个额外项)

--driver-info <key=value>

在此裸机节点上设置的驱动程序信息(重复选项来设置多个驱动程序信息)

--instance-info <key=value>

要在这个裸机节点上设置的实例信息(重复选项来设置多个实例信息)

--owner <owner>

为节点设置所有者

--description <description>

设置节点的描述

11.71. 裸机节点显示

显示裸机节点详情

使用方法:

openstack baremetal node show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--instance]
                                     [--fields <field> [<field> ...]]
                                     <node>

表 11.257. positional 参数
概述

<node>

节点的名称或 uuid (如果指定了 --instance,则为 instance uuid)

表 11.258. 命令参数
概述

-h, --help

显示帮助信息并退出

--instance

<node> 是一个实例 uuid。

--fields <field> [<field> …​]

一个或多个节点字段。只有这些字段将从服务器获取。

表 11.259. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.260. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.261. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.262. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.72. baremetal 节点特征列表

列出节点的特征。

使用方法:

openstack baremetal node trait list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           <node>

表 11.263. positional 参数
概述

<node>

节点的名称或 uuid

表 11.264. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.265. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.266. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.267. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.268. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.73. 裸机节点取消部署

将 baremetal 节点的置备状态设置为 已删除

使用方法:

openstack baremetal node undeploy [-h] [--wait [<time-out>]] <node>

表 11.269. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.270. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点达到所需的状态 available。(可选)使用超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

11.74. baremetal 节点 unrescue

将 baremetal 节点的 provision 状态设置为 unrescue

使用方法:

openstack baremetal node unrescue [-h] [--wait [<time-out>]] <node>

表 11.271. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.272. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点达到所需状态 active。(可选)使用超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

11.75. 裸机节点未设置

取消设置 baremetal 属性

使用方法:

openstack baremetal node unset [-h] [--instance-uuid] [--name]
                                      [--resource-class]
                                      [--target-raid-config]
                                      [--property <key>] [--extra <key>]
                                      [--driver-info <key>]
                                      [--instance-info <key>] [--chassis-uuid]
                                      [--bios-interface] [--boot-interface]
                                      [--console-interface]
                                      [--deploy-interface]
                                      [--inspect-interface]
                                      [--management-interface]
                                      [--network-interface]
                                      [--power-interface] [--raid-interface]
                                      [--rescue-interface]
                                      [--storage-interface]
                                      [--vendor-interface] [--conductor-group]
                                      [--automated-clean] [--protected]
                                      [--protected-reason] [--owner]
                                      [--description]
                                      <node>

表 11.273. positional 参数
概述

<node>

节点的名称或 uuid。

表 11.274. 命令参数
概述

-h, --help

显示帮助信息并退出

--instance-uuid

在这个 baremetal 节点上取消设置实例 uuid

--name

取消设置节点的名称

--resource-class

取消设置节点的资源类

--target-raid-config

取消设置节点的目标 raid 配置

--property <key>

在此裸机节点上取消设置的属性(需要取消设置多个属性)

--extra <key>

在此裸机节点上取消设置的额外选项(需要取消设置多个额外的选项)

--driver-info <key>

在此裸机节点上取消设置的驱动程序信息(重复选项取消设置多个驱动程序信息)

--instance-info <key>

在此裸机节点上取消设置的实例信息(重复选项取消设置多个实例信息)

--chassis-uuid

在此裸机节点上取消设置 chassis uuid

--bios-interface

在此 baremetal 节点上取消设置 bios 接口

--boot-interface

在这个 baremetal 节点上取消设置引导接口

--console-interface

在这个 baremetal 节点上取消设置控制台接口

--deploy-interface

在这个 baremetal 节点上取消设置部署接口

--inspect-interface

在这个 baremetal 节点上取消设置检查接口

--management-interface

在这个 baremetal 节点上取消设置管理界面

--network-interface

在这个 baremetal 节点上取消设置网络接口

--power-interface

在这个 baremetal 节点上取消设置电源接口

--raid-interface

在这个 baremetal 节点上取消设置 raid 接口

--rescue-interface

在这个 baremetal 节点上取消设置救援接口

--storage-interface

在这个 baremetal 节点上取消设置存储接口

--vendor-interface

在这个 baremetal 节点上取消设置供应商接口

--conductor-group

为此裸机节点取消设置编排器组(将使用默认组)

--automated-clean

在此裸机节点上取消设置自动清理选项(将使用配置中的值)

--protected

在节点上取消设置 protected 标记

--protected-reason

取消设置受保护的原因(在未设置保护时自动取消设置)

--owner

取消设置节点的 owner 字段

--description

取消设置节点的 description 字段

11.76. 裸机节点验证

验证节点的驱动程序接口

使用方法:

openstack baremetal node validate [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]
                                         <node>

表 11.275. positional 参数
概述

<node>

节点的名称或 uuid

表 11.276. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.277. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.278. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.279. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.280. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.77. 裸机节点 vif attach

将 VIF 附加到给定节点

使用方法:

openstack baremetal node vif attach [-h] [--vif-info <key=value>]
                                           <node> <vif-id>

表 11.281. positional 参数
概述

<node>

节点的名称或 uuid

<vif-id>

附加到节点的 vif 的名称或 uuid。

表 11.282. 命令参数
概述

-h, --help

显示帮助信息并退出

--vif-info <key=value>

记录任意键/值元数据。可以多次指定。必需的 id 参数不能指定为密钥。

11.78. 裸机节点 vif detach

从给定节点分离 VIF

使用方法:

openstack baremetal node vif detach [-h] <node> <vif-id>

表 11.283. positional 参数
概述

<node>

节点的名称或 uuid

<vif-id>

从节点分离的 vif 的名称或 uuid。

表 11.284. 命令参数
概述

-h, --help

显示帮助信息并退出

11.79. baremetal node vif list

显示节点的 VIFs

使用方法:

openstack baremetal node vif list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]
                                         <node>

表 11.285. positional 参数
概述

<node>

节点的名称或 uuid

表 11.286. 命令参数
概述

-h, --help

显示帮助信息并退出

表 11.287. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.288. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.289. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.290. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.80. 裸机端口创建

创建新端口

使用方法:

openstack baremetal port create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] --node <uuid>
                                       [--uuid <uuid>] [--extra <key=value>]
                                       [--local-link-connection <key=value>]
                                       [-l <key=value>]
                                       [--pxe-enabled <boolean>]
                                       [--port-group <uuid>]
                                       [--physical-network <physical network>]
                                       [--is-smartnic]
                                       <address>

表 11.291. positional 参数
概述

<address>

此端口的 MAC 地址。

表 11.292. 命令参数
概述

-h, --help

显示帮助信息并退出

--node <uuid>

此端口所属的节点的 UUID。

--uuid <uuid>

端口的 UUID。

--extra <key=value>

记录任意键/值 metadata. 参数可多次指定。

--local-link-connection <key=value>

描述本地链路连接信息的键/值元数据。有效的键是 switch_infoswitch_idport_idhostname。需要键 switch_idport_id。如果是智能 NIC 端口,所需键为 port_idhostname。参数可多次指定。

-l <key=value>

弃用。请使用 --local-link-connection。描述本地链路连接信息的键/值元数据。有效键为 switch_infoswitch_idport_id。需要键 switch_idport_id。可多次指定。

--pxe-enabled <boolean>

指明在 pxe 引导此节点时是否应使用此端口。

--port-group <uuid>

此端口所属的端口组的 UUID。

--physical-network <physical network>

此端口连接到的物理网络的名称。

--is-smartnic

指明此端口是否为 smart nic 端口

表 11.293. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.294. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.295. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.296. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.81. 裸机端口删除

删除端口。

使用方法:

openstack baremetal port delete [-h] <port> [<port> ...]

表 11.297. positional 参数
概述

<port>

要删除的端口的 UUID。

表 11.298. 命令参数
概述

-h, --help

显示帮助信息并退出

11.82. baremetal port group create

创建新的 baremetal 端口组。

使用方法:

openstack baremetal port group create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             --node <uuid>
                                             [--address <mac-address>]
                                             [--name NAME] [--uuid UUID]
                                             [--extra <key=value>]
                                             [--mode MODE]
                                             [--property <key=value>]
                                             [--support-standalone-ports | --unsupport-standalone-ports]

表 11.299. 命令参数
概述

-h, --help

显示帮助信息并退出

--node <uuid>

此端口组所属的节点的 UUID。

--address <mac-address>

此端口组的 MAC 地址。

--name NAME

端口组的名称。

--UUID UUID

端口组的 UUID。

--extra <key=value>

记录任意键/值元数据。可以多次指定。

--mode MODE

端口组的模式。有关可能的值,请参阅 https://www.kernel.org/doc/Documentation/networking/bo nding.txt。

--property <key=value>

与此端口组配置相关的键/值属性。可多次指定。

--support-standalone-ports

属于此端口组成员的端口可用作独立端口。(默认)

--unsupport-standalone-ports

属于此端口组成员的端口不能用作独立端口。

表 11.300. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.301. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.302. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.303. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.83. 裸机端口组删除

取消注册裸机端口组。

使用方法:

openstack baremetal port group delete [-h]
                                             <port group> [<port group> ...]

表 11.304. positional 参数
概述

<port group>

要删除的端口组(名称或 uuid)。

表 11.305. 命令参数
概述

-h, --help

显示帮助信息并退出

11.84. baremetal port group list

列出裸机端口组。

使用方法:

openstack baremetal port group list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           [--limit <limit>]
                                           [--marker <port group>]
                                           [--sort <key>[:<direction>]]
                                           [--address <mac-address>]
                                           [--node <node>]
                                           [--long | --fields <field> [<field> ...]]

表 11.306. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

每个请求返回的最大端口组数,0 代表没有限制。默认是 Baremetal API Service 使用的最大数量。

--marker <port group>

端口组 uuid (例如,上一个请求列表中的最后一个端口组)。在此 UUID 后返回端口组列表。

--sort <key>[:<direction>]

根据指定的端口组字段和指示(asc 或 desc)对输出进行排序(默认为 asc)。可以指定多个字段和方向,用逗号分开。

--address <mac-address>

仅显示使用此 mac 地址的端口组的信息。

--node <node>

仅列出此节点的端口组(name 或 uuid)。

--long

显示有关端口组的详细信息。

--fields <field> [<field> …​]

一个或多个端口组字段。只有这些字段将从服务器获取。指定 -- long 时无法使用。

表 11.307. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.308. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.309. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.310. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.85. 设置了裸机端口组

设置 baremetal 端口组属性。

使用方法:

openstack baremetal port group set [-h] [--node <uuid>]
                                          [--address <mac-address>]
                                          [--name <name>]
                                          [--extra <key=value>] [--mode MODE]
                                          [--property <key=value>]
                                          [--support-standalone-ports | --unsupport-standalone-ports]
                                          <port group>

表 11.311. positional 参数
概述

<port group>

端口组的名称或 uuid。

表 11.312. 命令参数
概述

-h, --help

显示帮助信息并退出

--node <uuid>

更新此端口组所属的节点的 uuid。

--address <mac-address>

此端口组的 MAC 地址。

--name <name>

端口组的名称。

--extra <key=value>

在这个 baremetal 端口组上设置的额外设置(重复选项来设置多个额外的选项)。

--mode MODE

端口组的模式。有关可能的值,请参阅 https://www.kernel.org/doc/Documentation/networking/bo nding.txt。

--property <key=value>

与此端口组配置相关的键/值属性(需要设置多个属性)。

--support-standalone-ports

属于此端口组成员的端口可用作独立端口。

--unsupport-standalone-ports

属于此端口组成员的端口不能用作独立端口。

11.86. 裸机端口组显示

显示裸机端口组详情。

使用方法:

openstack baremetal port group show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--address]
                                           [--fields <field> [<field> ...]]
                                           <id>

表 11.313. positional 参数
概述

<id>

端口组的 UUID 或名称(如果指定了 --address,则 MAC 地址)。

表 11.314. 命令参数
概述

-h, --help

显示帮助信息并退出

--address

<id> 是端口组的 mac 地址(而不是 uuid 或名称)。

--fields <field> [<field> …​]

一个或多个端口组字段。只有这些字段将从服务器获取。

表 11.315. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.316. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.317. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.318. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.87. baremetal port group unset

取消设置 baremetal 端口组属性。

使用方法:

openstack baremetal port group unset [-h] [--name] [--address]
                                            [--extra <key>] [--property <key>]
                                            <port group>

表 11.319. positional 参数
概述

<port group>

端口组的名称或 uuid。

表 11.320. 命令参数
概述

-h, --help

显示帮助信息并退出

--name

取消设置端口组的名称。

--address

取消设置端口组的地址。

--extra <key>

在这个 baremetal 端口组上取消设置的额外选项(需要取消设置多个额外的选项)。

--property <key>

在此 baremetal 端口组上取消设置的属性(重复选项可取消设置多个属性)。

11.88. 裸机端口列表

列出裸机端口。

使用方法:

openstack baremetal port list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--address <mac-address>] [--node <node>]
                                     [--port-group <port group>]
                                     [--limit <limit>] [--marker <port>]
                                     [--sort <key>[:<direction>]]
                                     [--long | --fields <field> [<field> ...]]

表 11.321. 命令参数
概述

-h, --help

显示帮助信息并退出

--address <mac-address>

仅显示使用此 mac 地址的端口的信息。

--node <node>

仅列出此节点的端口(name 或 uuid)。

--port-group <port group>

仅列出此端口组的端口(name 或 uuid)。

--limit <limit>

每个请求返回的最大端口数,0 代表没有限制。默认是 Baremetal API Service 使用的最大数量。

--marker <port>

端口 uuid (例如,上一个请求列表中的最后一个端口)。返回此 UUID 后的端口列表。

--sort <key>[:<direction>]

根据指定的端口字段和方向(asc 或 desc)对输出进行排序(默认为 asc)。可以指定多个字段和方向,用逗号分开。

--long

显示端口的详细信息。

--fields <field> [<field> …​]

一个或多个端口字段。只有这些字段将从服务器获取。指定 --long 时无法使用。

表 11.322. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.323. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.324. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.325. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.89. 裸机端口集

设置 baremetal 端口属性。

使用方法:

openstack baremetal port set [-h] [--node <uuid>] [--address <address>]
                                    [--extra <key=value>]
                                    [--port-group <uuid>]
                                    [--local-link-connection <key=value>]
                                    [--pxe-enabled | --pxe-disabled]
                                    [--physical-network <physical network>]
                                    [--is-smartnic]
                                    <port>

表 11.326. positional 参数
概述

<port>

端口的 UUID

表 11.327. 命令参数
概述

-h, --help

显示帮助信息并退出

--node <uuid>

设置此端口所属的节点的 uuid

--address <address>

为此端口设置 mac 地址

--extra <key=value>

在这个裸机端口上设置的额外设置(重复选项来设置多个额外项)

--port-group <uuid>

设置此端口所属的端口组的 uuid。

--local-link-connection <key=value>

描述本地链路连接信息的键/值元数据。有效的键是 switch_infoswitch_idport_idhostname。需要键 switch_idport_id。如果是智能 NIC 端口,所需键为 port_idhostname。参数可多次指定。

--pxe-enabled

表示在 pxe 引导此节点时应使用此端口(默认)

--pxe-disabled

表示 pxe 引导此节点时不应使用这个端口

--physical-network <physical network>

设置此端口连接到的物理网络的名称。

--is-smartnic

将 port 设置为 smart nic 端口

11.90. 裸机端口显示

显示裸机端口详情。

使用方法:

openstack baremetal port show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty] [--address]
                                     [--fields <field> [<field> ...]]
                                     <id>

表 11.328. positional 参数
概述

<id>

端口的 UUID (如果指定了 --address,则 MAC 地址)。

表 11.329. 命令参数
概述

-h, --help

显示帮助信息并退出

--address

<id> 是端口的 mac 地址(而不是 uuid)。

--fields <field> [<field> …​]

一个或多个端口字段。只有这些字段将从服务器获取。

表 11.330. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.331. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.332. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.333. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.91. 裸机端口未设置

取消设置 baremetal 端口属性。

使用方法:

openstack baremetal port unset [-h] [--extra <key>] [--port-group]
                                      [--physical-network] [--is-smartnic]
                                      <port>

表 11.334. positional 参数
概述

<port>

端口的 UUID。

表 11.335. 命令参数
概述

-h, --help

显示帮助信息并退出

--extra <key>

在这个裸机端口上取消设置的额外选项(需要取消设置多个额外项)

--port-group

从端口组中删除端口

--physical-network

在这个裸机端口上取消设置物理网络。

--is-smartnic

将 port 设置为 not smart nic port

11.92. 裸机卷连接器创建

创建新的 baremetal 卷连接器。

使用方法:

openstack baremetal volume connector create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty] --node
                                                   <uuid> --type <type>
                                                   --connector-id <connector
                                                   id> [--uuid <uuid>]
                                                   [--extra <key=value>]

表 11.336. 命令参数
概述

-h, --help

显示帮助信息并退出

--node <uuid>

此卷连接器所属的节点的 UUID。

--type <type>

卷连接器的类型。可以是 iqn,ip,mac,wwnn,wwpn,port,portgroup

--connector-id <connector id>

指定类型中的卷连接器 ID。例如,如果类型为 iqn,则节点的 iSCSI 启动器 IQN。

--uuid <uuid>

卷连接器的 UUID。

--extra <key=value>

记录任意键/值元数据。可以多次指定。

表 11.337. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.338. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.339. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.340. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.93. 裸机卷连接器删除

取消裸机卷连接器。

使用方法:

openstack baremetal volume connector delete [-h]
                                                   <volume connector>
                                                   [<volume connector> ...]

表 11.341. positional 参数
概述

<volume connector>

要删除的卷连接器的 UUID。

表 11.342. 命令参数
概述

-h, --help

显示帮助信息并退出

11.94. 裸机卷连接器列表

列出 baremetal 卷连接器。

使用方法:

openstack baremetal volume connector list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]
                                                 [--node <node>]
                                                 [--limit <limit>]
                                                 [--marker <volume connector>]
                                                 [--sort <key>[:<direction>]]
                                                 [--long | --fields <field> [<field> ...]]

表 11.343. 命令参数
概述

-h, --help

显示帮助信息并退出

--node <node>

仅列出此节点的卷连接器(名称或 UUID)。

--limit <limit>

每个请求返回的最大卷连接器数,0 代表没有限制。默认是 Baremetal API Service 使用的最大数量。

--marker <volume connector>

卷连接器 uuid (例如,上一个请求列表中的最后一个卷连接器)。在此 UUID 后返回卷连接器列表。

--sort <key>[:<direction>]

通过指定卷连接器字段和方向(asc 或 desc)排序输出(默认为:asasc)。可以指定多个字段和方向,用逗号分开。

--long

显示有关卷连接器的详细信息。

--fields <field> [<field> …​]

一个或多个卷连接器字段。只有这些字段将从服务器获取。指定 --long 时无法使用。

表 11.344. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.345. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.346. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.347. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.95. 裸机卷连接器集

设置 baremetal 卷连接器属性。

使用方法:

openstack baremetal volume connector set [-h] [--node <uuid>]
                                                [--type <type>]
                                                [--connector-id <connector id>]
                                                [--extra <key=value>]
                                                <volume connector>

表 11.348. positional 参数
概述

<volume connector>

卷连接器的 UUID。

表 11.349. 命令参数
概述

-h, --help

显示帮助信息并退出

--node <uuid>

此卷连接器所属的节点的 UUID。

--type <type>

卷连接器的类型。可以是 iqn,ip,mac,wwnn,wwpn,port,portgroup

--connector-id <connector id>

指定类型中的卷连接器的 ID。

--extra <key=value>

记录任意键/值元数据。可以多次指定。

11.96. 裸机卷连接器显示

显示 baremetal 卷连接器详情。

使用方法:

openstack baremetal volume connector show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--fields <field> [<field> ...]]
                                                 <id>

表 11.350. positional 参数
概述

<id>

卷连接器的 UUID。

表 11.351. 命令参数
概述

-h, --help

显示帮助信息并退出

--fields <field> [<field> …​]

一个或多个卷连接器字段。只有这些字段将从服务器获取。

表 11.352. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.353. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.354. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.355. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.97. 裸机卷连接器取消设置

取消设置 baremetal 卷连接器属性。

使用方法:

openstack baremetal volume connector unset [-h] [--extra <key>]
                                                  <volume connector>

表 11.356. positional 参数
概述

<volume connector>

卷连接器的 UUID。

表 11.357. 命令参数
概述

-h, --help

显示帮助信息并退出

--extra <key>

额外设置(需要取消设置多个额外的选项)

11.98. 裸机卷目标创建

创建新的 baremetal 卷目标。

使用方法:

openstack baremetal volume target create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                --node <uuid> --type <volume
                                                type> [--property <key=value>]
                                                --boot-index <boot index>
                                                --volume-id <volume id>
                                                [--uuid <uuid>]
                                                [--extra <key=value>]

表 11.358. 命令参数
概述

-h, --help

显示帮助信息并退出

--node <uuid>

此卷目标节点的 UUID。

--type <volume type>

卷目标的类型,如 iscsifibre_channel

--property <key=value>

与这个卷目标类型相关的键/值属性。可多次指定。

--boot-index <boot index>

卷目标的引导索引。

--volume-id <volume id>

与此目标关联的卷的 ID。

--uuid <uuid>

卷目标的 UUID。

--extra <key=value>

记录任意键/值元数据。可以多次指定。

表 11.359. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.360. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.361. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.362. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.99. 裸机卷目标删除

取消注册裸机卷目标。

使用方法:

openstack baremetal volume target delete [-h]
                                                <volume target>
                                                [<volume target> ...]

表 11.363. positional 参数
概述

<volume target>

要删除的卷目标的 UUID。

表 11.364. 命令参数
概述

-h, --help

显示帮助信息并退出

11.100. 裸机卷目标列表

列出 baremetal 卷目标。

使用方法:

openstack baremetal volume target list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              [--node <node>]
                                              [--limit <limit>]
                                              [--marker <volume target>]
                                              [--sort <key>[:<direction>]]
                                              [--long | --fields <field> [<field> ...]]

表 11.365. 命令参数
概述

-h, --help

显示帮助信息并退出

--node <node>

仅列出此节点的卷目标(名称或 uuid)。

--limit <limit>

每个请求返回的最大卷目标数,0 代表没有限制。默认是 Baremetal API Service 使用的最大数量。

--marker <volume target>

卷目标 uuid (例如,上一个请求列表中的最后一个卷目标)。在此 UUID 后返回卷目标列表。

--sort <key>[:<direction>]

根据指定卷目标字段和方向(asc 或 desc)排序输出(默认值:asasc)。可以指定多个字段和方向,用逗号分开。

--long

显示卷目标的详细信息。

--fields <field> [<field> …​]

一个或多个卷目标字段。只有这些字段将从服务器获取。指定 --long 时无法使用。

表 11.366. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 11.367. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 11.368. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.369. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.101. 裸机卷目标集

设置 baremetal 卷目标属性。

使用方法:

openstack baremetal volume target set [-h] [--node <uuid>]
                                             [--type <volume type>]
                                             [--property <key=value>]
                                             [--boot-index <boot index>]
                                             [--volume-id <volume id>]
                                             [--extra <key=value>]
                                             <volume target>

表 11.370. positional 参数
概述

<volume target>

卷目标的 UUID。

表 11.371. 命令参数
概述

-h, --help

显示帮助信息并退出

--node <uuid>

此卷目标节点的 UUID。

--type <volume type>

卷目标的类型,如 iscsifibre_channel

--property <key=value>

与这个卷目标类型相关的键/值属性。可多次指定。

--boot-index <boot index>

卷目标的引导索引。

--volume-id <volume id>

与此目标关联的卷的 ID。

--extra <key=value>

记录任意键/值元数据。可以多次指定。

11.102. 裸机卷目标显示

显示 baremetal 卷目标详情。

使用方法:

openstack baremetal volume target show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--fields <field> [<field> ...]]
                                              <id>

表 11.372. positional 参数
概述

<id>

卷目标的 UUID。

表 11.373. 命令参数
概述

-h, --help

显示帮助信息并退出

--fields <field> [<field> …​]

一个或多个卷目标字段。只有这些字段将从服务器获取。

表 11.374. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 11.375. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 11.376. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 11.377. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

11.103. baremetal 卷目标未设置

取消设置 baremetal 卷目标属性。

使用方法:

openstack baremetal volume target unset [-h] [--extra <key>]
                                               [--property <key>]
                                               <volume target>

表 11.378. positional 参数
概述

<volume target>

卷目标的 UUID。

表 11.379. 命令参数
概述

-h, --help

显示帮助信息并退出

--extra <key>

额外设置(需要取消设置多个额外的选项)

--property <key>

在此 baremetal 卷目标上取消设置的属性(需要取消设置多个属性)。

第 12 章 ca

本章描述了 ca 命令下的命令。

12.1. CA get

通过提供 URI 来检索 CA。

使用方法:

openstack ca get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                        [--noindent] [--prefix PREFIX] [--max-width <integer>]
                        [--fit-width] [--print-empty]
                        URI

表 12.1. positional 参数
概述

URI

ca 的 uri 引用。

表 12.2. 命令参数
概述

-h, --help

显示帮助信息并退出

表 12.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 12.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 12.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 12.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

12.2. ca list

列出 CA。

使用方法:

openstack ca list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                         [--quote {all,minimal,none,nonnumeric}] [--noindent]
                         [--max-width <integer>] [--fit-width] [--print-empty]
                         [--sort-column SORT_COLUMN] [--limit LIMIT]
                         [--offset OFFSET] [--name NAME]

表 12.7. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT, -l LIMIT

指定每个页面列出的项目数量的限制(默认为 10;最大:100)

--offset OFFSET, -o OFFSET

指定页面偏移(默认为 0)

--name NAME, -n NAME

指定 ca 名称(默认为 none)

表 12.8. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 12.9. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 12.10. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 12.11. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 13 章 catalog

本章描述了 catalog 命令下的命令。

13.1. 目录列表

列出服务目录中的服务

使用方法:

openstack catalog list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN]

表 13.1. 命令参数
概述

-h, --help

显示帮助信息并退出

表 13.2. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 13.3. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 13.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 13.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

13.2. 目录显示

显示服务目录详情

使用方法:

openstack catalog show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <service>

表 13.6. positional 参数
概述

<service>

要显示的服务(类型或名称)

表 13.7. 命令参数
概述

-h, --help

显示帮助信息并退出

表 13.8. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 13.9. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 13.10. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 13.11. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 14 章 Coe

本章描述了 coe 命令下的命令。

14.1. Coe ca rotate

轮转集群的 CA 证书以撤销访问。

使用方法:

openstack coe ca rotate [-h] <cluster>

表 14.1. positional 参数
概述

<cluster>

集群的 ID 或名称

表 14.2. 命令参数
概述

-h, --help

显示帮助信息并退出

14.2. Coe ca show

显示集群的 CA 证书详情。

使用方法:

openstack coe ca show [-h] <cluster>

表 14.3. positional 参数
概述

<cluster>

集群的 ID 或名称

表 14.4. 命令参数
概述

-h, --help

显示帮助信息并退出

14.3. Coe ca 符号

为集群生成 CA 证书。

使用方法:

openstack coe ca sign [-h] <cluster> <csr>

表 14.5. positional 参数
概述

<cluster>

集群的 ID 或名称

<csr>

要发送到 magnum 的 csr 文件的文件路径以被签名。

表 14.6. 命令参数
概述

-h, --help

显示帮助信息并退出

14.4. Coe 集群配置

获取集群的配置

使用方法:

openstack coe cluster config [-h] [--dir <dir>] [--force]
                                    [--output-certs] [--use-certificate]
                                    [--use-keystone]
                                    <cluster>

表 14.7. positional 参数
概述

<cluster>

要更新的集群的名称或 uuid

表 14.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--dir <dir>

保存证书和配置文件的目录。

--force

如果现有文件,则覆盖文件。

--output-certs

输出独立文件中的证书。

--use-certificate

在配置文件中使用证书。

--use-keystone

在配置文件中使用 keystone 令牌。

14.5. Coe 集群创建

创建集群

使用方法:

openstack coe cluster create [-h] --cluster-template <cluster-template>
                                    [--discovery-url <discovery-url>]
                                    [--docker-volume-size <docker-volume-size>]
                                    [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                    [--keypair <keypair>]
                                    [--master-count <master-count>]
                                    [--node-count <node-count>]
                                    [--timeout <timeout>]
                                    [--master-flavor <master-flavor>]
                                    [--flavor <flavor>]
                                    [--fixed-network <fixed-network>]
                                    [--fixed-subnet <fixed-subnet>]
                                    [--floating-ip-enabled]
                                    [--floating-ip-disabled]
                                    <name>

表 14.9. positional 参数
概述

<name>

要创建的集群的名称。

表 14.10. 命令参数
概述

-h, --help

显示帮助信息并退出

--cluster-template <cluster-template>

集群模板的 ID 或名称。

--discovery-url <discovery-url>

为节点发现指定自定义交付 url。

--docker-volume-size <docker-volume-size>

要使用的 docker 卷的 gb 大小。

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

以 key=valuepairs 形式的任意标签,以便与集群模板关联。可以多次使用。

--keypair <keypair>

要使用的密钥对的 UUID 或名称。

--master-count <master-count>

集群的 master 节点数量。

--node-count <node-count>

集群节点数。

--timeout <timeout>

集群创建时间超时。默认值为 60 分钟。

--master-flavor <master-flavor>

启动集群的主节点时要使用的 nova 类别名称或 uuid。

--flavor <flavor>

启动集群时要使用的 nova 类别名称或 uuid。

--fixed-network <fixed-network>

连接到此集群模板的私有 neutron 网络名称。

--fixed-subnet <fixed-subnet>

连接到集群的私有 neutron 子网名称。

--floating-ip-enabled

指明创建的集群是否应该具有浮动 ip。

--floating-ip-disabled

在新集群中禁用浮动 IP 创建

14.6. Coe 集群删除

删除集群

使用方法:

openstack coe cluster delete [-h] <cluster> [<cluster> ...]

表 14.11. positional 参数
概述

<cluster>

要删除的集群的 ID 或名称。

表 14.12. 命令参数
概述

-h, --help

显示帮助信息并退出

14.7. Coe 集群列表

列出集群

使用方法:

openstack coe cluster list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  [--limit <limit>] [--sort-key <sort-key>]
                                  [--sort-dir <sort-dir>]

表 14.13. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

要返回的集群的最大数量

--sort-key <sort-key>

列按以下顺序对结果进行排序

--sort-dir <sort-dir>

方向排序 "asc" 或 "desc"。

表 14.14. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 14.15. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 14.16. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 14.17. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

14.8. Coe 集群重新定义大小

调整集群大小

使用方法:

openstack coe cluster resize [-h] [--nodes-to-remove <Server UUID>]
                                    [--nodegroup <nodegroup>]
                                    <cluster> node_count

表 14.18. positional 参数
概述

<cluster>

要更新的集群的名称或 uuid

node_count

cluser 所需的节点数。

表 14.19. 命令参数
概述

-h, --help

显示帮助信息并退出

--nodes-to-remove <Server UUID>

要删除节点的服务器 ID。重复,以添加更多服务器 ID

--nodegroup <nodegroup>

当前集群的 nodegroup 的名称或 uuid。

14.9. Coe 集群显示

显示集群

使用方法:

openstack coe cluster show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <cluster>

表 14.20. positional 参数
概述

<cluster>

要显示集群的 ID 或名称。

表 14.21. 命令参数
概述

-h, --help

显示帮助信息并退出

表 14.22. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 14.23. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 14.24. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 14.25. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

14.10. Coe 集群模板创建

创建集群模板。

使用方法:

openstack coe cluster template create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             --coe <coe> --image <image>
                                             --external-network
                                             <external-network>
                                             [--keypair <keypair>]
                                             [--fixed-network <fixed-network>]
                                             [--fixed-subnet <fixed-subnet>]
                                             [--network-driver <network-driver>]
                                             [--volume-driver <volume-driver>]
                                             [--dns-nameserver <dns-nameserver>]
                                             [--flavor <flavor>]
                                             [--master-flavor <master-flavor>]
                                             [--docker-volume-size <docker-volume-size>]
                                             [--docker-storage-driver <docker-storage-driver>]
                                             [--http-proxy <http-proxy>]
                                             [--https-proxy <https-proxy>]
                                             [--no-proxy <no-proxy>]
                                             [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                             [--tls-disabled] [--public]
                                             [--registry-enabled]
                                             [--server-type <server-type>]
                                             [--master-lb-enabled]
                                             [--floating-ip-enabled]
                                             [--floating-ip-disabled]
                                             [--hidden] [--visible]
                                             <name>

表 14.26. positional 参数
概述

<name>

要创建的集群模板的名称。

表 14.27. 命令参数
概述

-h, --help

显示帮助信息并退出

--Coe <coe>

指定要使用的容器编配引擎。

--image <image>

用于为集群自定义的基础镜像的名称或 uuid。

--external-network <external-network>

连接到此 Cluster Template 的外部 neutron 网络名称或 uuid。

--keypair <keypair>

加载到集群节点的 ssh 密钥对的名称或 uuid。

--fixed-network <fixed-network>

连接到此 Cluster 模型的专用 neutron 网络名称。

--fixed-subnet <fixed-subnet>

连接到集群的私有 neutron 子网名称。

--network-driver <network-driver>

用于实例化容器网络的网络驱动程序名称。

--volume-driver <volume-driver>

用于实例化容器卷的卷驱动程序名称。

--dns-nameserver <dns-nameserver>

用于此集群模板的 dns 名称服务器。

--flavor <flavor>

启动集群时要使用的 nova 类别名称或 uuid。

--master-flavor <master-flavor>

启动集群的主节点时要使用的 nova 类别名称或 uuid。

--docker-volume-size <docker-volume-size>

指定要使用的 docker 卷的大小(以 gb 为单位)。

--docker-storage-driver <docker-storage-driver>

选择一个 docker storage driver. supported: devicemapper, overlay。默认:devicemapper

--http-proxy <http-proxy>

用于集群中节点的 http_proxy 地址。

--https-proxy <https-proxy>

用于集群中节点的 https_proxy 地址。

--no-proxy <no-proxy>

用于集群中节点的 no_proxy 地址。

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

以 key=value 对形式的任意标签,以便与集群模板关联。可以多次使用。

--tls-disabled

禁用集群中的 tls。

--public

使集群模板变为公共。

--registry-enabled

在集群中启用 docker registry

--server-type <server-type>

指定要使用的服务器类型,如 vm。对于这个版本的默认服务器类型,将是 vm。

--master-lb-enabled

指明创建的集群是否应该具有 master 节点的负载均衡器。

--floating-ip-enabled

指明创建的集群是否应该具有浮动 ip。

--floating-ip-disabled

在新集群中禁用浮动 IP 创建

--hidden

表示集群模板应该隐藏。

--visible

表示集群模板应该可见。

表 14.28. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 14.29. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 14.30. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 14.31. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

14.11. Coe 集群模板删除

删除集群模板。

使用方法:

openstack coe cluster template delete [-h]
                                             <cluster-templates>
                                             [<cluster-templates> ...]

表 14.32. positional 参数
概述

<cluster-templates>

要删除的(集群模板)的 ID 或名称。

表 14.33. 命令参数
概述

-h, --help

显示帮助信息并退出

14.12. Coe 集群模板列表

列出集群模板。

使用方法:

openstack coe cluster template list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           [--limit <limit>]
                                           [--sort-key <sort-key>]
                                           [--sort-dir <sort-dir>]
                                           [--fields <fields>]

表 14.34. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

要返回的集群模板的最大数量

--sort-key <sort-key>

列按以下顺序对结果进行排序

--sort-dir <sort-dir>

方向排序 "asc" 或 "desc"。

--fields <fields>

要显示的以逗号分隔的字段列表。可用字段:uuid、name、coe、image_id、public、link、apiserver_port、server_type、tls_disabled、registry_enabled

表 14.35. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 14.36. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 14.37. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 14.38. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

14.13. Coe 集群模板显示

显示集群模板。

使用方法:

openstack coe cluster template show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           <cluster-template>

表 14.39. positional 参数
概述

<cluster-template>

要显示的集群模板的 ID 或名称。

表 14.40. 命令参数
概述

-h, --help

显示帮助信息并退出

表 14.41. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 14.42. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 14.43. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 14.44. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

14.14. Coe 集群模板更新

更新集群模板。

使用方法:

openstack coe cluster template update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <cluster-template> <op>
                                             <path=value> [<path=value> ...]

表 14.45. positional 参数
概述

<cluster-template>

要更新的集群模板的 name 或 uuid

<op>

operations: 添加替换 或删除

<path=value>

添加/替换或删除的属性(删除时只需要路径)

表 14.46. 命令参数
概述

-h, --help

显示帮助信息并退出

表 14.47. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 14.48. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 14.49. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 14.50. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

14.15. Coe 集群更新

更新集群

使用方法:

openstack coe cluster update [-h] [--rollback]
                                    <cluster> <op> <path=value>
                                    [<path=value> ...]

表 14.51. positional 参数
概述

<cluster>

要更新的集群的名称或 uuid

<op>

operations: 添加替换 或删除

<path=value>

添加/替换或删除的属性(删除时只需要路径)

表 14.52. 命令参数
概述

-h, --help

显示帮助信息并退出

--rollback

更新失败时回滚集群。

14.16. Coe 集群升级

升级集群

使用方法:

openstack coe cluster upgrade [-h] [--max-batch-size <max_batch_size>]
                                     [--nodegroup <nodegroup>]
                                     <cluster> cluster_template

表 14.53. positional 参数
概述

<cluster>

要更新的集群的名称或 uuid

cluster_template

新集群模板 ID 将升级到。

表 14.54. 命令参数
概述

-h, --help

显示帮助信息并退出

--max-batch-size <max_batch_size>

每次升级的最大批处理大小。

--nodegroup <nodegroup>

当前集群的 nodegroup 的名称或 uuid。

14.17. Coe nodegroup create

创建 nodegroup

使用方法:

openstack coe nodegroup create [-h]
                                      [--docker-volume-size <docker-volume-size>]
                                      [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                      [--node-count <node-count>]
                                      [--min-nodes <min-nodes>]
                                      [--max-nodes <max-nodes>]
                                      [--role <role>] [--image <image>]
                                      [--flavor <flavor>]
                                      <cluster> <name>

表 14.55. positional 参数
概述

<cluster>

要创建的节点组的名称。

<name>

要创建的节点组的名称。

表 14.56. 命令参数
概述

-h, --help

显示帮助信息并退出

--docker-volume-size <docker-volume-size>

要使用的 docker 卷的 gb 大小。

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

key=valuepairs 形式的任意标签,与 nodegroup 关联。可以多次使用。

--node-count <node-count>

nodegroup 节点数。

--min-nodes <min-nodes>

nodegroup 最小节点数。

--max-nodes <max-nodes>

nodegroup 最大节点数。

--role <role>

nodegroup 的角色

--image <image>

要为 NodeGroup 自定义基础镜像的名称或 uuid。

--flavor <flavor>

在此 NodeGroup 中启动节点时要使用的 nova 类别名称或 uuid。

14.18. Coe nodegroup delete

删除 nodegroup

使用方法:

openstack coe nodegroup delete [-h]
                                      <cluster> <nodegroup> [<nodegroup> ...]

表 14.57. positional 参数
概述

<cluster>

nodegroup 所属集群的 ID 或名称。

<nodegroup>

要删除的 nodegroup 的 ID 或名称。

表 14.58. 命令参数
概述

-h, --help

显示帮助信息并退出

14.19. Coe nodegroup list

列出节点组

使用方法:

openstack coe nodegroup list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--limit <limit>] [--sort-key <sort-key>]
                                    [--sort-dir <sort-dir>] [--role <role>]
                                    <cluster>

表 14.59. positional 参数
概述

<cluster>

nodegroup 所属集群的 ID 或名称。

表 14.60. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

要返回的最大节点组数

--sort-key <sort-key>

列按以下顺序对结果进行排序

--sort-dir <sort-dir>

方向排序 "asc" 或 "desc"。

--role <role>

使用此角色列出集群中的节点组

表 14.61. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 14.62. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 14.63. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 14.64. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

14.20. Coe nodegroup show

显示 nodegroup

使用方法:

openstack coe nodegroup show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <cluster> <nodegroup>

表 14.65. positional 参数
概述

<cluster>

nodegroup 所属集群的 ID 或名称。

<nodegroup>

要显示的节点组的 ID 或名称。

表 14.66. 命令参数
概述

-h, --help

显示帮助信息并退出

表 14.67. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 14.68. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 14.69. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 14.70. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

14.21. Coe nodegroup 更新

更新 Nodegroup

使用方法:

openstack coe nodegroup update [-h]
                                      <cluster> <nodegroup> <op> <path=value>
                                      [<path=value> ...]

表 14.71. positional 参数
概述

<cluster>

nodegroup 所属集群的 ID 或名称。

<nodegroup>

要更新的集群的名称或 uuid

<op>

operations: 添加替换 或删除

<path=value>

添加/替换或删除的属性(删除时只需要路径)

表 14.72. 命令参数
概述

-h, --help

显示帮助信息并退出

14.22. Coe 配额创建

创建配额。

使用方法:

openstack coe quotas create [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

表 14.73. 命令参数
概述

-h, --help

显示帮助信息并退出

--project-id <project-id>

项目 ID

--resource <resource>

资源名称。

--hard-limit <hard-limit>

最大资源限值(默认: hard-limit=1)

14.23. Coe 配额删除

删除指定的资源配额。

使用方法:

openstack coe quotas delete [-h] --project-id <project-id> --resource
                                   <resource>

表 14.74. 命令参数
概述

-h, --help

显示帮助信息并退出

--project-id <project-id>

项目 ID

--resource <resource>

资源名称。

14.24. Coe 配额列表

显示可用配额的列表。

使用方法:

openstack coe quotas list [-h] [--marker <marker>] [--limit <limit>]
                                 [--sort-key <sort-key>]
                                 [--sort-dir <sort-dir>] [--all-tenants]

表 14.75. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker <marker>

上一页的最后配额 uuid ;在"marker"后显示配额列表。

--limit <limit>

要返回的最大配额数。

--sort-key <sort-key>

列按以下顺序对结果进行排序。

--sort-dir <sort-dir>

方向排序 "asc" 或 "desc"。

--all-tenants

用于表示列出所有租户配额的标志。

14.25. Coe 配额显示

显示给定项目资源配额的详细信息。

使用方法:

openstack coe quotas show [-h] --project-id <project-id> --resource
                                 <resource>

表 14.76. 命令参数
概述

-h, --help

显示帮助信息并退出

--project-id <project-id>

项目 ID

--resource <resource>

资源名称。

14.26. Coe 配额更新

更新有关给定项目资源配额的信息。

使用方法:

openstack coe quotas update [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

表 14.77. 命令参数
概述

-h, --help

显示帮助信息并退出

--project-id <project-id>

项目 ID

--resource <resource>

资源名称。

--hard-limit <hard-limit>

最大资源限值(默认: hard-limit=1)

14.27. Coe 服务列表

显示 Magnum 服务列表。

使用方法:

openstack coe service list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]

表 14.78. 命令参数
概述

-h, --help

显示帮助信息并退出

表 14.79. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 14.80. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 14.81. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 14.82. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

14.28. Coe stats list

显示给定 project_id 的统计信息

使用方法:

openstack coe stats list [-h] <project>

表 14.83. positional 参数
概述

<project>

项目 ID

表 14.84. 命令参数
概述

-h, --help

显示帮助信息并退出

第 15 章 命令

本章描述了 command 命令下的 命令

15.1. 命令列表

按组群列出可识别的命令

使用方法:

openstack command list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN]
                              [--group <group-keyword>]

表 15.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--group <group-keyword>

显示按命令组过滤的命令,例如:身份、卷、计算、镜像、网络和其他关键字

表 15.2. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 15.3. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 15.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 15.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 16 章 complete

本章描述了完成命令下的命令。

16.1. complete

打印 bash completion 命令

使用方法:

openstack complete [-h] [--name <command_name>] [--shell <shell>]

表 16.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <command_name>

支持命令完成的命令名称

--shell <shell>

使用的 shell。仅对数据使用 none (默认: bash)

第 17 章 Compute

本章描述了 compute 命令下的命令。

17.1. 计算代理创建

创建计算代理

使用方法:

openstack compute agent create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <os> <architecture> <version> <url>
                                      <md5hash> <hypervisor>

表 17.1. positional 参数
概述

<os>

os 类型

<architecture>

架构类型

<version>

Version

<url>

URL

<md5hash>

Md5 hash

<hypervisor>

hypervisor 类型

表 17.2. 命令参数
概述

-h, --help

显示帮助信息并退出

表 17.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 17.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 17.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 17.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

17.2. 计算代理删除

删除计算代理

使用方法:

openstack compute agent delete [-h] <id> [<id> ...]

表 17.7. positional 参数
概述

<id>

要删除的代理 ID

表 17.8. 命令参数
概述

-h, --help

显示帮助信息并退出

17.3. 计算代理列表

列出计算代理

使用方法:

openstack compute agent list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--hypervisor <hypervisor>]

表 17.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--hypervisor <hypervisor>

hypervisor 类型

表 17.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 17.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 17.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 17.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

17.4. 计算代理设置

设置计算代理属性

使用方法:

openstack compute agent set [-h] [--agent-version <version>]
                                   [--url <url>] [--md5hash <md5hash>]
                                   <id>

表 17.14. positional 参数
概述

<id>

代理 ID

表 17.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--agent-version <version>

代理的版本

--url <url>

代理的 URL

--md5hash <md5hash>

代理 Md5 哈希

17.5. Compute 服务删除

删除计算服务

使用方法:

openstack compute service delete [-h] <service> [<service> ...]

表 17.16. positional 参数
概述

<service>

要删除的计算服务(仅限)。如果使用 '--os-compute- api-version' 2.53 或更高版本,则 ID 是一个 UUID,它可以通过使用相同的 2.53+ 微版本列出计算服务来检索。

表 17.17. 命令参数
概述

-h, --help

显示帮助信息并退出

17.6. Compute 服务列表

列出计算服务。使用 ''--os-compute-api-version'' 2.53 或更高版本会将 ID 返回为 UUID 值,它可用于在多单元部署中唯一标识该服务。

使用方法:

openstack compute service list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--host <host>] [--service <service>]
                                      [--long]

表 17.18. 命令参数
概述

-h, --help

显示帮助信息并退出

--host <host>

列出指定主机上的服务(仅限名称)

--service <service>

仅列出指定的服务二进制文件(仅限)。例如,'nova-compute''、'nova-conductor'' 等。

--long

列出输出中的其他字段

表 17.19. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 17.20. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 17.21. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 17.22. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

17.7. 计算服务集

设置计算服务属性

使用方法:

openstack compute service set [-h] [--enable | --disable]
                                     [--disable-reason <reason>]
                                     [--up | --down]
                                     <host> <service>

表 17.23. positional 参数
概述

<host>

主机的名称

<service>

服务的名称(二进制名称),如 ''nova- compute'

表 17.24. 命令参数
概述

-h, --help

显示帮助信息并退出

--enable

启用服务

--disable

禁用服务

--disable-reason <reason>

禁用服务(引号)的原因。应当与 --disable 选项一起使用。

--up

强制服务。需要 '--os-compute-api- version' 2.11 或更高版本。

--down

强制关闭服务。需要 '--os-compute-api- version' 2.11 或更高版本。

第 18 章 配置

本章描述了 配置 命令下的命令。

18.1. 配置显示

显示配置详情

使用方法:

openstack configuration show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--mask | --unmask]

表 18.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--mask

尝试屏蔽密码(默认)

--unmask

以明文形式显示密码

表 18.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 18.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 18.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 18.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 19 章 一致性

本章论述了 consistency 命令下的命令。

19.1. 一致性组添加卷

将卷添加到一致性组

使用方法:

openstack consistency group add volume [-h]
                                              <consistency-group> <volume>
                                              [<volume> ...]

表 19.1. positional 参数
概述

<consistency-group>

包含 <volume> (名称或 id)的一致性组

<volume>

要添加到 <consistency-group> (名称或 id)的卷(重复添加多个卷)

表 19.2. 命令参数
概述

-h, --help

显示帮助信息并退出

19.2. 一致性组创建

创建新的一致性组。

使用方法:

openstack consistency group create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          (--volume-type <volume-type> | --consistency-group-source <consistency-group> | --consistency-group-snapshot <consistency-group-snapshot>)
                                          [--description <description>]
                                          [--availability-zone <availability-zone>]
                                          [<name>]

表 19.3. positional 参数
概述

<name>

新一致性组的名称(默认为 none)

表 19.4. 命令参数
概述

-h, --help

显示帮助信息并退出

--volume-type <volume-type>

此一致性组的卷类型(名称或 id)

--consistency-group-source <consistency-group>

现有一致性组(名称或 id)

--consistency-group-snapshot <consistency-group-snapshot>

现有一致性组快照(名称或 id)

--description <description>

此一致性组的描述

--availability-zone <availability-zone>

此一致性组的可用区(如果从源创建一致性组,则不可用)

表 19.5. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 19.6. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 19.7. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 19.8. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

19.3. 一致性组删除

删除一致性组。

使用方法:

openstack consistency group delete [-h] [--force]
                                          <consistency-group>
                                          [<consistency-group> ...]

表 19.9. positional 参数
概述

<consistency-group>

要删除的一致性组(名称或 id)

表 19.10. 命令参数
概述

-h, --help

显示帮助信息并退出

--force

允许以 error 或 available 以外的状态删除

19.4. 一致性组列表

列出一致性组。

使用方法:

openstack consistency group list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--all-projects] [--long]

表 19.11. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的详细信息。只有 admin。(默认为 False)

--long

列出输出中的其他字段

表 19.12. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 19.13. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 19.14. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 19.15. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

19.5. 一致性组删除卷

从一致性组中删除卷

使用方法:

openstack consistency group remove volume [-h]
                                                 <consistency-group> <volume>
                                                 [<volume> ...]

表 19.16. positional 参数
概述

<consistency-group>

包含 <volume> (名称或 id)的一致性组

<volume>

从 <consistency-group> (名称或 ID)中删除的卷(重复删除多个卷)

表 19.17. 命令参数
概述

-h, --help

显示帮助信息并退出

19.6. 一致性组集

设置一致性组属性

使用方法:

openstack consistency group set [-h] [--name <name>]
                                       [--description <description>]
                                       <consistency-group>

表 19.18. positional 参数
概述

<consistency-group>

要修改的一致性组(名称或 id)

表 19.19. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新的一致性组名称

--description <description>

新的一致性组描述

19.7. 一致性组显示

显示一致性组详情。

使用方法:

openstack consistency group show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <consistency-group>

表 19.20. positional 参数
概述

<consistency-group>

要显示的一致性组(名称或 id)

表 19.21. 命令参数
概述

-h, --help

显示帮助信息并退出

表 19.22. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 19.23. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 19.24. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 19.25. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

19.8. 一致性组快照创建

创建新的一致性组快照。

使用方法:

openstack consistency group snapshot create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--consistency-group <consistency-group>]
                                                   [--description <description>]
                                                   [<snapshot-name>]

表 19.26. positional 参数
概述

<snapshot-name>

新一致性组名称快照(默认为 None)

表 19.27. 命令参数
概述

-h, --help

显示帮助信息并退出

--consistency-group <consistency-group>

一致性组到快照(名称或 id)(默认为 <snapshot-name>)

--description <description>

这个一致性组快照的描述

表 19.28. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 19.29. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 19.30. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 19.31. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

19.9. 一致性组快照删除

删除一致性组快照。

使用方法:

openstack consistency group snapshot delete [-h]
                                                   <consistency-group-snapshot>
                                                   [<consistency-group-snapshot> ...]

表 19.32. positional 参数
概述

<consistency-group-snapshot>

要删除的一致性组快照(名称或 id)

表 19.33. 命令参数
概述

-h, --help

显示帮助信息并退出

19.10. 一致性组快照列表

列出一致性组快照。

使用方法:

openstack consistency group snapshot list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]
                                                 [--all-projects] [--long]
                                                 [--status <status>]
                                                 [--consistency-group <consistency-group>]

表 19.34. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目(仅限管理员)的详情(默认为 False)

--long

列出输出中的其他字段

--status <status>

按状态("available", "error", "creating", "deleting" 或 "error_deleting")过滤结果

--consistency-group <consistency-group>

按一致性组(名称或 id)过滤结果

表 19.35. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 19.36. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 19.37. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 19.38. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

19.11. 一致性组快照显示

显示一致性组快照详情

使用方法:

openstack consistency group snapshot show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 <consistency-group-snapshot>

表 19.39. positional 参数
概述

<consistency-group-snapshot>

要显示一致性组快照(名称或 id)

表 19.40. 命令参数
概述

-h, --help

显示帮助信息并退出

表 19.41. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 19.42. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 19.43. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 19.44. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 20 章 控制台

本章论述了 console 命令下的命令。

20.1. 控制台日志显示

显示服务器的控制台输出

使用方法:

openstack console log show [-h] [--lines <num-lines>] <server>

表 20.1. positional 参数
概述

<server>

服务器以显示控制台日志(名称或 id)

表 20.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--lines <num-lines>

从日志末尾显示的行数(default=all)

20.2. 控制台 url 显示

显示服务器的远程控制台 URL

使用方法:

openstack console url show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  [--novnc | --xvpvnc | --spice | --rdp | --serial | --mks]
                                  <server>

表 20.3. positional 参数
概述

<server>

服务器以显示 url (名称或 id)

表 20.4. 命令参数
概述

-h, --help

显示帮助信息并退出

--novnc

显示没有vnc 控制台 url (默认)

--xvpvnc

显示 xvpvnc 控制台 url

--spice

显示 spice 控制台 url

--rdp

show rdp console url

--serial

显示串行控制台 url

--mks

显示 webmks 控制台 url

表 20.5. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 20.6. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 20.7. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 20.8. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 21 章 consumer

本章描述了 consumer 命令下的命令。

21.1. 消费者创建

创建新消费者

使用方法:

openstack consumer create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--description <description>]

表 21.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

新的消费者描述

表 21.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 21.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 21.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 21.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

21.2. 消费者删除

删除消费者

使用方法:

openstack consumer delete [-h] <consumer> [<consumer> ...]

表 21.6. positional 参数
概述

<consumer>

要删除的消费者

表 21.7. 命令参数
概述

-h, --help

显示帮助信息并退出

21.3. 消费者列表

列出消费者

使用方法:

openstack consumer list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN]

表 21.8. 命令参数
概述

-h, --help

显示帮助信息并退出

表 21.9. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 21.10. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 21.11. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 21.12. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

21.4. 消费者集

设置消费者属性

使用方法:

openstack consumer set [-h] [--description <description>] <consumer>

表 21.13. positional 参数
概述

<consumer>

要修改的消费者

表 21.14. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

新的消费者描述

21.5. 消费者显示

显示消费者详情

使用方法:

openstack consumer show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               <consumer>

表 21.15. positional 参数
概述

<consumer>

要显示的消费者

表 21.16. 命令参数
概述

-h, --help

显示帮助信息并退出

表 21.17. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 21.18. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 21.19. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 21.20. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 22 章 container

本章描述了 container 命令下的命令。

22.1. 容器创建

创建新容器

使用方法:

openstack container create [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  <container-name> [<container-name> ...]

表 22.1. positional 参数
概述

<container-name>

新容器名称

表 22.2. 命令参数
概述

-h, --help

显示帮助信息并退出

表 22.3. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 22.4. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 22.5. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 22.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

22.2. 容器删除

删除容器

使用方法:

openstack container delete [-h] [--recursive]
                                  <container> [<container> ...]

表 22.7. positional 参数
概述

<Container>

要删除的容器

表 22.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--recursion, -r

递归删除对象和容器

22.3. 容器列表

列出容器

使用方法:

openstack container list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--noindent] [--max-width <integer>]
                                [--fit-width] [--print-empty]
                                [--sort-column SORT_COLUMN]
                                [--prefix <prefix>] [--marker <marker>]
                                [--end-marker <end-marker>]
                                [--limit <num-containers>] [--long] [--all]

表 22.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--prefix <prefix>

使用 <prefix> 过滤列表

--marker <marker>

分页的 Anchor

--end-marker <end-marker>

分页的端点

--limit <num-containers>

限制返回的容器数量

--long

列出输出中的其他字段

--all

列出所有容器(默认为 10000)

表 22.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 22.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 22.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 22.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

22.4. 容器保存

本地保存容器内容

使用方法:

openstack container save [-h] <container>

表 22.14. positional 参数
概述

<Container>

要保存的容器

表 22.15. 命令参数
概述

-h, --help

显示帮助信息并退出

22.5. 容器集

设置容器属性

使用方法:

openstack container set [-h] --property <key=value> <container>

表 22.16. positional 参数
概述

<Container>

要修改的容器

表 22.17. 命令参数
概述

-h, --help

显示帮助信息并退出

--property <key=value>

在此容器上设置属性(重复选项来设置多个属性)

22.6. 容器显示

显示容器详情

使用方法:

openstack container show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                <container>

表 22.18. positional 参数
概述

<Container>

要显示的容器

表 22.19. 命令参数
概述

-h, --help

显示帮助信息并退出

表 22.20. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 22.21. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 22.22. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 22.23. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

22.7. 容器取消设置

取消设置容器属性

使用方法:

openstack container unset [-h] --property <key> <container>

表 22.24. positional 参数
概述

<Container>

要修改的容器

表 22.25. 命令参数
概述

-h, --help

显示帮助信息并退出

--property <key>

要从容器中删除的属性(重复选项来删除多个属性)

第 23 章 credential

本章描述了 credential 命令下的命令。

23.1. 凭证创建

创建新凭证

使用方法:

openstack credential create [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty] [--type <type>]
                                   [--project <project>]
                                   <user> <data>

表 23.1. positional 参数
概述

<user>

拥有凭证的用户(名称或 id)

<data>

新凭证数据

表 23.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--type <type>

新凭证类型:cert、ec2、totp 等

--project <project>

限制凭证范围的项目(名称或 ID)

表 23.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 23.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 23.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 23.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

23.2. 凭证删除

删除凭证

使用方法:

openstack credential delete [-h] <credential-id> [<credential-id> ...]

表 23.7. positional 参数
概述

<credential-id>

要删除的凭证 ID

表 23.8. 命令参数
概述

-h, --help

显示帮助信息并退出

23.3. 凭证列表

列出凭证

使用方法:

openstack credential list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN] [--user <user>]
                                 [--user-domain <user-domain>] [--type <type>]

表 23.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--user <user>

按 <user> (名称或 id)过滤凭证

--user-domain <user-domain>

用户所属的域(名称或 id)。这可用于在用户名之间存在冲突时使用。

--type <type>

根据 type: cert, ec2, totp 等过滤凭证

表 23.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 23.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 23.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 23.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

23.4. 凭证集

设置凭证属性

使用方法:

openstack credential set [-h] --user <user> --type <type> --data <data>
                                [--project <project>]
                                <credential-id>

表 23.14. positional 参数
概述

<credential-id>

要更改的凭证 ID

表 23.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--user <user>

拥有凭证的用户(名称或 id)

--type <type>

新凭证类型:cert、ec2、totp 等

--data <data>

新凭证数据

--project <project>

限制凭证范围的项目(名称或 ID)

23.5. 凭证显示

显示凭证详情

使用方法:

openstack credential show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <credential-id>

表 23.16. positional 参数
概述

<credential-id>

要显示的凭证 ID

表 23.17. 命令参数
概述

-h, --help

显示帮助信息并退出

表 23.18. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 23.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 23.20. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 23.21. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 24 章 cron

本章描述了 cron 命令下的命令。

24.1. Cron trigger create

创建新触发器。

使用方法:

openstack cron trigger create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--params PARAMS] [--pattern <* * * * *>]
                                     [--first-time <YYYY-MM-DD HH:MM>]
                                     [--count <integer>] [--utc]
                                     name workflow_identifier [workflow_input]

表 24.1. positional 参数
概述

name

Cron 触发器名称

workflow_identifier

工作流名称或 ID

workflow_input

工作流输入

表 24.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--params PARAMS

工作流参数

--pattern <* * * * *>

Cron 触发器模式

--first-time <YYYY-MM-DD HH:MM>

第一次执行的日期和时间。除非也指定了 --utc

--count <integer>

需要执行的数量

--utc

指定的所有时间都应被视为 utc

表 24.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 24.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 24.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 24.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

24.2. Cron trigger delete

删除触发器。

使用方法:

openstack cron trigger delete [-h] cron_trigger [cron_trigger ...]

表 24.7. positional 参数
概述

cron_trigger

cron 触发器的名称。

表 24.8. 命令参数
概述

-h, --help

显示帮助信息并退出

24.3. Cron trigger list

列出所有 cron 触发器。

使用方法:

openstack cron trigger list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--marker [MARKER]] [--limit [LIMIT]]
                                   [--sort_keys [SORT_KEYS]]
                                   [--sort_dirs [SORT_DIRS]]
                                   [--filter FILTERS]

表 24.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

上一页的最后执行 uuid 显示在"marker"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

以逗号分隔的排序键列表,按以下方式对结果进行排序。默认: created_at。示例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序方向列表。默认为 asc。示例:mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

filters. 可以重复。

表 24.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 24.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 24.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 24.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

24.4. Cron trigger show

显示特定的 cron 触发器。

使用方法:

openstack cron trigger show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   cron_trigger

表 24.14. positional 参数
概述

cron_trigger

Cron 触发器名称

表 24.15. 命令参数
概述

-h, --help

显示帮助信息并退出

表 24.16. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 24.17. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 24.18. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 24.19. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 25 章 Datastore

本章描述了 datastore 命令下的命令。

25.1. Datastore list

列出可用的数据存储

使用方法:

openstack datastore list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--noindent] [--max-width <integer>]
                                [--fit-width] [--print-empty]
                                [--sort-column SORT_COLUMN]

表 25.1. 命令参数
概述

-h, --help

显示帮助信息并退出

表 25.2. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 25.3. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 25.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 25.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

25.2. Datastore show

显示数据存储的详情

使用方法:

openstack datastore show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                <datastore>

表 25.6. positional 参数
概述

<datastore>

数据存储 ID

表 25.7. 命令参数
概述

-h, --help

显示帮助信息并退出

表 25.8. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 25.9. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 25.10. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 25.11. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

25.3. 数据存储版本列表

列出数据存储的可用版本

使用方法:

openstack datastore version list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        <datastore>

表 25.12. positional 参数
概述

<datastore>

数据存储的 ID 或名称

表 25.13. 命令参数
概述

-h, --help

显示帮助信息并退出

表 25.14. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 25.15. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 25.16. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 25.17. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

25.4. 数据存储版本显示

显示数据存储版本的详细信息。

使用方法:

openstack datastore version show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--datastore <datastore>]
                                        <datastore_version>

表 25.18. positional 参数
概述

<datastore_version>

数据存储版本的 ID 或名称。

表 25.19. 命令参数
概述

-h, --help

显示帮助信息并退出

--datastore <datastore>

数据存储的 ID 或名称。如果提供了 datastore_version 的 id,则可选。

表 25.20. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 25.21. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 25.22. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 25.23. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 26 章 dns

本章描述了 dns 命令下的命令。

26.1. DNS 配额列表

列出配额

使用方法:

openstack dns quota list [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                [--project-id PROJECT_ID]

表 26.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

--project-id PROJECT_ID

项目 ID 默认:当前项目

表 26.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 26.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 26.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 26.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

26.2. DNS 配额重置

重置配额

使用方法:

openstack dns quota reset [-h] [--all-projects] [--edit-managed]
                                 [--sudo-project-id SUDO_PROJECT_ID]
                                 [--project-id PROJECT_ID]

表 26.6. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

--project-id PROJECT_ID

项目 ID

26.3. DNS 配额集

设置配额

使用方法:

openstack dns quota set [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--all-projects]
                               [--edit-managed]
                               [--sudo-project-id SUDO_PROJECT_ID]
                               [--project-id PROJECT_ID]
                               [--api-export-size <api-export-size>]
                               [--recordset-records <recordset-records>]
                               [--zone-records <zone-records>]
                               [--zone-recordsets <zone-recordsets>]
                               [--zones <zones>]

表 26.7. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

--project-id PROJECT_ID

项目 ID

--api-export-size <api-export-size>

api-export-size 配额的新值

--recordset-records <recordset-records>

recordset-records 配额的新值

--zone-records <zone-records>

zone-records 配额的新值

--zone-recordsets <zone-recordsets>

zone-recordsets 配额的新值

--zones <zones>

zones 配额的新值

表 26.8. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 26.9. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 26.10. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 26.11. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

26.4. DNS 服务列表

列出服务状态

使用方法:

openstack dns service list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  [--hostname HOSTNAME]
                                  [--service_name SERVICE_NAME]
                                  [--status STATUS] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]

表 26.12. 命令参数
概述

-h, --help

显示帮助信息并退出

--hostname HOSTNAME

主机名

--service_name SERVICE_NAME

服务名称

--status STATUS

Status

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 26.13. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 26.14. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 26.15. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 26.16. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

26.5. DNS 服务显示

显示服务状态详情

使用方法:

openstack dns service show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  id

表 26.17. positional 参数
概述

id

服务状态 ID

表 26.18. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 26.19. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 26.20. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 26.21. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 26.22. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 27 章 domain

本章描述了 domain 命令下的命令。

27.1. 域创建

创建新域

使用方法:

openstack domain create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--description <description>]
                               [--enable | --disable] [--or-show]
                               <domain-name>

表 27.1. positional 参数
概述

<domain-name>

新域名

表 27.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

新域描述

--enable

启用域(默认)

--disable

禁用域

--or-show

返回现有域

表 27.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 27.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 27.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 27.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

27.2. 域删除

删除域

使用方法:

openstack domain delete [-h] <domain> [<domain> ...]

表 27.7. positional 参数
概述

<domain>

要删除的域(名称或 id)

表 27.8. 命令参数
概述

-h, --help

显示帮助信息并退出

27.3. 域列表

列出域

使用方法:

openstack domain list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN]

表 27.9. 命令参数
概述

-h, --help

显示帮助信息并退出

表 27.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 27.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 27.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 27.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

27.4. 域集

设置域属性

使用方法:

openstack domain set [-h] [--name <name>] [--description <description>]
                            [--enable | --disable]
                            <domain>

表 27.14. positional 参数
概述

<domain>

要修改的域(名称或 id)

表 27.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新域名

--description <description>

新域描述

--enable

启用域

--disable

禁用域

27.5. 域显示

显示域详情

使用方法:

openstack domain show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <domain>

表 27.16. positional 参数
概述

<domain>

要显示的域(名称或 id)

表 27.17. 命令参数
概述

-h, --help

显示帮助信息并退出

表 27.18. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 27.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 27.20. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 27.21. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 28 章 ec2

本章描述了 ec2 命令下的命令。

28.1. ec2 凭证创建

创建 EC2 凭证

使用方法:

openstack ec2 credentials create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--project <project>]
                                        [--user <user>]
                                        [--user-domain <user-domain>]
                                        [--project-domain <project-domain>]

表 28.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

在项目中创建凭证(名称或 id;默认:当前经过身份验证的项目)

--user <user>

为用户创建凭证(名称或 id;默认:当前经过身份验证的用户)

--user-domain <user-domain>

用户所属的域(名称或 id)。这可用于在用户名之间存在冲突时使用。

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

表 28.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 28.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 28.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 28.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

28.2. ec2 凭证删除

删除 EC2 凭证

使用方法:

openstack ec2 credentials delete [-h] [--user <user>]
                                        [--user-domain <user-domain>]
                                        <access-key> [<access-key> ...]

表 28.6. positional 参数
概述

<access-key>

凭证访问密钥

表 28.7. 命令参数
概述

-h, --help

显示帮助信息并退出

--user <user>

删除用户的凭证(名称或 id)

--user-domain <user-domain>

用户所属的域(名称或 id)。这可用于在用户名之间存在冲突时使用。

28.3. ec2 凭证列表

列出 EC2 凭证

使用方法:

openstack ec2 credentials list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--user <user>]
                                      [--user-domain <user-domain>]

表 28.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--user <user>

按用户过滤列表(名称或 id)

--user-domain <user-domain>

用户所属的域(名称或 id)。这可用于在用户名之间存在冲突时使用。

表 28.9. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 28.10. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 28.11. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 28.12. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

28.4. ec2 凭证显示

显示 EC2 凭证详情

使用方法:

openstack ec2 credentials show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--user <user>]
                                      [--user-domain <user-domain>]
                                      <access-key>

表 28.13. positional 参数
概述

<access-key>

凭证访问密钥

表 28.14. 命令参数
概述

-h, --help

显示帮助信息并退出

--user <user>

显示用户的凭证(名称或 id)

--user-domain <user-domain>

用户所属的域(名称或 id)。这可用于在用户名之间存在冲突时使用。

表 28.15. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 28.16. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 28.17. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 28.18. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 29 章 端点

本章描述了 endpoint 命令下的命令。

29.1. endpoint add project

将项目与端点关联

使用方法:

openstack endpoint add project [-h] [--project-domain <project-domain>]
                                      <endpoint> <project>

表 29.1. positional 参数
概述

<endpoint>

与指定项目关联的端点(名称或 ID)

<project>

与指定端点名称或 ID 关联的项目

表 29.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

29.2. 端点创建

创建新端点

使用方法:

openstack endpoint create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--region <region-id>]
                                 [--enable | --disable]
                                 <service> <interface> <url>

表 29.3. positional 参数
概述

<service>

要与新端点关联的服务(名称或 ID)

<interface>

新的端点接口类型(admin、public 或 internal)

<url>

新的端点 url

表 29.4. 命令参数
概述

-h, --help

显示帮助信息并退出

--region <region-id>

新的端点区域 ID

--enable

启用端点(默认)

--disable

禁用端点

表 29.5. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 29.6. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 29.7. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 29.8. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

29.3. 端点删除

删除端点

使用方法:

openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]

表 29.9. positional 参数
概述

<endpoint-id>

要删除的端点(仅id)

表 29.10. 命令参数
概述

-h, --help

显示帮助信息并退出

29.4. 端点组添加项目

将项目添加到端点组中

使用方法:

openstack endpoint group add project [-h]
                                            [--project-domain <project-domain>]
                                            <endpoint-group> <project>

表 29.11. positional 参数
概述

<endpoint-group>

端点组(名称或 id)

<project>

要关联的项目(名称或 id)

表 29.12. 命令参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

29.5. 端点组创建

创建新端点组

使用方法:

openstack endpoint group create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--description DESCRIPTION]
                                       <name> <filename>

表 29.13. positional 参数
概述

<name>

端点组的名称

<filename>

包含一组新过滤器的文件名

表 29.14. 命令参数
概述

-h, --help

显示帮助信息并退出

--description DESCRIPTION

端点组的描述

表 29.15. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 29.16. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 29.17. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 29.18. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

29.6. 端点组删除

删除端点组

使用方法:

openstack endpoint group delete [-h]
                                       <endpoint-group> [<endpoint-group> ...]

表 29.19. positional 参数
概述

<endpoint-group>

要删除的端点组(名称或 id)

表 29.20. 命令参数
概述

-h, --help

显示帮助信息并退出

29.7. 端点组列表

列出端点组

使用方法:

openstack endpoint group list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--endpointgroup <endpoint-group> | --project <project>]
                                     [--domain <domain>]

表 29.21. 命令参数
概述

-h, --help

显示帮助信息并退出

--endpointgroup <endpoint-group>

端点组(名称或 id)

--project <project>

项目(名称或 id)

--domain <domain>

域拥有 <project> (名称或 id)

表 29.22. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 29.23. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 29.24. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 29.25. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

29.8. 端点组删除项目

从端点组中删除项目

使用方法:

openstack endpoint group remove project [-h]
                                               [--project-domain <project-domain>]
                                               <endpoint-group> <project>

表 29.26. positional 参数
概述

<endpoint-group>

端点组(名称或 id)

<project>

要删除的项目(名称或 id)

表 29.27. 命令参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

29.9. 端点组集

设置端点组属性

使用方法:

openstack endpoint group set [-h] [--name <name>]
                                    [--filters <filename>]
                                    [--description <description>]
                                    <endpoint-group>

表 29.28. positional 参数
概述

<endpoint-group>

要修改的端点组(名称或 id)

表 29.29. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新的 enpoint 组名称

--filters <filename>

包含一组新过滤器的文件名

--description <description>

新的端点组描述

29.10. 端点组显示

显示端点组详情

使用方法:

openstack endpoint group show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <endpointgroup>

表 29.30. positional 参数
概述

<endpointgroup>

端点组(名称或 id)

表 29.31. 命令参数
概述

-h, --help

显示帮助信息并退出

表 29.32. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 29.33. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 29.34. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 29.35. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

29.11. 端点列表

列出端点

使用方法:

openstack endpoint list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN]
                               [--service <service>] [--interface <interface>]
                               [--region <region-id>]
                               [--endpoint <endpoint-group> | --project <project>]
                               [--project-domain <project-domain>]

表 29.36. 命令参数
概述

-h, --help

显示帮助信息并退出

--service <service>

按服务过滤(类型、名称或 id)

--interface <interface>

根据接口类型(admin、public 或 internal)过滤

--region <region-id>

按区域 ID 过滤

--endpoint <endpoint-group>

列出过滤器的端点

--project <project>

列出过滤器的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

表 29.37. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 29.38. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 29.39. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 29.40. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

29.12. endpoint remove 项目

从端点解除项目分离

使用方法:

openstack endpoint remove project [-h]
                                         [--project-domain <project-domain>]
                                         <endpoint> <project>

表 29.41. positional 参数
概述

<endpoint>

与指定项目(名称或 ID)分离的端点

<project>

与指定端点名称或 ID 隔离的项目

表 29.42. 命令参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

29.13. 端点集

设置端点属性

使用方法:

openstack endpoint set [-h] [--region <region-id>]
                              [--interface <interface>] [--url <url>]
                              [--service <service>] [--enable | --disable]
                              <endpoint-id>

表 29.43. positional 参数
概述

<endpoint-id>

要修改的端点(仅id)

表 29.44. 命令参数
概述

-h, --help

显示帮助信息并退出

--region <region-id>

新的端点区域 ID

--interface <interface>

新的端点接口类型(admin、public 或 internal)

--url <url>

新的端点 url

--service <service>

新端点服务(名称或 id)

--enable

启用端点

--disable

禁用端点

29.14. 端点显示

显示端点详情

使用方法:

openstack endpoint show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               <endpoint>

表 29.45. positional 参数
概述

<endpoint>

要显示的端点(端点 ID、服务 ID、服务名称、服务类型)

表 29.46. 命令参数
概述

-h, --help

显示帮助信息并退出

表 29.47. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 29.48. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 29.49. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 29.50. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 30 章 event

本章描述了 event 命令下的命令。

30.1. 事件触发器创建

创建新触发器。

使用方法:

openstack event trigger create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--params PARAMS]
                                      name workflow_id exchange topic event
                                      [workflow_input]

表 30.1. positional 参数
概述

name

事件触发器名称

workflow_id

工作流 ID

交换

事件触发器交换

topic

事件触发器主题

event

事件触发器事件名称

workflow_input

工作流输入

表 30.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--params PARAMS

工作流参数

表 30.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 30.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 30.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 30.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

30.2. 事件触发器删除

删除触发器。

使用方法:

openstack event trigger delete [-h]
                                      event_trigger_id [event_trigger_id ...]

表 30.7. positional 参数
概述

event_trigger_id

事件触发器 ID。

表 30.8. 命令参数
概述

-h, --help

显示帮助信息并退出

30.3. 事件触发器列表

列出所有事件触发器。

使用方法:

openstack event trigger list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--marker [MARKER]] [--limit [LIMIT]]
                                    [--sort_keys [SORT_KEYS]]
                                    [--sort_dirs [SORT_DIRS]]
                                    [--filter FILTERS]

表 30.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

上一页的最后执行 uuid 显示在"marker"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

以逗号分隔的排序键列表,按以下方式对结果进行排序。默认: created_at。示例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序方向列表。默认为 asc。示例:mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

filters. 可以重复。

表 30.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 30.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 30.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 30.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

30.4. 事件触发器显示

显示特定的事件触发器。

使用方法:

openstack event trigger show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    event_trigger

表 30.14. positional 参数
概述

event_trigger

事件触发器 ID

表 30.15. 命令参数
概述

-h, --help

显示帮助信息并退出

表 30.16. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 30.17. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 30.18. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 30.19. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 31 章 extension

本章描述了 扩展 命令下的命令。

31.1. 扩展列表

列出 API 扩展

使用方法:

openstack extension list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--noindent] [--max-width <integer>]
                                [--fit-width] [--print-empty]
                                [--sort-column SORT_COLUMN] [--compute]
                                [--identity] [--network] [--volume] [--long]

表 31.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--compute

列出计算 api 的扩展

--identity

列出身份 api 的扩展

--network

列出网络 api 的扩展

--volume

列出块存储 api 的扩展

--long

列出输出中的其他字段

表 31.2. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 31.3. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 31.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 31.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

31.2. 扩展显示

显示 API 扩展

使用方法:

openstack extension show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                <extension>

表 31.6. positional 参数
概述

<bx id="1" />

用于显示的扩展。当前只支持网络扩展。(名称或 Alias)

表 31.7. 命令参数
概述

-h, --help

显示帮助信息并退出

表 31.8. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 31.9. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 31.10. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 31.11. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 32 章 federation

本章描述了 联邦 命令下的命令。

32.1. 联邦域列表

列出可访问的域

使用方法:

openstack federation domain list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]

表 32.1. 命令参数
概述

-h, --help

显示帮助信息并退出

表 32.2. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 32.3. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 32.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 32.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

32.2. 联邦项目列表

列出可访问的项目

使用方法:

openstack federation project list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]

表 32.6. 命令参数
概述

-h, --help

显示帮助信息并退出

表 32.7. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 32.8. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 32.9. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 32.10. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

32.3. 联邦协议创建

创建新的联邦协议

使用方法:

openstack federation protocol create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            --identity-provider
                                            <identity-provider> --mapping
                                            <mapping>
                                            <name>

表 32.11. positional 参数
概述

<name>

新的联邦协议名称(每个身份提供程序必须是唯一的)

表 32.12. 命令参数
概述

-h, --help

显示帮助信息并退出

--identity-provider <identity-provider>

支持新联邦协议(名称或 ID)的身份供应商(必需)

--mapping <mapping>

要使用的映射(名称或 id)(必需)

表 32.13. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 32.14. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 32.15. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 32.16. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

32.4. 联邦协议删除

删除联邦协议

使用方法:

openstack federation protocol delete [-h] --identity-provider
                                            <identity-provider>
                                            <federation-protocol>
                                            [<federation-protocol> ...]

表 32.17. positional 参数
概述

<federation-protocol>

要删除的联邦协议(名称或 id)

表 32.18. 命令参数
概述

-h, --help

显示帮助信息并退出

--identity-provider <identity-provider>

支持 <federation-protocol> (名称或 ID)的身份供应商(必需)

32.5. 联邦协议列表

列出联邦协议

使用方法:

openstack federation protocol list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          --identity-provider
                                          <identity-provider>

表 32.19. 命令参数
概述

-h, --help

显示帮助信息并退出

--identity-provider <identity-provider>

要列出的身份提供程序(名称或 id)(必需)

表 32.20. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 32.21. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 32.22. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 32.23. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

32.6. 联邦协议集

设置联邦协议属性

使用方法:

openstack federation protocol set [-h] --identity-provider
                                         <identity-provider>
                                         [--mapping <mapping>]
                                         <name>

表 32.24. positional 参数
概述

<name>

要修改的联邦协议(名称或 id)

表 32.25. 命令参数
概述

-h, --help

显示帮助信息并退出

--identity-provider <identity-provider>

支持 <federation-protocol> (名称或 ID)的身份供应商(必需)

--mapping <mapping>

要使用的映射(名称或 id)

32.7. 联邦协议显示

显示联邦协议详情

使用方法:

openstack federation protocol show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          --identity-provider
                                          <identity-provider>
                                          <federation-protocol>

表 32.26. positional 参数
概述

<federation-protocol>

要显示的联邦协议(名称或 id)

表 32.27. 命令参数
概述

-h, --help

显示帮助信息并退出

--identity-provider <identity-provider>

支持 <federation-protocol> (名称或 ID)的身份供应商(必需)

表 32.28. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 32.29. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 32.30. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 32.31. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 33 章 类型

本章描述了 flavor 命令下的命令。

33.1. 类型创建

创建新类别

使用方法:

openstack flavor create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--id <id>] [--ram <size-mb>]
                               [--disk <size-gb>] [--ephemeral <size-gb>]
                               [--swap <size-mb>] [--vcpus <vcpus>]
                               [--rxtx-factor <factor>] [--public | --private]
                               [--property <key=value>] [--project <project>]
                               [--description <description>]
                               [--project-domain <project-domain>]
                               <flavor-name>

表 33.1. positional 参数
概述

<flavor-name>

新类别名称

表 33.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--id <id>

唯一的类别 ID; 自动 创建一个 uuid (默认:auto)

--ram <size-mb>

mb 中的内存大小(默认 256m)

--disk <size-gb>

gb 中的磁盘大小(默认 0g)

--ephemeral <size-gb>

gb 中的临时磁盘大小(默认 0g)

--swap <size-mb>

mb 中的额外交换空间大小(默认 0m)

--vcpus <vcpus>

IANA 数(默认值 1)

--rxtx-factor <factor>

rx/tx 因素(默认 1.0)

--public

类别可供其他项目使用(默认)

--private

类别不可供其他项目使用

--property <key=value>

要为此类别添加的属性(重复选项来设置多个属性)

--project <project>

允许 <project> 访问私有类别(名称或 id)(与 --private 选项一起使用)

--description <description>

类别的描述。(由 api 版本 2.55 支持 - 2.latest

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

表 33.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 33.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 33.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 33.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

33.2. 删除类别

删除类别

使用方法:

openstack flavor delete [-h] <flavor> [<flavor> ...]

表 33.7. positional 参数
概述

<flavor>

要删除的类别(名称或 ID)

表 33.8. 命令参数
概述

-h, --help

显示帮助信息并退出

33.3. 类型列表

列出类别

使用方法:

openstack flavor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN]
                             [--public | --private | --all] [--long]
                             [--marker <flavor-id>] [--limit <num-flavors>]

表 33.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--public

仅列出公共类别(默认)

--private

仅列出私有类别

--all

列出所有类别,无论是公共类型还是私有

--long

列出输出中的其他字段

--marker <flavor-id>

上一页的最后类别 ID

--limit <num-flavors>

要显示的最大类别数

表 33.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 33.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 33.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 33.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

33.4. 类别集

设置类别属性

使用方法:

openstack flavor set [-h] [--no-property] [--property <key=value>]
                            [--project <project>]
                            [--description <description>]
                            [--project-domain <project-domain>]
                            <flavor>

表 33.14. positional 参数
概述

<flavor>

要修改的类别(名称或 id)

表 33.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--no-property

从此类别中删除所有属性(指定 --no-property 和 --property,以在设置新属性前删除当前属性)。

--property <key=value>

为此类别添加或修改的属性(重复选项来设置多个属性)

--project <project>

设置项目(名称或 ID)的类别访问权限(仅限管理员)

--description <description>

设置类别的描述。(由 api 版本 2.55 支持)- 2.latest

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

33.5. 类型显示

显示类别详情

使用方法:

openstack flavor show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <flavor>

表 33.16. positional 参数
概述

<flavor>

要显示的类别(名称或 id)

表 33.17. 命令参数
概述

-h, --help

显示帮助信息并退出

表 33.18. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 33.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 33.20. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 33.21. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

33.6. 类别未设置

取消设置类别属性

使用方法:

openstack flavor unset [-h] [--property <key>] [--project <project>]
                              [--project-domain <project-domain>]
                              <flavor>

表 33.22. positional 参数
概述

<flavor>

要修改的类别(名称或 id)

表 33.23. 命令参数
概述

-h, --help

显示帮助信息并退出

--property <key>

从类别中删除的属性(重复选项以取消设置多个属性)

--project <project>

--project-domain <project-domain>

第 34 章 

34.1. 

使用方法:

openstack floating ip create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--subnet <subnet>]
                                    [--port <port>]
                                    [--floating-ip-address <ip-address>]
                                    [--fixed-ip-address <ip-address>]
                                    [--qos-policy <qos-policy>]
                                    [--description <description>]
                                    [--project <project>]
                                    [--dns-domain <dns-domain>]
                                    [--dns-name <dns-name>]
                                    [--project-domain <project-domain>]
                                    [--tag <tag> | --no-tag]
                                    <network>

表 34.1. 
概述

<network>

表 34.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--subnet <subnet>

--port <port>

--floating-ip-address <ip-address>

--fixed-ip-address <ip-address>

--qos-policy <qos-policy>

--description <description>

--project <project>

--dns-domain <dns-domain>

--dns-name <dns-name>

--project-domain <project-domain>

--tag <tag>

--no-tag

表 34.3. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 34.4. 
概述

--noindent

表 34.5. 
概述

--prefix PREFIX

表 34.6. 
概述

--max-width <integer>

--fit-width

--print-empty

34.2. 

使用方法:

openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]

表 34.7. 
概述

<floating-ip>

表 34.8. 命令参数
概述

-h, --help

显示帮助信息并退出

34.3. 

使用方法:

openstack floating ip list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  [--network <network>] [--port <port>]
                                  [--fixed-ip-address <ip-address>]
                                  [--floating-ip-address <ip-address>]
                                  [--long] [--status <status>]
                                  [--project <project>]
                                  [--project-domain <project-domain>]
                                  [--router <router>]
                                  [--tags <tag>[,<tag>,...]]
                                  [--any-tags <tag>[,<tag>,...]]
                                  [--not-tags <tag>[,<tag>,...]]
                                  [--not-any-tags <tag>[,<tag>,...]]

表 34.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--network <network>

--port <port>

--fixed-ip-address <ip-address>

--floating-ip-address <ip-address>

--long

--status <status>

--project <project>

--project-domain <project-domain>

--router <router>

--tags <tag>[,<tag>,…​]

--any-tags <tag>[,<tag>,…​]

--not-tags <tag>[,<tag>,…​]

--not-any-tags <tag>[,<tag>,…​]

表 34.10. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

--sort-column SORT_COLUMN

表 34.11. 
概述

--quote {all,minimal,none,nonnumeric}

表 34.12. 
概述

--noindent

表 34.13. 
概述

--max-width <integer>

--fit-width

--print-empty

34.4. 

使用方法:

openstack floating ip pool list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]

表 34.14. 命令参数
概述

-h, --help

显示帮助信息并退出

表 34.15. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

--sort-column SORT_COLUMN

表 34.16. 
概述

--quote {all,minimal,none,nonnumeric}

表 34.17. 
概述

--noindent

表 34.18. 
概述

--max-width <integer>

--fit-width

--print-empty

34.5. 

使用方法:

openstack floating ip port forwarding create [-h]
                                                    [-f {json,shell,table,value,yaml}]
                                                    [-c COLUMN] [--noindent]
                                                    [--prefix PREFIX]
                                                    [--max-width <integer>]
                                                    [--fit-width]
                                                    [--print-empty]
                                                    --internal-ip-address
                                                    <internal-ip-address>
                                                    --port <port>
                                                    --internal-protocol-port
                                                    <port-number>
                                                    --external-protocol-port
                                                    <port-number> --protocol
                                                    <protocol>
                                                    <floating-ip>

表 34.19. 
概述

<floating-ip>

表 34.20. 命令参数
概述

-h, --help

显示帮助信息并退出

--internal-ip-address <internal-ip-address>

--port <port>

--internal-protocol-port <port-number>

--external-protocol-port <port-number>

--protocol <protocol>

表 34.21. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 34.22. 
概述

--noindent

表 34.23. 
概述

--prefix PREFIX

表 34.24. 
概述

--max-width <integer>

--fit-width

--print-empty

34.6. 

使用方法:

openstack floating ip port forwarding delete [-h]
                                                    <floating-ip>
                                                    <port-forwarding-id>
                                                    [<port-forwarding-id> ...]

表 34.25. 
概述

<floating-ip>

<port-forwarding-id>

表 34.26. 命令参数
概述

-h, --help

显示帮助信息并退出

34.7. 

使用方法:

openstack floating ip port forwarding list [-h]
                                                  [-f {csv,json,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--quote {all,minimal,none,nonnumeric}]
                                                  [--noindent]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--sort-column SORT_COLUMN]
                                                  [--port <port>]
                                                  [--external-protocol-port <port-number>]
                                                  [--protocol protocol]
                                                  <floating-ip>

表 34.27. 
概述

<floating-ip>

表 34.28. 命令参数
概述

-h, --help

显示帮助信息并退出

--port <port>

--external-protocol-port <port-number>

表 34.29. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

--sort-column SORT_COLUMN

表 34.30. 
概述

--quote {all,minimal,none,nonnumeric}

表 34.31. 
概述

--noindent

表 34.32. 
概述

--max-width <integer>

--fit-width

--print-empty

34.8. 

使用方法:

openstack floating ip port forwarding set [-h] [--port <port>]
                                                 [--internal-ip-address <internal-ip-address>]
                                                 [--internal-protocol-port <port-number>]
                                                 [--external-protocol-port <port-number>]
                                                 [--protocol <protocol>]
                                                 <floating-ip>
                                                 <port-forwarding-id>

表 34.33. 
概述

<floating-ip>

<port-forwarding-id>

表 34.34. 命令参数
概述

-h, --help

显示帮助信息并退出

--port <port>

--internal-ip-address <internal-ip-address>

--internal-protocol-port <port-number>

--external-protocol-port <port-number>

--protocol <protocol>

34.9. 

使用方法:

openstack floating ip port forwarding show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  <floating-ip>
                                                  <port-forwarding-id>

表 34.35. 
概述

<floating-ip>

<port-forwarding-id>

表 34.36. 命令参数
概述

-h, --help

显示帮助信息并退出

表 34.37. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 34.38. 
概述

--noindent

表 34.39. 
概述

--prefix PREFIX

表 34.40. 
概述

--max-width <integer>

--fit-width

--print-empty

34.10. 

使用方法:

openstack floating ip set [-h] [--port <port>]
                                 [--fixed-ip-address <ip-address>]
                                 [--qos-policy <qos-policy> | --no-qos-policy]
                                 [--tag <tag>] [--no-tag]
                                 <floating-ip>

表 34.41. 
概述

<floating-ip>

表 34.42. 命令参数
概述

-h, --help

显示帮助信息并退出

--port <port>

--fixed-ip-address <ip-address>

--qos-policy <qos-policy>

--no-qos-policy

--tag <tag>

--no-tag

34.11. 

使用方法:

openstack floating ip show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <floating-ip>

表 34.43. 
概述

<floating-ip>

表 34.44. 命令参数
概述

-h, --help

显示帮助信息并退出

表 34.45. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 34.46. 
概述

--noindent

表 34.47. 
概述

--prefix PREFIX

表 34.48. 
概述

--max-width <integer>

--fit-width

--print-empty

34.12. 

使用方法:

openstack floating ip unset [-h] [--port] [--qos-policy]
                                   [--tag <tag> | --all-tag]
                                   <floating-ip>

表 34.49. 
概述

<floating-ip>

表 34.50. 命令参数
概述

-h, --help

显示帮助信息并退出

--port

--qos-policy

--tag <tag>

--all-tag

第 35 章 group

35.1. 

使用方法:

openstack group add user [-h] [--group-domain <group-domain>]
                                [--user-domain <user-domain>]
                                <group> <user> [<user> ...]

表 35.1. 
概述

<group>

<user>

表 35.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--group-domain <group-domain>

--user-domain <user-domain>

35.2. 

使用方法:

openstack group contains user [-h] [--group-domain <group-domain>]
                                     [--user-domain <user-domain>]
                                     <group> <user>

表 35.3. 
概述

<group>

<user>

表 35.4. 命令参数
概述

-h, --help

显示帮助信息并退出

--group-domain <group-domain>

--user-domain <user-domain>

35.3. 

使用方法:

openstack group create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--domain <domain>]
                              [--description <description>] [--or-show]
                              <group-name>

表 35.5. 
概述

<group-name>

表 35.6. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

--description <description>

--or-show

表 35.7. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 35.8. 
概述

--noindent

表 35.9. 
概述

--prefix PREFIX

表 35.10. 
概述

--max-width <integer>

--fit-width

--print-empty

35.4. 

使用方法:

openstack group delete [-h] [--domain <domain>] <group> [<group> ...]

表 35.11. 
概述

<group>

表 35.12. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

35.5. 

使用方法:

openstack group list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--domain <domain>] [--user <user>]
                            [--user-domain <user-domain>] [--long]

表 35.13. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

--user <user>

--user-domain <user-domain>

--long

表 35.14. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

--sort-column SORT_COLUMN

表 35.15. 
概述

--quote {all,minimal,none,nonnumeric}

表 35.16. 
概述

--noindent

表 35.17. 
概述

--max-width <integer>

--fit-width

--print-empty

35.6. 

使用方法:

openstack group remove user [-h] [--group-domain <group-domain>]
                                   [--user-domain <user-domain>]
                                   <group> <user> [<user> ...]

表 35.18. 
概述

<group>

<user>

表 35.19. 命令参数
概述

-h, --help

显示帮助信息并退出

--group-domain <group-domain>

--user-domain <user-domain>

35.7. 

使用方法:

openstack group set [-h] [--domain <domain>] [--name <name>]
                           [--description <description>]
                           <group>

表 35.20. 
概述

<group>

表 35.21. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

--name <name>

--description <description>

35.8. 

使用方法:

openstack group show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--domain <domain>]
                            <group>

表 35.22. 
概述

<group>

表 35.23. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

表 35.24. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 35.25. 
概述

--noindent

表 35.26. 
概述

--prefix PREFIX

表 35.27. 
概述

--max-width <integer>

--fit-width

--print-empty

第 36 章 帮助

36.1. 帮助

使用方法:

openstack help [-h] [cmd [cmd ...]]

表 36.1. 
概述

cmd

表 36.2. 命令参数
概述

-h, --help

显示帮助信息并退出

第 37 章 host

37.1. 

使用方法:

openstack host list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           [--zone <zone>]

表 37.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--zone <zone>

表 37.2. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

--sort-column SORT_COLUMN

表 37.3. 
概述

--quote {all,minimal,none,nonnumeric}

表 37.4. 
概述

--noindent

表 37.5. 
概述

--max-width <integer>

--fit-width

--print-empty

37.2. 

使用方法:

openstack host set [-h] [--enable | --disable]
                          [--enable-maintenance | --disable-maintenance]
                          <host>

表 37.6. 
概述

<host>

表 37.7. 命令参数
概述

-h, --help

显示帮助信息并退出

--enable

--disable

--enable-maintenance

--disable-maintenance

37.3. 

使用方法:

openstack host show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           <host>

表 37.8. 
概述

<host>

表 37.9. 命令参数
概述

-h, --help

显示帮助信息并退出

表 37.10. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

--sort-column SORT_COLUMN

表 37.11. 
概述

--quote {all,minimal,none,nonnumeric}

表 37.12. 
概述

--noindent

表 37.13. 
概述

--max-width <integer>

--fit-width

--print-empty

第 38 章 hypervisor

38.1. 

使用方法:

openstack hypervisor list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN]
                                 [--matching <hostname>] [--long]

表 38.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--matching <hostname>

--long

表 38.2. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

--sort-column SORT_COLUMN

表 38.3. 
概述

--quote {all,minimal,none,nonnumeric}

表 38.4. 
概述

--noindent

表 38.5. 
概述

--max-width <integer>

--fit-width

--print-empty

38.2. 

使用方法:

openstack hypervisor show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <hypervisor>

表 38.6. 
概述

<hypervisor>

表 38.7. 命令参数
概述

-h, --help

显示帮助信息并退出

表 38.8. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 38.9. 
概述

--noindent

表 38.10. 
概述

--prefix PREFIX

表 38.11. 
概述

--max-width <integer>

--fit-width

--print-empty

38.3. 

使用方法:

openstack hypervisor stats show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]

表 38.12. 命令参数
概述

-h, --help

显示帮助信息并退出

表 38.13. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 38.14. 
概述

--noindent

表 38.15. 
概述

--prefix PREFIX

表 38.16. 
概述

--max-width <integer>

--fit-width

--print-empty

第 39 章 identity

39.1. 

使用方法:

openstack identity provider create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--remote-id <remote-id> | --remote-id-file <file-name>]
                                          [--description <description>]
                                          [--domain <domain>]
                                          [--enable | --disable]
                                          <name>

表 39.1. 
概述

<name>

表 39.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--remote-id <remote-id>

--remote-id-file <file-name>

--description <description>

--domain <domain>

--enable

--disable

表 39.3. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 39.4. 
概述

--noindent

表 39.5. 
概述

--prefix PREFIX

表 39.6. 
概述

--max-width <integer>

--fit-width

--print-empty

39.2. 

使用方法:

openstack identity provider delete [-h]
                                          <identity-provider>
                                          [<identity-provider> ...]

表 39.7. 
概述

<identity-provider>

表 39.8. 命令参数
概述

-h, --help

显示帮助信息并退出

39.3. 

使用方法:

openstack identity provider list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]

表 39.9. 命令参数
概述

-h, --help

显示帮助信息并退出

表 39.10. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

--sort-column SORT_COLUMN

表 39.11. 
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 39.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 39.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

39.4. 身份提供程序集

设置身份提供程序属性

使用方法:

openstack identity provider set [-h] [--description <description>]
                                       [--remote-id <remote-id> | --remote-id-file <file-name>]
                                       [--enable | --disable]
                                       <identity-provider>

表 39.14. positional 参数
概述

<identity-provider>

要修改的身份提供程序

表 39.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

设置身份提供程序描述

--remote-id <remote-id>

与身份提供程序关联的远程 ID (重复选项提供多个值)

--remote-id-file <file-name>

包含与身份提供程序关联的多个远程 id 的文件名称,每行一个

--enable

启用身份提供程序

--disable

禁用身份提供程序

39.5. 身份提供程序显示

显示身份提供程序详情

使用方法:

openstack identity provider show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <identity-provider>

表 39.16. positional 参数
概述

<identity-provider>

要显示的身份供应商

表 39.17. 命令参数
概述

-h, --help

显示帮助信息并退出

表 39.18. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 39.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 39.20. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 39.21. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 40 章 image

本章描述了 image 命令下的命令。

40.1. Image add 项目

将项目与镜像关联

使用方法:

openstack image add project [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   [--project-domain <project-domain>]
                                   <image> <project>

表 40.1. positional 参数
概述

<image>

要共享的镜像(名称或 id)

<project>

与镜像关联的项目(id)

表 40.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

表 40.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 40.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 40.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 40.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

40.2. 镜像创建

创建/上传镜像

使用方法:

openstack image create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--id <id>]
                              [--container-format <container-format>]
                              [--disk-format <disk-format>]
                              [--min-disk <disk-gb>] [--min-ram <ram-mb>]
                              [--file <file> | --volume <volume>] [--force]
                              [--sign-key-path <sign-key-path>]
                              [--sign-cert-id <sign-cert-id>]
                              [--protected | --unprotected]
                              [--public | --private | --community | --shared]
                              [--property <key=value>] [--tag <tag>]
                              [--project <project>]
                              [--project-domain <project-domain>]
                              <image-name>

表 40.7. positional 参数
概述

<image-name>

新镜像名称

表 40.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--id <id>

要保留的镜像 ID

--Container-format <container-format>

镜像容器格式: ami、auri、ari、aki、metal、docker、ova、ovf。默认格式为:metal

--disk-format <disk-format>

镜像构建格式: ami、ari、ari、aki、vhd、vmdk、raw、qcow2、vhdx、vdi、iso、ploop。默认格式为: raw

--min-disk <disk-gb>

引导镜像所需的最小磁盘大小,以 GB 为单位

--min-ram <ram-mb>

引导镜像所需的最小 ram 大小,以 MB 为单位

--file <file>

从本地文件上传镜像

--volume <volume>

从卷创建镜像

--force

如果使用卷时强制创建镜像(仅对 --volume 有意义的)

--sign-key-path <sign-key-path>

使用指定的私钥签名镜像。仅将与 --sign-cert-id 结合使用

--sign-cert-id <sign-cert-id>

指定的证书 uuid 是对密钥管理器中证书的引用,对应于公钥并用于签名验证。仅将 --sign-key-path 结合使用

--protected

防止镜像被删除

--unprotected

允许删除镜像(默认)

--public

镜像可以被公共访问

--private

镜像无法被公共访问(默认)

--community

镜像可以被社区访问

--shared

镜像可以被共享

--property <key=value>

设置此镜像上的属性(重复选项来设置多个属性)

--tag <tag>

在这个镜像上设置标签(重复选项来设置多个标签)

--project <project>

在这个镜像上设置备用项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

表 40.9. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 40.10. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 40.11. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 40.12. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

40.3. image delete

删除镜像

使用方法:

openstack image delete [-h] <image> [<image> ...]

表 40.13. positional 参数
概述

<image>

要删除的镜像(名称或 id)

表 40.14. 命令参数
概述

-h, --help

显示帮助信息并退出

40.4. 镜像列表

列出可用镜像

使用方法:

openstack image list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--public | --private | --community | --shared]
                            [--property <key=value>] [--name <name>]
                            [--status <status>]
                            [--member-status <member-status>] [--tag <tag>]
                            [--long] [--sort <key>[:<direction>]]
                            [--limit <num-images>] [--marker <image>]

表 40.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--public

仅列出公共镜像

--private

仅列出私有镜像

--community

仅列出社区镜像

--shared

仅列出共享镜像

--property <key=value>

根据属性过滤输出(重复选项以过滤多个属性)

--name <name>

根据名称过滤镜像。

--status <status>

根据状态过滤镜像。

--member-status <member-status>

根据成员状态过滤镜像。支持的选项为: accepted, pending, rejected, all。

--tag <tag>

根据标签过滤镜像。

--long

列出输出中的其他字段

--sort <key>[:<direction>]

按所选键和方向(asc 或 desc)排序输出(默认: name:asc)、多个键和方向可以用逗号分开

--limit <num-images>

要显示的最大镜像数。

--marker <image>

上一页的最后镜像。标记后显示镜像列表。如果未指定,则显示所有镜像。(名称或 ID)

表 40.16. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 40.17. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 40.18. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 40.19. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

40.5. 镜像成员列表

列出与镜像关联的项目

使用方法:

openstack image member list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--project-domain <project-domain>]
                                   <image>

表 40.20. positional 参数
概述

<image>

镜像(名称或 id)

表 40.21. 命令参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

表 40.22. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 40.23. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 40.24. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 40.25. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

40.6. Image remove 项目

使用镜像解除关联项目

使用方法:

openstack image remove project [-h] [--project-domain <project-domain>]
                                      <image> <project>

表 40.26. positional 参数
概述

<image>

要取消共享的镜像(名称或 id)

<project>

与镜像解除关联的项目(名称或 id)

表 40.27. 命令参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

40.7. 镜像保存

本地保存镜像

使用方法:

openstack image save [-h] [--file <filename>] <image>

表 40.28. positional 参数
概述

<image>

要保存的镜像(名称或 id)

表 40.29. 命令参数
概述

-h, --help

显示帮助信息并退出

--file <filename>

下载的镜像保存文件名(默认:stdout)

40.8. 镜像集

设置镜像属性

使用方法:

openstack image set [-h] [--name <name>] [--min-disk <disk-gb>]
                           [--min-ram <ram-mb>]
                           [--container-format <container-format>]
                           [--disk-format <disk-format>]
                           [--protected | --unprotected]
                           [--public | --private | --community | --shared]
                           [--property <key=value>] [--tag <tag>]
                           [--architecture <architecture>]
                           [--instance-id <instance-id>]
                           [--kernel-id <kernel-id>] [--os-distro <os-distro>]
                           [--os-version <os-version>]
                           [--ramdisk-id <ramdisk-id>]
                           [--deactivate | --activate] [--project <project>]
                           [--project-domain <project-domain>]
                           [--accept | --reject | --pending]
                           <image>

表 40.30. positional 参数
概述

<image>

要修改的镜像(名称或 id)

表 40.31. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新镜像名称

--min-disk <disk-gb>

引导镜像所需的最小磁盘大小,以 GB 为单位

--min-ram <ram-mb>

引导镜像所需的最小 ram 大小,以 MB 为单位

--Container-format <container-format>

镜像容器格式: ami、auri、ari、aki、metal、docker、ova、ovf

--disk-format <disk-format>

镜像构建格式: ami、ari、ari、aki、vhd、vmdk、raw、qcow2、vhdx、vdi、iso、ploop

--protected

防止镜像被删除

--unprotected

允许删除镜像(默认)

--public

镜像可以被公共访问

--private

镜像无法被公共访问(默认)

--community

镜像可以被社区访问

--shared

镜像可以被共享

--property <key=value>

设置此镜像上的属性(重复选项来设置多个属性)

--tag <tag>

在这个镜像上设置标签(重复选项来设置多个标签)

--architecture <architecture>

操作系统架构

--instance-id <instance-id>

用于创建此镜像的服务器实例 ID

--kernel-id <kernel-id>

用于引导此磁盘镜像的内核镜像的 ID

--os-distro <os-distro>

操作系统分发名称

--os-version <os-version>

操作系统分发版本

--ramdisk-id <ramdisk-id>

用于引导此磁盘镜像的 ramdisk 镜像的 ID

--deactivate

取消激活镜像

--activate

激活镜像

--project <project>

在这个镜像上设置备用项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--accept

接受镜像成员资格

--reject

拒绝镜像成员资格

--pending

将镜像成员资格重置为 pending

40.9. 镜像显示

显示镜像详情

使用方法:

openstack image show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--human-readable]
                            <image>

表 40.32. positional 参数
概述

<image>

要显示的镜像(名称或 id)

表 40.33. 命令参数
概述

-h, --help

显示帮助信息并退出

--human-readable

以人友好的格式打印图像大小。

表 40.34. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 40.35. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 40.36. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 40.37. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

40.10. 镜像取消设置

取消设置镜像标签和属性

使用方法:

openstack image unset [-h] [--tag <tag>] [--property <property-key>]
                             <image>

表 40.38. positional 参数
概述

<image>

要修改的镜像(名称或 id)

表 40.39. 命令参数
概述

-h, --help

显示帮助信息并退出

--tag <tag>

取消设置此镜像上的标签(重复选项取消设置多个标签)

--property <property-key>

取消设置此镜像上的属性(重复选项取消设置多个属性)

第 41 章 implied

本章描述了 implied 命令下的命令。

41.1. 指示角色 create

在 before 和 implied 角色之间创建一个关联

使用方法:

openstack implied role create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     --implied-role <role>
                                     <role>

表 41.1. positional 参数
概述

<role>

代表另一个角色的角色(名称或 id)

表 41.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--implied-role <role>

<role> (名称或 id)由另一个角色表示

表 41.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 41.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 41.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 41.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

41.2. 表示角色删除

删除之前和表示的角色之间的关联

使用方法:

openstack implied role delete [-h] --implied-role <role> <role>

表 41.7. positional 参数
概述

<role>

代表另一个角色的角色(名称或 id)

表 41.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--implied-role <role>

<role> (名称或 id)由另一个角色表示

41.3. 指示的角色列表

列出含义的角色

使用方法:

openstack implied role list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]

表 41.9. 命令参数
概述

-h, --help

显示帮助信息并退出

表 41.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 41.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 41.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 41.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 42 章 ip

本章描述了 ip 命令下的命令。

42.1. IP 可用性列表

列出网络的 IP 可用性

使用方法:

openstack ip availability list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--ip-version <ip-version>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]

表 42.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--ip-version <ip-version>

列出给定 ip 版本网络的 ip 可用性(默认为 4)

--project <project>

列出给定项目的 ip 可用性(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

表 42.2. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 42.3. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 42.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 42.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

42.2. IP 可用性显示

显示网络 IP 可用性详情

使用方法:

openstack ip availability show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <network>

表 42.6. positional 参数
概述

<network>

显示特定网络的 ip 可用性(名称或 ID)

表 42.7. 命令参数
概述

-h, --help

显示帮助信息并退出

表 42.8. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 42.9. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 42.10. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 42.11. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 43 章 keypair

本章描述了密钥对命令下的 命令

43.1. 对密钥对创建

为服务器 ssh 访问创建新的公钥或私钥

使用方法:

openstack keypair create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                [--public-key <file> | --private-key <file>]
                                <name>

表 43.1. positional 参数
概述

<name>

新的公钥或私钥名称

表 43.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--public-key <file>

要添加的公钥的文件名。如果没有使用,请创建一个私钥。

--private-key <file>

要保存的私钥的文件名。如果没有使用,请在控制台中打印私钥。

表 43.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 43.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 43.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 43.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

43.2. 删除密钥对

删除公钥或私钥

使用方法:

openstack keypair delete [-h] <key> [<key> ...]

表 43.7. positional 参数
概述

<key>

要删除的键的名称(仅限名称)

表 43.8. 命令参数
概述

-h, --help

显示帮助信息并退出

43.3. 密钥对列表

列出密钥指纹

使用方法:

openstack keypair list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN]

表 43.9. 命令参数
概述

-h, --help

显示帮助信息并退出

表 43.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 43.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 43.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 43.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

43.4. 密钥对显示

显示密钥详情

使用方法:

openstack keypair show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--public-key]
                              <key>

表 43.14. positional 参数
概述

<key>

要显示的公钥或私钥(仅限名称)

表 43.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--public-key

仅显示与生成的密钥配对的裸机公钥

表 43.16. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 43.17. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 43.18. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 43.19. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 44 章 l2gw

本章描述了 l2gw 命令下的命令。

44.1. l2gw 连接创建

创建 l2gateway-connection

使用方法:

openstack l2gw connection create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--default-segmentation-id SEG_ID]
                                        <GATEWAY-NAME/UUID>
                                        <NETWORK-NAME/UUID>

表 44.1. positional 参数
概述

<GATEWAY-NAME/UUID>

逻辑网关的描述性名称。

<NETWORK-NAME/UUID>

网络名称或 uuid。

表 44.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--default-segmentation-id SEG_ID

默认 segmentation-id 将应用到 l2-gateway-create 命令中没有指定分段 ID 的接口。

表 44.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 44.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 44.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 44.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

44.2. l2gw connection delete

删除给定的 l2gateway-connection

使用方法:

openstack l2gw connection delete [-h]
                                        <L2_GATEWAY_CONNECTIONS>
                                        [<L2_GATEWAY_CONNECTIONS> ...]

表 44.7. positional 参数
概述

<L2_GATEWAY_CONNECTIONS>

要删除的 l2_gateway_connections 的 ID。

表 44.8. 命令参数
概述

-h, --help

显示帮助信息并退出

44.3. l2gw 连接列表

列出 l2gateway-connections

使用方法:

openstack l2gw connection list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--project <project>]
                                      [--project-domain <project-domain>]

表 44.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

表 44.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 44.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 44.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 44.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

44.4. l2gw connection show

显示给定 l2gateway-connection 的信息

使用方法:

openstack l2gw connection show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <L2_GATEWAY_CONNECTION>

表 44.14. positional 参数
概述

<L2_GATEWAY_CONNECTION>

要查找的 l2_gateway_connection 的 ID。

表 44.15. 命令参数
概述

-h, --help

显示帮助信息并退出

表 44.16. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 44.17. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 44.18. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 44.19. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

44.5. l2gw create

创建 l2gateway 资源

使用方法:

openstack l2gw create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--project <project>]
                             [--project-domain <project-domain>]
                             [--device name=name,interface_names=INTERFACE-DETAILS]
                             <GATEWAY-NAME>

表 44.20. positional 参数
概述

<GATEWAY-NAME>

逻辑网关的描述性名称。

表 44.21. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--device name=name,interface_names=INTERFACE-DETAILS

l2gateway 的设备名称和接口名称。INTERFACE-DETAILS 格式为 "<interface_name1>;[<inte rface_name2>][|<seg_id1>[ö<seg_id2>]]" (--device 选项)

表 44.22. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 44.23. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 44.24. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 44.25. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

44.6. l2gw delete

删除给定的 l2gateway

使用方法:

openstack l2gw delete [-h] <L2_GATEWAY> [<L2_GATEWAY> ...]

表 44.26. positional 参数
概述

<L2_GATEWAY>

要删除的 l2_gateway 的 ID 或名称。

表 44.27. 命令参数
概述

-h, --help

显示帮助信息并退出

44.7. l2gw list

列出属于给定租户的 l2gateway

使用方法:

openstack l2gw list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           [--project <project>]
                           [--project-domain <project-domain>]

表 44.28. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

表 44.29. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 44.30. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 44.31. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 44.32. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

44.8. l2gw show

显示给定 l2gateway 的信息

使用方法:

openstack l2gw show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty]
                           <L2_GATEWAY>

表 44.33. positional 参数
概述

<L2_GATEWAY>

要查找的 l2_gateway 的 ID 或名称。

表 44.34. 命令参数
概述

-h, --help

显示帮助信息并退出

表 44.35. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 44.36. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 44.37. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 44.38. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

44.9. l2gw update

更新给定的 l2gateway

使用方法:

openstack l2gw update [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--name name]
                             [--device name=name,interface_names=INTERFACE-DETAILS]
                             <L2_GATEWAY>

表 44.39. positional 参数
概述

<L2_GATEWAY>

要更新的 l2_gateway 的 ID 或名称。

表 44.40. 命令参数
概述

-h, --help

显示帮助信息并退出

--name name

逻辑网关的描述性名称。

--device name=name,interface_names=INTERFACE-DETAILS

l2gateway 的设备名称和接口名称。INTERFACE-DETAILS 格式为 "<interface_name1>;[<inte rface_name2>][|<seg_id1>[ö<seg_id2>]]" (--device 选项)

表 44.41. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 44.42. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 44.43. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 44.44. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 45 章 limit

本章描述了 limit 命令下的命令。

45.1. 限制创建

创建限制

使用方法:

openstack limit create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--description <description>]
                              [--region <region>] --project <project>
                              --service <service> --resource-limit
                              <resource-limit>
                              <resource-name>

表 45.1. positional 参数
概述

<resource-name>

要限制的资源名称

表 45.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

限制的描述

--region <region>

要影响的限制的区域。

--project <project>

将资源限值与项目关联

--service <service>

负责限制资源的服务

--resource-limit <resource-limit>

要假定项目的资源限值

表 45.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 45.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 45.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 45.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

45.2. 限制删除

删除限制

使用方法:

openstack limit delete [-h] <limit-id> [<limit-id> ...]

表 45.7. positional 参数
概述

<limit-id>

限制删除(id)

表 45.8. 命令参数
概述

-h, --help

显示帮助信息并退出

45.3. 限制列表

列出限制

使用方法:

openstack limit list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--service <service>]
                            [--resource-name <resource-name>]
                            [--region <region>] [--project <project>]

表 45.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--service <service>

负责限制资源的服务

--resource-name <resource-name>

要限制的资源名称

--region <region>

要影响的注册限制的区域。

--project <project>

列出与项目关联的资源限值

表 45.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 45.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 45.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 45.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

45.4. 限制集

更新有关限制的信息

使用方法:

openstack limit set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--description <description>]
                           [--resource-limit <resource-limit>]
                           <limit-id>

表 45.14. positional 参数
概述

<limit-id>

限制更新(id)

表 45.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

限制的描述

--resource-limit <resource-limit>

要假定项目的资源限值

表 45.16. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 45.17. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 45.18. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 45.19. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

45.5. 限制显示

显示限制详情

使用方法:

openstack limit show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty]
                            <limit-id>

表 45.20. positional 参数
概述

<limit-id>

限制为显示(id)

表 45.21. 命令参数
概述

-h, --help

显示帮助信息并退出

表 45.22. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 45.23. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 45.24. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 45.25. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 46 章 limits

本章描述了 limits 命令下的命令。

46.1. 限制显示

显示计算和块存储限制

使用方法:

openstack limits show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] (--absolute | --rate)
                             [--reserved] [--project <project>]
                             [--domain <domain>]

表 46.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--absolute

显示绝对限制

--rate

显示速率限值

--reserved

包括保留数 [仅适用于 --absolute]

--project <project>

显示特定项目的限值(名称或 id)[仅适用于 --absolute]

--domain <domain>

项目所属的域(名称或 id)[仅适用于 --absolute]

表 46.2. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 46.3. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 46.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 46.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 47 章 LoadBalancer

本章描述了 loadbalancer 命令下的命令。

47.1. LoadBalancer amphora 配置

更新 amphora 代理配置

使用方法:

openstack loadbalancer amphora configure [-h] <amphora-id>

表 47.1. positional 参数
概述

<amphora-id>

要配置的 amphora 的 UUID。

表 47.2. 命令参数
概述

-h, --help

显示帮助信息并退出

47.2. LoadBalancer amphora 故障转移

强制故障转移 amphora

使用方法:

openstack loadbalancer amphora failover [-h] <amphora-id>

表 47.3. positional 参数
概述

<amphora-id>

amphora 的 UUID。

表 47.4. 命令参数
概述

-h, --help

显示帮助信息并退出

47.3. LoadBalancer amphora list

列出 amphorae

使用方法:

openstack loadbalancer amphora list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           [--loadbalancer <loadbalancer>]
                                           [--compute-id <compute-id>]
                                           [--role {BACKUP,MASTER,STANDALONE}]
                                           [--status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}]

表 47.5. 命令参数
概述

-h, --help

显示帮助信息并退出

--LoadBalancer <loadbalancer>

按负载均衡器(名称或 id)过滤。

--compute-id <compute-id>

根据计算 ID 过滤。

--role {BACKUP,MASTER,STANDALONE}

按角色过滤。

--status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}, --provisioning-status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}

按 amphora 置备状态过滤。

表 47.6. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 47.7. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 47.8. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.9. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.4. LoadBalancer amphora show

显示单个 amphora 的详情

使用方法:

openstack loadbalancer amphora show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           <amphora-id>

表 47.10. positional 参数
概述

<amphora-id>

amphora 的 UUID。

表 47.11. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.12. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.13. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.14. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.15. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.5. LoadBalancer create

创建负载均衡器

使用方法:

openstack loadbalancer create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--name <name>]
                                     [--description <description>]
                                     [--vip-address <vip_address>]
                                     [--vip-port-id <vip_port_id>]
                                     [--vip-subnet-id <vip_subnet_id>]
                                     [--vip-network-id <vip_network_id>]
                                     [--vip-qos-policy-id <vip_qos_policy_id>]
                                     [--project <project>]
                                     [--provider <provider>]
                                     [--enable | --disable]
                                     [--flavor <flavor>]

表 47.16. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新的负载均衡器名称。

--description <description>

设置负载均衡器描述。

--vip-address <vip_address>

设置 vip ip 地址。

--vip-qos-policy-id <vip_qos_policy_id>

为 vip 端口设置 qos 策略 ID。取消设置

--project <project>

负载均衡器的项目(名称或 id)。

--provider <provider>

负载均衡器的供应商名称。

--enable

启用负载均衡器(默认)。

--disable

禁用负载均衡器。

--flavor <flavor>

负载均衡器的类别的名称或 ID。

表 47.17. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.18. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.19. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.20. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

表 47.21. VIP 网络
概述

至少需要以下参数之一。--vip-port-id <vip_port_id>

为负载均衡器(name 或 id)设置端口。

--vip-subnet-id <vip_subnet_id>

为负载均衡器(名称或 id)设置子网。

--vip-network-id <vip_network_id>

为负载均衡器(名称或 id)设置 network。

47.6. LoadBalancer delete

删除负载均衡器

使用方法:

openstack loadbalancer delete [-h] [--cascade] <load_balancer>

表 47.22. positional 参数
概述

<load_balancer>

要删除的负载均衡器(名称或 id)

表 47.23. 命令参数
概述

-h, --help

显示帮助信息并退出

--cascade

将删除删除到负载均衡器的所有子元素。

47.7. LoadBalancer 故障转移

触发器负载均衡器故障切换

使用方法:

openstack loadbalancer failover [-h] <load_balancer>

表 47.24. positional 参数
概述

<load_balancer>

负载均衡器的名称或 uuid。

表 47.25. 命令参数
概述

-h, --help

显示帮助信息并退出

47.8. LoadBalancer 类别创建

创建 octavia 类别

使用方法:

openstack loadbalancer flavor create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            --name <name> --flavorprofile
                                            <flavor_profile>
                                            [--description <description>]
                                            [--enable | --disable]

表 47.26. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新类别名称。

--flavorprofile <flavor_profile>

将类别添加到(name 或 id)的 flavor 配置集。

--description <description>

设置类别描述。

--enable

启用类别。

--disable

禁用类别。

表 47.27. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.28. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.29. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.30. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.9. LoadBalancer 类别删除

删除类别

使用方法:

openstack loadbalancer flavor delete [-h] <flavor>

表 47.31. positional 参数
概述

<flavor>

要删除的类别(名称或 id)

表 47.32. 命令参数
概述

-h, --help

显示帮助信息并退出

47.10. LoadBalancer 类别列表

列出类别

使用方法:

openstack loadbalancer flavor list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          [--name <name>]
                                          [--flavorprofile <flavor_profile>]
                                          [--enable | --disable]

表 47.33. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

根据类别的名称列出类别。

--flavorprofile <flavor_profile>

根据类别配置文件,列出类别。

--enable

列出已启用的类别。

--disable

列出禁用的类别。

表 47.34. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 47.35. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 47.36. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.37. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.11. LoadBalancer 类别集

更新类别

使用方法:

openstack loadbalancer flavor set [-h] [--name <name>]
                                         [--enable | --disable]
                                         <flavor>

表 47.38. positional 参数
概述

<flavor>

要更新的类别的名称或 uuid。

表 47.39. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置类别的名称。

--enable

启用类别。

--disable

禁用类别。

47.12. LoadBalancer 类别显示

显示单个类别的详情

使用方法:

openstack loadbalancer flavor show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <flavor>

表 47.40. positional 参数
概述

<flavor>

类别的名称或 uuid。

表 47.41. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.42. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.43. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.44. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.45. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.13. LoadBalancer 类别未设置

清除健康监控器设置

使用方法:

openstack loadbalancer flavor unset [-h] [--description] <flavor>

表 47.46. positional 参数
概述

<flavor>

要更新的类别(名称或 id)。

表 47.47. 命令参数
概述

-h, --help

显示帮助信息并退出

--description

清除类别描述。

47.14. LoadBalancer flavorprofile create

创建 octavia 类别配置集

使用方法:

openstack loadbalancer flavorprofile create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty] --name
                                                   <name> --provider <provider
                                                   name> --flavor-data
                                                   <flavor_data>

表 47.48. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新的 octavia 类别配置集名称。

--provider <provider name>

类别配置文件的提供程序名称。

--flavor-data <flavor_data>

包含类别元数据的 json 字符串。

表 47.49. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.50. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.51. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.52. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.15. LoadBalancer flavorprofile delete

删除类别配置集

使用方法:

openstack loadbalancer flavorprofile delete [-h] <flavor_profile>

表 47.53. positional 参数
概述

<flavor_profile>

要删除的类别配置集(名称或 id)

表 47.54. 命令参数
概述

-h, --help

显示帮助信息并退出

47.16. LoadBalancer flavorprofile list

列出类别配置集

使用方法:

openstack loadbalancer flavorprofile list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]
                                                 [--name <name>]
                                                 [--provider <provider_name>]

表 47.55. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

根据类别配置文件名称列出类别配置文件。

--provider <provider_name>

根据提供程序列出类别配置文件。

表 47.56. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 47.57. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 47.58. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.59. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.17. 设置了 LoadBalancer flavorprofile

更新类别配置集

使用方法:

openstack loadbalancer flavorprofile set [-h] [--name <name>]
                                                [--provider <provider_name>]
                                                [--flavor-data <flavor_data>]
                                                <flavor_profile>

表 47.60. positional 参数
概述

<flavor_profile>

要更新的 flavor 配置集的名称或 uuid。

表 47.61. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置 flavor 配置集的名称。

--provider <provider_name>

设置 flavor 配置集的提供程序。

--flavor-data <flavor_data>

设置 flavor 配置集的类别数据。

47.18. LoadBalancer flavorprofile show

显示单个类别配置集的详细信息

使用方法:

openstack loadbalancer flavorprofile show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 <flavor_profile>

表 47.62. positional 参数
概述

<flavor_profile>

要显示的类别配置文件的 name 或 uuid。

表 47.63. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.64. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.65. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.66. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.67. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.19. LoadBalancer healthmonitor create

创建运行状况监控器

使用方法:

openstack loadbalancer healthmonitor create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--name <name>] --delay
                                                   <delay>
                                                   [--domain-name <domain_name>]
                                                   [--expected-codes <codes>]
                                                   [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
                                                   [--http-version <http_version>]
                                                   --timeout <timeout>
                                                   --max-retries <max_retries>
                                                   [--url-path <url_path>]
                                                   --type
                                                   {PING,HTTP,TCP,HTTPS,TLS-HELLO,UDP-CONNECT}
                                                   [--max-retries-down <max_retries_down>]
                                                   [--enable | --disable]
                                                   <pool>

表 47.68. positional 参数
概述

<pool>

为健康监控器(name 或 id)设置池。

表 47.69. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置运行状况监控器名称。

--delay <delay>

设置向成员发送探测之间的时间(以秒为单位)。

--domain-name <domain_name>

设置域名,该域名注入到 http Host Header 中,以进行 HTTP 健康检查。

--expected-codes <codes>

设置来自成员的响应时预期的 http 状态代码列表,以声明它处于健康状态。

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

设置运行状况监视器用于请求的 http 方法。

--http-version <http_version>

设置 http 版本。

--timeout <timeout>

设置监视器在超时前等待连接的最大时间(以秒为单位)。这个值必须小于 delay 值。

--max-retries <max_retries>

在将成员操作状态改为 ONLINE 之前成功检查的数量。

--url-path <url_path>

设置监控器发送的请求的 http url 路径,以测试后端成员的健康状况。

--type {PING,HTTP,TCP,HTTPS,TLS-HELLO,UDP-CONNECT}

设置运行状况监控器类型。

--max-retries-down <max_retries_down>

在将成员的操作状态改为 ERROR 之前,将允许的检查失败数量设置为 ERROR。

--enable

启用运行状况监控器(默认)。

--disable

禁用运行状况监控器。

表 47.70. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.71. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.72. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.73. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.20. LoadBalancer healthmonitor delete

删除运行状况监控器

使用方法:

openstack loadbalancer healthmonitor delete [-h] <health_monitor>

表 47.74. positional 参数
概述

<health_monitor>

要删除的健康监控器(名称或 id)。

表 47.75. 命令参数
概述

-h, --help

显示帮助信息并退出

47.21. LoadBalancer healthmonitor list

列出运行状况监控器

使用方法:

openstack loadbalancer healthmonitor list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]

表 47.76. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.77. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 47.78. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 47.79. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.80. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.22. LoadBalancer healthmonitor set

更新运行状况监控器

使用方法:

openstack loadbalancer healthmonitor set [-h] [--name <name>]
                                                [--delay <delay>]
                                                [--domain-name <domain_name>]
                                                [--expected-codes <codes>]
                                                [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
                                                [--http-version <http_version>]
                                                [--timeout <timeout>]
                                                [--max-retries <max_retries>]
                                                [--max-retries-down <max_retries_down>]
                                                [--url-path <url_path>]
                                                [--enable | --disable]
                                                <health_monitor>

表 47.81. positional 参数
概述

<health_monitor>

要更新(名称或 id)的健康状态监控器。

表 47.82. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置运行状况监控器名称。

--delay <delay>

设置向成员发送探测之间的时间(以秒为单位)。

--domain-name <domain_name>

设置域名,该域名注入到 http Host Header 中,以进行 HTTP 健康检查。

--expected-codes <codes>

设置来自成员的响应时预期的 http 状态代码列表,以声明它处于健康状态。

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

设置运行状况监视器用于请求的 http 方法。

--http-version <http_version>

设置 http 版本。

--timeout <timeout>

设置监视器在超时前等待连接的最大时间(以秒为单位)。这个值必须小于 delay 值。

--max-retries <max_retries>

在将成员的操作状态改为 ONLINE 前,先设置成功检查的数量。

--max-retries-down <max_retries_down>

在将成员的操作状态改为 ERROR 之前,将允许的检查失败数量设置为 ERROR。

--url-path <url_path>

设置监控器发送的请求的 http url 路径,以测试后端成员的健康状况。

--enable

启用运行状况监控器。

--disable

禁用运行状况监控器。

47.23. LoadBalancer healthmonitor show

显示单个健康监控器的详情

使用方法:

openstack loadbalancer healthmonitor show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 <health_monitor>

表 47.83. positional 参数
概述

<health_monitor>

健康监控器的名称或 uuid。

表 47.84. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.85. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.86. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.87. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.88. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.24. LoadBalancer healthmonitor unset

清除健康监控器设置

使用方法:

openstack loadbalancer healthmonitor unset [-h] [--domain-name]
                                                  [--expected-codes]
                                                  [--http-method]
                                                  [--http-version]
                                                  [--max-retries-down]
                                                  [--name] [--url-path]
                                                  <health_monitor>

表 47.89. positional 参数
概述

<health_monitor>

要更新(名称或 id)的健康状态监控器。

表 47.90. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain-name

清除运行状况监控域名。

--expected-codes

将运行状况监控器预期代码重置为 api 默认。

--http-method

将运行状况监控器 http 方法重置为 api 默认。

--http-version

将运行状况监控器 http 版本重置为 api 默认。

--max-retries-down

将运行状况 monitor max retries 重置为 api 默认。

--name

清除运行状况监控器名称。

--url-path

清除运行状况监控 url 路径。

47.25. LoadBalancer l7policy create

创建 l7policy

使用方法:

openstack loadbalancer l7policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--name <name>]
                                              [--description <description>]
                                              --action
                                              {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}
                                              [--redirect-pool <pool> | --redirect-url <url> | --redirect-prefix <url>]
                                              [--redirect-http-code <redirect_http_code>]
                                              [--position <position>]
                                              [--enable | --disable]
                                              <listener>

表 47.91. positional 参数
概述

<listener>

侦听器将 l7policy 添加到(name 或 id)。

表 47.92. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置 l7policy 名称。

--description <description>

设置 l7policy 描述。

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}

设置策略的操作。

--redirect-pool <pool>

将池设置为重定向请求到(name 或 id)。

--redirect-url <url>

将 URL 设置为重定向请求。

--redirect-prefix <url>

将 URL 前缀设置为重定向请求。

--redirect-http-code <redirect_http_code>

为 redirect_url 或REDIRECT_PREFIX 操作设置 http 响应代码。

--position <position>

此 l7 策略的序列号。

--enable

启用 l7policy (默认)。

--disable

禁用 l7policy。

表 47.93. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.94. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.95. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.96. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.26. LoadBalancer l7policy delete

删除 l7policy

使用方法:

openstack loadbalancer l7policy delete [-h] <policy>

表 47.97. positional 参数
概述

<policy>

要删除的 L7policy (名称或 id)。

表 47.98. 命令参数
概述

-h, --help

显示帮助信息并退出

47.27. LoadBalancer l7policy list

列出 l7policies

使用方法:

openstack loadbalancer l7policy list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]

表 47.99. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.100. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 47.101. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 47.102. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.103. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.28. LoadBalancer l7policy set

更新 l7policy

使用方法:

openstack loadbalancer l7policy set [-h] [--name <name>]
                                           [--description <description>]
                                           [--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}]
                                           [--redirect-pool <pool> | --redirect-url <url> | --redirect-prefix <url>]
                                           [--redirect-http-code <redirect_http_code>]
                                           [--position <position>]
                                           [--enable | --disable]
                                           <policy>

表 47.104. positional 参数
概述

<policy>

要更新的 L7policy (名称或 id)。

表 47.105. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置 l7policy name。

--description <description>

设置 l7policy 描述。

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}

设置策略的操作。

--redirect-pool <pool>

将池设置为重定向请求到(name 或 id)。

--redirect-url <url>

将 URL 设置为重定向请求。

--redirect-prefix <url>

将 URL 前缀设置为重定向请求。

--redirect-http-code <redirect_http_code>

为 redirect_url 或REDIRECT_PREFIX 操作设置 http 响应代码。

--position <position>

设置此 l7 策略的序列号。

--enable

启用 l7policy。

--disable

禁用 l7policy。

47.29. LoadBalancer l7policy show

显示单个 l7policy 的详情

使用方法:

openstack loadbalancer l7policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <policy>

表 47.106. positional 参数
概述

<policy>

l7policy 的名称或 uuid。

表 47.107. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.108. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.109. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.110. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.111. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.30. LoadBalancer l7policy unset

清除 l7policy 设置

使用方法:

openstack loadbalancer l7policy unset [-h] [--description] [--name]
                                             [--redirect-http-code]
                                             <policy>

表 47.112. positional 参数
概述

<policy>

要更新的 L7policy (名称或 id)。

表 47.113. 命令参数
概述

-h, --help

显示帮助信息并退出

--description

清除 l7policy 描述。

--name

清除 l7policy 名称。

--redirect-http-code

清除 l7policy 重定向 http 代码。

47.31. LoadBalancer l7rule create

创建 l7rule

使用方法:

openstack loadbalancer l7rule create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            --compare-type
                                            {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}
                                            [--invert] --value <value>
                                            [--key <key>] --type
                                            {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}
                                            [--enable | --disable]
                                            <l7policy>

表 47.114. positional 参数
概述

<l7policy>

将 l7rule 添加到(名称或 id)的 L7policy。

表 47.115. 命令参数
概述

-h, --help

显示帮助信息并退出

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

为 l7rule 设置比较类型。

--invert

反转 l7rule。

--value <value>

将规则值设置为 match on。

--key <key>

将 l7rule 的值设置为匹配的键。

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}

为 l7rule 设置类型。

--enable

启用 l7rule (默认)。

--disable

禁用 l7rule。

表 47.116. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.117. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.118. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.119. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.32. LoadBalancer l7rule delete

删除 l7rule

使用方法:

openstack loadbalancer l7rule delete [-h] <l7policy> <rule_id>

表 47.120. positional 参数
概述

<l7policy>

从中删除规则的 L7policy。

<rule_id>

要删除的 L7rule。

表 47.121. 命令参数
概述

-h, --help

显示帮助信息并退出

47.33. LoadBalancer l7rule list

列出 l7policy 的 l7rules

使用方法:

openstack loadbalancer l7rule list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          <l7policy>

表 47.122. positional 参数
概述

<l7policy>

用于列出(名称或 ID)的规则的 L7policy。

表 47.123. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.124. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 47.125. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 47.126. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.127. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.34. LoadBalancer l7rule set

更新 l7rule

使用方法:

openstack loadbalancer l7rule set [-h]
                                         [--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}]
                                         [--invert] [--value <value>]
                                         [--key <key>]
                                         [--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}]
                                         [--enable | --disable]
                                         <l7policy> <l7rule_id>

表 47.128. positional 参数
概述

<l7policy>

用于更新 l7rule 的 L7policy (名称或 id)。

<l7rule_id>

要更新的 L7rule。

表 47.129. 命令参数
概述

-h, --help

显示帮助信息并退出

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

为 l7rule 设置比较类型。

--invert

反转 l7rule。

--value <value>

将规则值设置为 match on。

--key <key>

将 l7rule 的值设置为匹配的键。

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}

为 l7rule 设置类型。

--enable

启用 l7rule。

--disable

禁用 l7rule。

47.35. LoadBalancer l7rule show

显示单个 l7rule 的详情

使用方法:

openstack loadbalancer l7rule show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <l7policy> <l7rule_id>

表 47.130. positional 参数
概述

<l7policy>

L7policy 来显示来自(名称或 id)的规则。

<l7rule_id>

要显示的 L7rule。

表 47.131. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.132. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.133. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.134. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.135. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.36. LoadBalancer l7rule unset

清除 l7rule 设置

使用方法:

openstack loadbalancer l7rule unset [-h] [--invert] [--key]
                                           <l7policy> <l7rule_id>

表 47.136. positional 参数
概述

<l7policy>

要更新的 L7policy (名称或 id)。

<l7rule_id>

要更新的 L7rule。

表 47.137. 命令参数
概述

-h, --help

显示帮助信息并退出

--invert

将 l7rule 反转重置为 api 默认值。

--key

清除 l7rule 键。

47.37. LoadBalancer list

列出负载均衡器

使用方法:

openstack loadbalancer list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN] [--name <name>]
                                   [--enable | --disable]
                                   [--project <project-id>]
                                   [--vip-network-id <vip_network_id>]
                                   [--vip-subnet-id <vip_subnet_id>]
                                   [--vip-qos-policy-id <vip_qos_policy_id>]
                                   [--vip-port-id <vip_port_id>]
                                   [--provisioning-status {ACTIVE,DELETED,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE}]
                                   [--operating-status {ONLINE,DRAINING,OFFLINE,DEGRADED,ERROR,NO_MONITOR}]
                                   [--provider <provider>] [--flavor <flavor>]

表 47.138. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

根据名称列出负载均衡器。

--enable

列出启用的负载均衡器。

--disable

列出禁用的负载均衡器。

--project <project-id>

根据项目(名称或 ID)列出负载均衡器。

--vip-network-id <vip_network_id>

根据 vip 网络(名称或 ID)列出负载均衡器。

--vip-subnet-id <vip_subnet_id>

根据 vip 子网(名称或 ID)列出负载均衡器。

--vip-qos-policy-id <vip_qos_policy_id>

根据 vip qos 策略(名称或 ID)列出负载均衡器。

--vip-port-id <vip_port_id>

根据 vip 端口(名称或 ID)列出负载均衡器。

--provisioning-status {ACTIVE,DELETED,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE}

根据置备状态列出负载均衡器。

--operating-status {ONLINE,DRAINING,OFFLINE,DEGRADED,ERROR,NO_MONITOR}

根据操作状态列出负载均衡器。

--provider <provider>

根据供应商列出负载均衡器。

--flavor <flavor>

根据类别列出负载均衡器。

表 47.139. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 47.140. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 47.141. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.142. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.38. LoadBalancer 侦听器创建

创建监听程序

使用方法:

openstack loadbalancer listener create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--name <name>]
                                              [--description <description>]
                                              --protocol
                                              {TCP,HTTP,HTTPS,TERMINATED_HTTPS,UDP}
                                              [--connection-limit <limit>]
                                              [--default-pool <pool>]
                                              [--default-tls-container-ref <container_ref>]
                                              [--sni-container-refs [<container_ref> [<container_ref> ...]]]
                                              [--insert-headers <header=value,...>]
                                              --protocol-port <port>
                                              [--timeout-client-data <timeout>]
                                              [--timeout-member-connect <timeout>]
                                              [--timeout-member-data <timeout>]
                                              [--timeout-tcp-inspect <timeout>]
                                              [--enable | --disable]
                                              [--client-ca-tls-container-ref <container_ref>]
                                              [--client-authentication {NONE,OPTIONAL,MANDATORY}]
                                              [--client-crl-container-ref <client_crl_container_ref>]
                                              [--allowed-cidr [<allowed_cidr>]]
                                              <loadbalancer>

表 47.143. positional 参数
概述

<loadbalancer>

监听器的负载均衡器(名称或 id)。

表 47.144. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置监听程序名称。

--description <description>

设置此监听器的描述。

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,UDP}

监听器的协议。

--connection-limit <limit>

设置此监听器允许的最大连接数。

--default-pool <pool>

如果没有 L7 策略匹配,则设置监听程序使用的池的名称或 id。

--default-tls-container-ref <container_ref>

到密钥管理器服务 secret 容器的 uri,其中包含 TERMINATED_TLS 侦听器的证书和密钥。

--sni-container-refs [<container_ref> [<container_ref> …​]]

密钥管理器服务 secret 容器的 uri 列表,包含使用 Server Name Indication 的 TERMINATED_TLS 的证书和密钥。

--insert-headers <header=value,…​>

在将请求发送到后端成员前插入请求的可选标头字典。

--protocol-port <port>

为监听器设置协议端口号。

--timeout-client-data <timeout>

前端客户端不活跃超时(毫秒)。默认: 50000。

--timeout-member-connect <timeout>

后端成员连接超时(毫秒)。默认: 5000。

--timeout-member-data <timeout>

后端成员不活跃超时(毫秒)。默认: 50000。

--timeout-tcp-inspect <timeout>

等待额外 tcp 数据包进行内容检查的时间(以毫秒为单位)。默认: 0。

--enable

启用监听器(默认)。

--disable

禁用监听程序。

--client-ca-tls-container-ref <container_ref>

包含 TERMINATED_TLS 侦听器的 CA 证书的密钥管理器服务 secret 容器的 uri。

--client-authentication {NONE,OPTIONAL,MANDATORY}

tls 客户端身份验证验证 TERMINATED_TLS 侦听器的选项。

--client-crl-container-ref <client_crl_container_ref>

密钥管理器服务 secret 容器的 uri 包含 TERMINATED_TLS 侦听器的 CA 吊销列表文件。

--allowed-cidr [<allowed_cidr>]

CIDR 允许访问监听程序(可多次设置)。

表 47.145. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.146. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.147. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.148. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.39. LoadBalancer 侦听器删除

删除监听程序

使用方法:

openstack loadbalancer listener delete [-h] <listener>

表 47.149. positional 参数
概述

<listener>

要删除的监听程序(名称或 id)

表 47.150. 命令参数
概述

-h, --help

显示帮助信息并退出

47.40. LoadBalancer 侦听器列表

列出监听程序

使用方法:

openstack loadbalancer listener list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]
                                            [--name <name>]
                                            [--loadbalancer <loadbalancer>]
                                            [--enable | --disable]
                                            [--project <project>]

表 47.151. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

根据监听程序名称列出监听程序。

--LoadBalancer <loadbalancer>

按负载均衡器(名称或 id)过滤。

--enable

列出启用的监听程序。

--disable

列出禁用的监听程序。

--project <project>

按项目 ID 列出监听程序。

表 47.152. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 47.153. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 47.154. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.155. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.41. LoadBalancer 侦听程序集

更新监听程序

使用方法:

openstack loadbalancer listener set [-h] [--name <name>]
                                           [--description <description>]
                                           [--connection-limit <limit>]
                                           [--default-pool <pool>]
                                           [--default-tls-container-ref <container-ref>]
                                           [--sni-container-refs [<container-ref> [<container-ref> ...]]]
                                           [--insert-headers <header=value>]
                                           [--timeout-client-data <timeout>]
                                           [--timeout-member-connect <timeout>]
                                           [--timeout-member-data <timeout>]
                                           [--timeout-tcp-inspect <timeout>]
                                           [--enable | --disable]
                                           [--client-ca-tls-container-ref <container_ref>]
                                           [--client-authentication {NONE,OPTIONAL,MANDATORY}]
                                           [--client-crl-container-ref <client_crl_container_ref>]
                                           [--allowed-cidr [<allowed_cidr>]]
                                           <listener>

表 47.156. positional 参数
概述

<listener>

要修改(名称或 id)的监听程序。

表 47.157. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置监听程序名称。

--description <description>

设置此监听器的描述。

--connection-limit <limit>

此监听器允许的最大连接数。默认值为 -1,代表无限连接。

--default-pool <pool>

如果没有 l7 策略匹配,则监听器使用的池的 id。

--default-tls-container-ref <container-ref>

密钥管理器服务 secret 容器的 uri,其中包含 TERMINATED_TLSlisteners 的证书和密钥。

--sni-container-refs [<container-ref> [<container-ref> …​]]

密钥管理器服务 secret 容器的 uri 列表,包含使用 Server Name Indication 的 TERMINATED_TLS 的证书和密钥。

--insert-headers <header=value>

在将请求发送到后端成员前插入请求的可选标头字典。

--timeout-client-data <timeout>

前端客户端不活跃超时(毫秒)。默认: 50000。

--timeout-member-connect <timeout>

后端成员连接超时(毫秒)。默认: 5000。

--timeout-member-data <timeout>

后端成员不活跃超时(毫秒)。默认: 50000。

--timeout-tcp-inspect <timeout>

等待额外 tcp 数据包进行内容检查的时间(以毫秒为单位)。默认: 0。

--enable

启用监听程序。

--disable

禁用监听程序。

--client-ca-tls-container-ref <container_ref>

包含 TERMINATED_TLS 侦听器的 CA 证书的密钥管理器服务 secret 容器的 uri。

--client-authentication {NONE,OPTIONAL,MANDATORY}

tls 客户端身份验证验证 TERMINATED_TLS 侦听器的选项。

--client-crl-container-ref <client_crl_container_ref>

密钥管理器服务 secret 容器的 uri 包含 TERMINATED_TLS 侦听器的 CA 吊销列表文件。

--allowed-cidr [<allowed_cidr>]

CIDR 允许访问监听程序(可多次设置)。

47.42. LoadBalancer 侦听器显示

显示单个监听程序的详情

使用方法:

openstack loadbalancer listener show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <listener>

表 47.158. positional 参数
概述

<listener>

监听器的名称或 uuid

表 47.159. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.160. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.161. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.162. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.163. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.43. LoadBalancer 侦听器统计显示

显示监听器的当前统计信息。

使用方法:

openstack loadbalancer listener stats show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  <listener>

表 47.164. positional 参数
概述

<listener>

监听器的名称或 uuid

表 47.165. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.166. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.167. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.168. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.169. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.44. LoadBalancer 侦听程序取消设置

清除监听程序设置

使用方法:

openstack loadbalancer listener unset [-h] [--name] [--description]
                                             [--connection-limit]
                                             [--default-pool]
                                             [--default-tls-container-ref]
                                             [--sni-container-refs]
                                             [--insert-headers]
                                             [--timeout-client-data]
                                             [--timeout-member-connect]
                                             [--timeout-member-data]
                                             [--timeout-tcp-inspect]
                                             [--client-ca-tls-container-ref]
                                             [--client-authentication]
                                             [--client-crl-container-ref]
                                             [--allowed-cidrs]
                                             <listener>

表 47.170. positional 参数
概述

<listener>

要修改(名称或 id)的监听程序。

表 47.171. 命令参数
概述

-h, --help

显示帮助信息并退出

--name

清除监听程序名称。

--description

清除此监听器的描述。

--connection-limit

将连接限制重置为 api 默认。

--default-pool

从监听器清除默认池。

--default-tls-container-ref

从监听器中删除默认 tls 容器引用。

--sni-container-refs

从监听器中删除 tls sni 容器引用。

--insert-headers

从监听器清除插入标头。

--timeout-client-data

将客户端数据超时重置为 api 默认。

--timeout-member-connect

将成员连接超时重置为 api 默认值。

--timeout-member-data

将成员数据超时重置为 api 默认。

--timeout-tcp-inspect

将 tcp 检查超时重置为 api 默认值。

--client-ca-tls-container-ref

清除监听器中的 client ca tls 容器引用。

--client-authentication

将客户端身份验证设置重置为 api 默认值。

--client-crl-container-ref

从监听器清除客户端 crl 容器引用。

--allowed-cidrs

从监听器清除所有允许的 cidr。

47.45. LoadBalancer 成员创建

在池中创建成员

使用方法:

openstack loadbalancer member create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--name <name>]
                                            [--disable-backup | --enable-backup]
                                            [--weight <weight>] --address
                                            <ip_address>
                                            [--subnet-id <subnet_id>]
                                            --protocol-port <protocol_port>
                                            [--monitor-port <monitor_port>]
                                            [--monitor-address <monitor_address>]
                                            [--enable | --disable]
                                            <pool>

表 47.172. positional 参数
概述

<pool>

要创建成员的池的 ID 或名称。

表 47.173. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

成员的名称。

--disable-backup

禁用成员备份(默认)

--enable-backup

启用成员备份

--weight <weight>

与池的其他成员相比,成员的权重决定了请求或服务的比例或连接。

--address <ip_address>

后端成员服务器的 ip 地址

--subnet-id <subnet_id>

可以从其访问成员服务的子网 ID。

--protocol-port <protocol_port>

后端成员服务器正在侦听的协议端口号。

--monitor-port <monitor_port>

用于监控后端成员的备用协议端口。

--monitor-address <monitor_address>

用于监控后端成员的备用 IP 地址。

--enable

启用成员(默认)

--disable

禁用成员

表 47.174. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.175. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.176. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.177. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.46. LoadBalancer 成员删除

从池中删除成员

使用方法:

openstack loadbalancer member delete [-h] <pool> <member>

表 47.178. positional 参数
概述

<pool>

要从中删除成员的池名称或 id。

<member>

要删除的成员的名称或 ID。

表 47.179. 命令参数
概述

-h, --help

显示帮助信息并退出

47.47. LoadBalancer 成员列表

列出池中的成员

使用方法:

openstack loadbalancer member list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          <pool>

表 47.180. positional 参数
概述

<pool>

列出成员的池名称或 id。

表 47.181. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.182. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 47.183. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 47.184. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.185. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.48. LoadBalancer 成员集

更新成员

使用方法:

openstack loadbalancer member set [-h] [--name <name>]
                                         [--disable-backup | --enable-backup]
                                         [--weight <weight>]
                                         [--monitor-port <monitor_port>]
                                         [--monitor-address <monitor_address>]
                                         [--enable | --disable]
                                         <pool> <member>

表 47.186. positional 参数
概述

<pool>

要更新的成员所属的池(名称或 ID)。

<member>

要更新的成员的名称或 ID

表 47.187. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置成员的名称

--disable-backup

禁用成员备份(默认)

--enable-backup

启用成员备份

--weight <weight>

设置池中成员的权重

--monitor-port <monitor_port>

用于监控后端成员的备用协议端口

--monitor-address <monitor_address>

用于监控后端成员的备用 IP 地址。

--enable

将 admin_state_up 设置为 true

--disable

将 admin_state_up 设置为 false

47.49. LoadBalancer 成员显示

显示单个成员的详情

使用方法:

openstack loadbalancer member show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <pool> <member>

表 47.188. positional 参数
概述

<pool>

要显示成员的池名称或 id。

<member>

要显示的成员的名称或 ID。

表 47.189. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.190. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.191. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.192. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.193. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.50. LoadBalancer 成员取消设置

清除成员设置

使用方法:

openstack loadbalancer member unset [-h] [--backup] [--monitor-address]
                                           [--monitor-port] [--name]
                                           [--weight]
                                           <pool> <member>

表 47.194. positional 参数
概述

<pool>

要更新的成员所属的池(名称或 id)。

<member>

要修改的成员(名称或 id)。

表 47.195. 命令参数
概述

-h, --help

显示帮助信息并退出

--backup

清除备份成员标志。

--monitor-address

清除 member monitor 地址。

--monitor-port

清除 member 监控端口。

--name

清除成员名称。

--weight

将成员权重重置为 api 默认。

47.51. LoadBalancer 池创建

创建池

使用方法:

openstack loadbalancer pool create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--name <name>]
                                          [--description <description>]
                                          --protocol
                                          {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY,UDP}
                                          (--listener <listener> | --loadbalancer <load_balancer>)
                                          [--session-persistence <session persistence>]
                                          --lb-algorithm
                                          {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT}
                                          [--enable | --disable]
                                          [--tls-container-ref <container-ref>]
                                          [--ca-tls-container-ref <ca_tls_container_ref>]
                                          [--crl-container-ref <crl_container_ref>]
                                          [--enable-tls | --disable-tls]

表 47.196. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置池名称。

--description <description>

设置池描述。

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY,UDP}

设置池协议。

--listener <listener>

侦听器将池添加到(名称或 id)。

--loadbalancer <load_balancer>

加载 balncer 将池添加到(名称或 id)

--session-persistence <session persistence>

为监听器设置会话持久性(key=value)。

--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT}

要使用的负载平衡算法。

--enable

启用池(默认)。

--disable

禁用池。

--tls-container-ref <container-ref>

对密钥管理器服务 secret 容器的引用,其中包含 'tls_enabled''pools 的证书和密钥,以重新保护到后端服务器的流量。

--ca-tls-container-ref <ca_tls_container_ref>

对包含 'tls_enabled' 池 CA 证书的密钥管理器服务 secret 容器的引用,以检查后端成员服务器证书

--crl-container-ref <crl_container_ref>

密钥管理器服务 secret 容器的引用包含 ''tls_enabled' 池的 CA 撤销列表文件,以验证后端成员服务器证书。

--enable-tls

启用后端成员重新加密。

--disable-tls

禁用后端成员重新加密。

表 47.197. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.198. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.199. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.200. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.52. LoadBalancer 池删除

删除池

使用方法:

openstack loadbalancer pool delete [-h] <pool>

表 47.201. positional 参数
概述

<pool>

要删除的池(名称或 id)。

表 47.202. 命令参数
概述

-h, --help

显示帮助信息并退出

47.53. LoadBalancer 池列表

列出池

使用方法:

openstack loadbalancer pool list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--loadbalancer <loadbalancer>]

表 47.203. 命令参数
概述

-h, --help

显示帮助信息并退出

--LoadBalancer <loadbalancer>

按负载均衡器(名称或 id)过滤。

表 47.204. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 47.205. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 47.206. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.207. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.54. LoadBalancer 池集

更新池

使用方法:

openstack loadbalancer pool set [-h] [--name <name>]
                                       [--description <description>]
                                       [--session-persistence <session_persistence>]
                                       [--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT}]
                                       [--enable | --disable]
                                       [--tls-container-ref <container-ref>]
                                       [--ca-tls-container-ref <ca_tls_container_ref>]
                                       [--crl-container-ref <crl_container_ref>]
                                       [--enable-tls | --disable-tls]
                                       <pool>

表 47.208. positional 参数
概述

<pool>

要更新的池(名称或 id)。

表 47.209. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置池的名称。

--description <description>

设置池的描述。

--session-persistence <session_persistence>

为监听器设置会话持久性(key=value)。

--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP_PORT}

设置要使用的负载平衡算法。

--enable

启用池。

--disable

禁用池。

--tls-container-ref <container-ref>

到密钥管理器服务 secret 容器的 uri,其中包含 TERMINATED_TLS 池的证书和密钥,以重新保护从 TERMINATED_TLS 侦听器到后端服务器的流量。

--ca-tls-container-ref <ca_tls_container_ref>

密钥管理器服务 secret 容器的 uri 容器,其中包含 TERMINATED_TLS 侦听器的 CA 证书,以检查 ssl 流量中的后端服务器证书。

--crl-container-ref <crl_container_ref>

到密钥管理器服务 secret 容器的 uri 包含 TERMINATED_TLS 侦听器的 CA 吊销列表文件,以在 ssl 流量中有效后端服务器证书。

--enable-tls

启用后端关联的成员重新加密。

--disable-tls

禁用后端关联的成员重新加密。

47.55. LoadBalancer 池显示

显示单个池的详情

使用方法:

openstack loadbalancer pool show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <pool>

表 47.210. positional 参数
概述

<pool>

池的名称或 uuid。

表 47.211. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.212. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.213. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.214. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.215. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.56. 取消设置 LoadBalancer 池

清除池设置

使用方法:

openstack loadbalancer pool unset [-h] [--name] [--description]
                                         [--ca-tls-container-ref]
                                         [--crl-container-ref]
                                         [--session-persistence]
                                         [--tls-container-ref]
                                         <pool>

表 47.216. positional 参数
概述

<pool>

要修改的池(名称或 id)。

表 47.217. 命令参数
概述

-h, --help

显示帮助信息并退出

--name

清除池名称。

--description

清除此池的描述。

--ca-tls-container-ref

清除此池上的证书颁发机构证书引用。

--crl-container-ref

清除此池上的证书撤销列表引用。

--session-persistence

禁用池中的会话持久性。

--tls-container-ref

清除此池的证书引用。

47.57. LoadBalancer 供应商功能列表

列表指定的供应商驱动程序的类别大写。

使用方法:

openstack loadbalancer provider capability list [-h]
                                                       [-f {csv,json,table,value,yaml}]
                                                       [-c COLUMN]
                                                       [--quote {all,minimal,none,nonnumeric}]
                                                       [--noindent]
                                                       [--max-width <integer>]
                                                       [--fit-width]
                                                       [--print-empty]
                                                       [--sort-column SORT_COLUMN]
                                                       <provider_name>

表 47.218. positional 参数
概述

<provider_name>

供应商驱动程序的名称。

表 47.219. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.220. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 47.221. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 47.222. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.223. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.58. LoadBalancer 供应商列表

列出所有供应商

使用方法:

openstack loadbalancer provider list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]

表 47.224. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.225. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 47.226. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 47.227. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.228. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.59. LoadBalancer 配额默认设置显示

显示配额默认值

使用方法:

openstack loadbalancer quota defaults show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]

表 47.229. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.230. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.231. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.232. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.233. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.60. LoadBalancer 配额列表

列出配额

使用方法:

openstack loadbalancer quota list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]
                                         [--project <project-id>]

表 47.234. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project-id>

项目的名称或 uuid。

表 47.235. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 47.236. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 47.237. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.238. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.61. LoadBalancer 配额重置

将配额重置为默认配额

使用方法:

openstack loadbalancer quota reset [-h] <project>

表 47.239. positional 参数
概述

<project>

要重置配额的项目(名称或 id)

表 47.240. 命令参数
概述

-h, --help

显示帮助信息并退出

47.62. LoadBalancer 配额集

更新配额

使用方法:

openstack loadbalancer quota set [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--healthmonitor <health_monitor>]
                                        [--listener <listener>]
                                        [--loadbalancer <load_balancer>]
                                        [--member <member>] [--pool <pool>]
                                        <project>

表 47.241. positional 参数
概述

<project>

项目的名称或 uuid。

表 47.242. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.243. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.244. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.245. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.246. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

表 47.247. 配额限制
概述

至少需要以下参数之一。--healthmonitor <health_monitor>

health monitor quota. value -1 的新值表示没有限制。

--listener <listener>

监听器 quota. value -1 的新值表示没有限制。

--loadbalancer <load_balancer>

负载均衡器配额限制的新值。值 -1 代表无限。

--member <member>

成员配额限制的新值 -1 表示无限。

--pool <pool>

池配额限制的新值 -1 表示无限。

47.63. LoadBalancer 配额显示

显示项目的配额详情

使用方法:

openstack loadbalancer quota show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <project>

表 47.248. positional 参数
概述

<project>

项目的名称或 uuid。

表 47.249. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.250. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.251. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.252. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.253. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.64. 取消设置 LoadBalancer 配额

清除配额设置

使用方法:

openstack loadbalancer quota unset [-h] [--loadbalancer] [--listener]
                                          [--pool] [--member]
                                          [--healthmonitor]
                                          <project>

表 47.254. positional 参数
概述

<project>

项目的名称或 uuid。

表 47.255. 命令参数
概述

-h, --help

显示帮助信息并退出

--loadbalancer

将负载均衡器配额重置为默认值。

--listener

将监听程序配额重置为默认值。

--pool

将池配额重置为默认值。

--member

将成员配额重置为默认值。

--healthmonitor

将运行状况监控器配额重置为默认值。

47.65. 设置了 LoadBalancer

更新负载均衡器

使用方法:

openstack loadbalancer set [-h] [--name <name>]
                                  [--description <description>]
                                  [--vip-qos-policy-id <vip_qos_policy_id>]
                                  [--enable | --disable]
                                  <load_balancer>

表 47.256. positional 参数
概述

<load_balancer>

要更新的负载均衡器的名称或 uuid。

表 47.257. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置负载均衡器名称。

--description <description>

设置负载均衡器描述。

--vip-qos-policy-id <vip_qos_policy_id>

为 vip 端口设置 qos 策略 ID。取消设置

--enable

启用负载均衡器。

--disable

禁用负载均衡器。

47.66. LoadBalancer show

显示单个负载均衡器的详情

使用方法:

openstack loadbalancer show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <load_balancer>

表 47.258. positional 参数
概述

<load_balancer>

负载均衡器的名称或 uuid。

表 47.259. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.260. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.261. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.262. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.263. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.67. LoadBalancer stats show

显示负载均衡器的当前统计信息

使用方法:

openstack loadbalancer stats show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <load_balancer>

表 47.264. positional 参数
概述

<load_balancer>

负载均衡器的名称或 uuid。

表 47.265. 命令参数
概述

-h, --help

显示帮助信息并退出

表 47.266. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 47.267. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 47.268. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 47.269. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

47.68. LoadBalancer 状态显示

以 json 格式显示负载均衡器状态树

使用方法:

openstack loadbalancer status show [-h] <load_balancer>

表 47.270. positional 参数
概述

<load_balancer>

负载均衡器的名称或 uuid。

表 47.271. 命令参数
概述

-h, --help

显示帮助信息并退出

47.69. LoadBalancer unset

清除负载均衡器设置

使用方法:

openstack loadbalancer unset [-h] [--name] [--description]
                                    [--vip-qos-policy-id]
                                    <load_balancer>

表 47.272. positional 参数
概述

<load_balancer>

要更新的负载均衡器的名称或 uuid。

表 47.273. 命令参数
概述

-h, --help

显示帮助信息并退出

--name

清除负载均衡器名称。

--description

清除负载均衡器描述。

--vip-qos-policy-id

清除负载均衡器 qos 策略。

第 48 章 映射

本章描述了 mapping 命令下的命令。

48.1. 映射创建

创建新映射

使用方法:

openstack mapping create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] --rules <filename>
                                <name>

表 48.1. positional 参数
概述

<name>

新映射名称(必须是唯一的)

表 48.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--rules <filename>

包含一组映射规则的文件名(必需)

表 48.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 48.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 48.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 48.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

48.2. 映射删除

删除映射

使用方法:

openstack mapping delete [-h] <mapping> [<mapping> ...]

表 48.7. positional 参数
概述

<mapping>

要删除的映射

表 48.8. 命令参数
概述

-h, --help

显示帮助信息并退出

48.3. 映射列表

列出映射

使用方法:

openstack mapping list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN]

表 48.9. 命令参数
概述

-h, --help

显示帮助信息并退出

表 48.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 48.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 48.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 48.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

48.4. 映射集

设置映射属性

使用方法:

openstack mapping set [-h] [--rules <filename>] <name>

表 48.14. positional 参数
概述

<name>

要修改的映射

表 48.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--rules <filename>

包含一组新映射规则的文件名

48.5. 映射显示

显示映射详情

使用方法:

openstack mapping show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <mapping>

表 48.16. positional 参数
概述

<mapping>

映射到显示

表 48.17. 命令参数
概述

-h, --help

显示帮助信息并退出

表 48.18. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 48.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 48.20. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 48.21. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 49 章 messaging

本章描述了 messaging 命令下的命令。

49.1. 消息传递声明创建

创建声明并返回声明的消息列表

使用方法:

openstack messaging claim create [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--ttl <ttl>] [--grace <grace>]
                                        [--limit <limit>]
                                        <queue_name>

表 49.1. positional 参数
概述

<queue_name>

要声明的队列的名称

表 49.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--ttl <ttl>

声明的时间(以秒为单位)

--grace <grace>

消息宽限期(以秒为单位)

--limit <limit>

声明一组消息,最多限制

表 49.3. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 49.4. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 49.5. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.2. 消息传递声明查询

显示声明详情

使用方法:

openstack messaging claim query [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       <queue_name> <claim_id>

表 49.7. positional 参数
概述

<queue_name>

声明队列的名称

<claim_id>

声明 ID

表 49.8. 命令参数
概述

-h, --help

显示帮助信息并退出

表 49.9. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 49.10. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 49.11. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.12. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.3. 消息传递声明发行版本

删除声明

使用方法:

openstack messaging claim release [-h] <queue_name> <claim_id>

表 49.13. positional 参数
概述

<queue_name>

声明队列的名称

<claim_id>

要删除的声明 ID

表 49.14. 命令参数
概述

-h, --help

显示帮助信息并退出

49.4. 消息传递声明续订

续订一个声明

使用方法:

openstack messaging claim renew [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--ttl <ttl>] [--grace <grace>]
                                       <queue_name> <claim_id>

表 49.15. positional 参数
概述

<queue_name>

声明队列的名称

<claim_id>

声明 ID

表 49.16. 命令参数
概述

-h, --help

显示帮助信息并退出

--ttl <ttl>

声明的时间(以秒为单位)

--grace <grace>

消息宽限期(以秒为单位)

表 49.17. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 49.18. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 49.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.20. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.5. 消息传递类别创建

创建池类别

使用方法:

openstack messaging flavor create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         [--pool_list <pool_list>]
                                         [--capabilities <capabilities>]
                                         <flavor_name>

表 49.21. positional 参数
概述

<flavor_name>

类别的名称

表 49.22. 命令参数
概述

-h, --help

显示帮助信息并退出

--pool_list <pool_list>

类别的池列表

--capabilities <capabilities>

描述特定于类别的功能,此选项仅在客户端 api 版本 < 2 中提供。

表 49.23. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 49.24. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.25. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 49.26. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.6. 消息传递类别删除

删除池类别

使用方法:

openstack messaging flavor delete [-h] <flavor_name>

表 49.27. positional 参数
概述

<flavor_name>

类别的名称

表 49.28. 命令参数
概述

-h, --help

显示帮助信息并退出

49.7. 消息传递类别列表

列出可用的池类型

使用方法:

openstack messaging flavor list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--marker <flavor_name>]
                                       [--limit <limit>] [--detailed]

表 49.29. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker <flavor_name>

类别的分页标记

--limit <limit>

页面大小限制

--detailed

如果显示类别的详细功能

表 49.30. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 49.31. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 49.32. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.33. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.8. 消息传递类别显示

显示池类别详情

使用方法:

openstack messaging flavor show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <flavor_name>

表 49.34. positional 参数
概述

<flavor_name>

要显示的类别(名称)

表 49.35. 命令参数
概述

-h, --help

显示帮助信息并退出

表 49.36. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 49.37. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.38. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 49.39. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.9. 消息传递类别更新

更新类别的属性

使用方法:

openstack messaging flavor update [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         [--pool_list <pool_list>]
                                         [--capabilities <capabilities>]
                                         <flavor_name>

表 49.40. positional 参数
概述

<flavor_name>

类别的名称

表 49.41. 命令参数
概述

-h, --help

显示帮助信息并退出

--pool_list <pool_list>

池列出类别位于

--capabilities <capabilities>

描述特定于类别的功能。

表 49.42. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 49.43. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.44. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 49.45. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.10. 消息传递健康状况

显示 Zaqar 服务器的详细健康状况

使用方法:

openstack messaging health [-h]

表 49.46. 命令参数
概述

-h, --help

显示帮助信息并退出

49.11. 消息传递主页

显示 Zaqar 服务器的详细资源文档

使用方法:

openstack messaging homedoc [-h]

表 49.47. 命令参数
概述

-h, --help

显示帮助信息并退出

49.12. 消息传递消息列表

列出给定队列的所有消息

使用方法:

openstack messaging message list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--message-ids <message_ids>]
                                        [--limit <limit>] [--echo]
                                        [--include-claimed]
                                        [--include-delayed]
                                        [--client-id <client_id>]
                                        <queue_name>

表 49.48. positional 参数
概述

<queue_name>

队列的名称

表 49.49. 命令参数
概述

-h, --help

显示帮助信息并退出

--message-ids <message_ids>

要检索的消息 ID 列表

--limit <limit>

要获得的最大消息数

--echo

是否获取此客户端自己的消息

--include-claimed

是否包含声明的消息

--include-delayed

是否包含延迟信息

--client-id <client_id>

每个客户端实例的 uuid。

表 49.50. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 49.51. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 49.52. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.53. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.13. 消息传递消息发布

给定队列的 post 消息

使用方法:

openstack messaging message post [-h] [--client-id <client_id>]
                                        <queue_name> <messages>

表 49.54. positional 参数
概述

<queue_name>

队列的名称

<messages>

要发布的消息。

表 49.55. 命令参数
概述

-h, --help

显示帮助信息并退出

--client-id <client_id>

每个客户端实例的 uuid。

49.14. 消息传递 ping

检查 Zaqar 服务器是否处于活动状态

使用方法:

openstack messaging ping [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]

表 49.56. 命令参数
概述

-h, --help

显示帮助信息并退出

表 49.57. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 49.58. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.59. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 49.60. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.15. 消息传递池创建

创建池

使用方法:

openstack messaging pool create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] [--flavor <flavor>]
                                       [--pool_options <pool_options>]
                                       <pool_name> <pool_uri> <pool_weight>

表 49.61. positional 参数
概述

<pool_name>

池的名称

<pool_uri>

存储引擎 uri

<pool_weight>

池的权重

表 49.62. 命令参数
概述

-h, --help

显示帮助信息并退出

--flavor <flavor>

池的类别

--pool_options <pool_options>

与存储特定选项相关的可选请求组件

表 49.63. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 49.64. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.65. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 49.66. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.16. 消息传递池删除

删除池

使用方法:

openstack messaging pool delete [-h] <pool_name>

表 49.67. positional 参数
概述

<pool_name>

池的名称

表 49.68. 命令参数
概述

-h, --help

显示帮助信息并退出

49.17. 消息传递池列表

列出可用的池

使用方法:

openstack messaging pool list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--marker <pool_name>] [--limit <limit>]
                                     [--detailed]

表 49.69. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker <pool_name>

池的分页标记

--limit <limit>

页面大小限制

--detailed

详细输出

表 49.70. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 49.71. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 49.72. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.73. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.18. 消息传递池显示

显示池详情

使用方法:

openstack messaging pool show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <pool_name>

表 49.74. positional 参数
概述

<pool_name>

要显示的池(名称)

表 49.75. 命令参数
概述

-h, --help

显示帮助信息并退出

表 49.76. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 49.77. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.78. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 49.79. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.19. 消息传递池更新

更新池属性

使用方法:

openstack messaging pool update [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] [--pool_uri <pool_uri>]
                                       [--pool_weight <pool_weight>]
                                       [--flavor <flavor>]
                                       [--pool_options <pool_options>]
                                       <pool_name>

表 49.80. positional 参数
概述

<pool_name>

池的名称

表 49.81. 命令参数
概述

-h, --help

显示帮助信息并退出

--pool_uri <pool_uri>

存储引擎 uri

--pool_weight <pool_weight>

池的权重

--flavor <flavor>

池的类别

--pool_options <pool_options>

与存储特定选项相关的可选请求组件

表 49.82. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 49.83. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.84. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 49.85. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.20. 消息传递队列创建

创建队列

使用方法:

openstack messaging queue create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <queue_name>

表 49.86. positional 参数
概述

<queue_name>

队列的名称

表 49.87. 命令参数
概述

-h, --help

显示帮助信息并退出

表 49.88. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 49.89. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.90. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 49.91. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.21. 消息传递队列删除

删除队列

使用方法:

openstack messaging queue delete [-h] <queue_name>

表 49.92. positional 参数
概述

<queue_name>

队列的名称

表 49.93. 命令参数
概述

-h, --help

显示帮助信息并退出

49.22. 消息传递队列获取元数据

获取队列元数据

使用方法:

openstack messaging queue get metadata [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              <queue_name>

表 49.94. positional 参数
概述

<queue_name>

队列的名称

表 49.95. 命令参数
概述

-h, --help

显示帮助信息并退出

表 49.96. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 49.97. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.98. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 49.99. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.23. 消息传递队列列表

列出可用的队列

使用方法:

openstack messaging queue list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--marker <queue_id>] [--limit <limit>]
                                      [--detailed]

表 49.100. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker <queue_id>

队列的分页标记

--limit <limit>

页面大小限制

--detailed

如果显示队列的详细信息

表 49.101. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 49.102. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 49.103. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.104. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.24. 消息传递队列清除

清除队列

使用方法:

openstack messaging queue purge [-h]
                                       [--resource_types <resource_types>]
                                       <queue_name>

表 49.105. positional 参数
概述

<queue_name>

队列的名称

表 49.106. 命令参数
概述

-h, --help

显示帮助信息并退出

--resource_types <resource_types>

需要清除资源类型。

49.25. 消息传递队列设置元数据

设置队列元数据

使用方法:

openstack messaging queue set metadata [-h]
                                              <queue_name> <queue_metadata>

表 49.107. positional 参数
概述

<queue_name>

队列的名称

<queue_metadata>

队列元数据,队列的所有元数据都会被 queue_metadata 替换

表 49.108. 命令参数
概述

-h, --help

显示帮助信息并退出

49.26. 消息传递队列签名的 url

创建预签名的 url

使用方法:

openstack messaging queue signed url [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--paths <paths>]
                                            [--ttl-seconds <ttl_seconds>]
                                            [--methods <methods>]
                                            <queue_name>

表 49.109. positional 参数
概述

<queue_name>

队列的名称

表 49.110. 命令参数
概述

-h, --help

显示帮助信息并退出

--paths <paths>

以逗号分隔的列表中允许的路径。选项: messages, subscription, claim

--ttl-seconds <ttl_seconds>

签名过期前的时间(以秒为单位)

--methods <methods>

允许作为以逗号分隔的列表的 HTTP 方法。选项:GET、HEAD、OPTIONS、POST、PUT、DELETE

表 49.111. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 49.112. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.113. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 49.114. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.27. 消息传递队列统计

获取队列统计

使用方法:

openstack messaging queue stats [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <queue_name>

表 49.115. positional 参数
概述

<queue_name>

队列的名称

表 49.116. 命令参数
概述

-h, --help

显示帮助信息并退出

表 49.117. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 49.118. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.119. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 49.120. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.28. 消息传递订阅创建

为队列创建订阅

使用方法:

openstack messaging subscription create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--options <options>]
                                               <queue_name> <subscriber> <ttl>

表 49.121. positional 参数
概述

<queue_name>

要订阅的队列的名称

<subscriber>

将通知的订阅者

<ttl>

订阅的时间(以秒为单位)

表 49.122. 命令参数
概述

-h, --help

显示帮助信息并退出

--options <options>

以 json 格式的订阅元数据

表 49.123. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 49.124. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.125. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 49.126. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.29. 消息传递订阅删除

创建一个订阅:

使用方法:

openstack messaging subscription delete [-h]
                                               <queue_name> <subscription_id>

表 49.127. positional 参数
概述

<queue_name>

订阅的队列名称

<subscription_id>

订阅的 ID

表 49.128. 命令参数
概述

-h, --help

显示帮助信息并退出

49.30. 消息传递订阅列表

列出可用的订阅

使用方法:

openstack messaging subscription list [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--noindent]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--sort-column SORT_COLUMN]
                                             [--marker <subscription_id>]
                                             [--limit <limit>]
                                             <queue_name>

表 49.129. positional 参数
概述

<queue_name>

要订阅的队列的名称

表 49.130. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker <subscription_id>

订阅的分页标记,上一页的最后订阅的 id

--limit <limit>

页面大小限制,默认值为 20

表 49.131. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 49.132. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 49.133. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.134. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.31. 消息传递订阅显示

显示订阅详情

使用方法:

openstack messaging subscription show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <queue_name> <subscription_id>

表 49.135. positional 参数
概述

<queue_name>

要订阅的队列的名称

<subscription_id>

订阅的 ID

表 49.136. 命令参数
概述

-h, --help

显示帮助信息并退出

表 49.137. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 49.138. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.139. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 49.140. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

49.32. 消息传递订阅更新

更新订阅

使用方法:

openstack messaging subscription update [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--subscriber <subscriber>]
                                               [--ttl <ttl>]
                                               [--options <options>]
                                               <queue_name> <subscription_id>

表 49.141. positional 参数
概述

<queue_name>

要订阅的队列的名称

<subscription_id>

订阅的 ID

表 49.142. 命令参数
概述

-h, --help

显示帮助信息并退出

--subscriber <subscriber>

将通知的订阅者

--ttl <ttl>

订阅的时间(以秒为单位)

--options <options>

以 json 格式的订阅元数据

表 49.143. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 49.144. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 49.145. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 49.146. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 50 章 metric

本章描述了 metric 命令下的命令。

50.1. 指标聚合

获取聚合指标的测量。

使用方法:

openstack metric aggregates [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--resource-type RESOURCE_TYPE]
                                   [--start START] [--stop STOP]
                                   [--granularity GRANULARITY]
                                   [--needed-overlap NEEDED_OVERLAP]
                                   [--groupby GROUPBY] [--fill FILL]
                                   operations [search]

表 50.1. positional 参数
概述

操作

要应用到时间序列的操作

search

过滤资源的查询。语法是属性、operator 和值的组合。例如: id=90d58eea-70d7-4294-a49a-170dcdf44c3c 会过滤具有特定 id 的资源。可以构建更复杂的查询,例如:not (flavor_id!="1" 和 memory>=24)。使用 "" 来强制将数据解释为字符串。支持的运算符有: not, and, eXecut, >=, HQ, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, in, 在.

表 50.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--resource-type RESOURCE_TYPE

要查询的资源类型

--start START

周期开始

--stop STOP

周期结束

--granularity GRANULARITY

检索的粒度

--needed-overlap NEEDED_OVERLAP

数据点间的重叠百分比

--groupBy GROUPBY

用于对资源进行分组的属性

--fill FILL

在回填时间戳时,使用值,在一系列子集中缺少值。值应该是浮点或 空值

表 50.3. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 50.4. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 50.5. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.2. 指标归档策略创建

创建归档策略。

使用方法:

openstack metric archive-policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty] -d
                                              <DEFINITION> [-b BACK_WINDOW]
                                              [-m AGGREGATION_METHODS]
                                              name

表 50.7. positional 参数
概述

name

归档策略的名称

表 50.8. 命令参数
概述

-h, --help

显示帮助信息并退出

-d <DEFINITION>, --definition <DEFINITION>

归档策略定义的两个属性(由 ,分隔),其名称和值用 分隔

-b BACK_WINDOW, --back-window BACK_WINDOW

归档策略的后端窗口

-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS

归档策略的聚合方法

表 50.9. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.10. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.11. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.12. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.3. 指标归档策略删除

删除归档策略。

使用方法:

openstack metric archive-policy delete [-h] name

表 50.13. positional 参数
概述

name

归档策略的名称

表 50.14. 命令参数
概述

-h, --help

显示帮助信息并退出

50.4. 指标归档策略列表

列出归档策略。

使用方法:

openstack metric archive-policy list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]

表 50.15. 命令参数
概述

-h, --help

显示帮助信息并退出

表 50.16. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 50.17. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 50.18. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.19. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.5. metric archive-policy-rule create

创建归档策略规则。

使用方法:

openstack metric archive-policy-rule create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty] -a
                                                   ARCHIVE_POLICY_NAME -m
                                                   METRIC_PATTERN
                                                   name

表 50.20. positional 参数
概述

name

运行名称

表 50.21. 命令参数
概述

-h, --help

显示帮助信息并退出

-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME

归档策略名称

-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN

要匹配的指标名称的通配符

表 50.22. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.23. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.24. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.25. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.6. metric archive-policy-rule delete

删除归档策略规则。

使用方法:

openstack metric archive-policy-rule delete [-h] name

表 50.26. positional 参数
概述

name

归档策略规则的名称

表 50.27. 命令参数
概述

-h, --help

显示帮助信息并退出

50.7. metric archive-policy-rule list

列出归档策略规则。

使用方法:

openstack metric archive-policy-rule list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]

表 50.28. 命令参数
概述

-h, --help

显示帮助信息并退出

表 50.29. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 50.30. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 50.31. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.32. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.8. metric archive-policy-rule show

显示归档策略规则。

使用方法:

openstack metric archive-policy-rule show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 name

表 50.33. positional 参数
概述

name

归档策略规则的名称

表 50.34. 命令参数
概述

-h, --help

显示帮助信息并退出

表 50.35. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.36. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.37. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.38. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.9. 指标归档策略显示

显示归档策略。

使用方法:

openstack metric archive-policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            name

表 50.39. positional 参数
概述

name

归档策略的名称

表 50.40. 命令参数
概述

-h, --help

显示帮助信息并退出

表 50.41. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.42. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.43. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.44. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.10. 指标归档策略更新

更新归档策略。

使用方法:

openstack metric archive-policy update [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty] -d
                                              <DEFINITION>
                                              name

表 50.45. positional 参数
概述

name

归档策略的名称

表 50.46. 命令参数
概述

-h, --help

显示帮助信息并退出

-d <DEFINITION>, --definition <DEFINITION>

归档策略定义的两个属性(由 ,分隔),其名称和值用 分隔

表 50.47. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.48. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.49. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.50. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.11. 指标基准测量添加

对添加测量进行基准测试测试。

使用方法:

openstack metric benchmark measures add [-h]
                                               [--resource-id RESOURCE_ID]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--workers WORKERS] --count
                                               COUNT [--batch BATCH]
                                               [--timestamp-start TIMESTAMP_START]
                                               [--timestamp-end TIMESTAMP_END]
                                               [--wait]
                                               metric

表 50.51. positional 参数
概述

metric

指标的 ID 或名称

表 50.52. 命令参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的 ID

--workers WORKERS, -w WORKERS

要使用的 worker 数量

--count COUNT, -n COUNT

要发送的总措施数

--batch BATCH, -b BATCH

每个批处理中发送的措施数

--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START

使用的第一个时间戳

--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END

使用的最后一个时间戳

--wait

等待所有措施被处理

表 50.53. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.54. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.55. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.56. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.12. 指标基准测量显示

对测量进行基准测试测试显示。

使用方法:

openstack metric benchmark measures show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                [--utc]
                                                [--resource-id RESOURCE_ID]
                                                [--aggregation AGGREGATION]
                                                [--start START] [--stop STOP]
                                                [--granularity GRANULARITY]
                                                [--refresh]
                                                [--resample RESAMPLE]
                                                [--workers WORKERS] --count
                                                COUNT
                                                metric

表 50.57. positional 参数
概述

metric

指标的 ID 或名称

表 50.58. 命令参数
概述

-h, --help

显示帮助信息并退出

--utc

将时间戳返回为 utc

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的 ID

--aggregation AGGREGATION

要检索的聚合

--start START

周期开始

--stop STOP

周期结束

--granularity GRANULARITY

检索的粒度

--refresh

强制聚合所有已知的措施

--resample RESAMPLE

将时间序列重新到的粒度(以秒为单位)

--workers WORKERS, -w WORKERS

要使用的 worker 数量

--count COUNT, -n COUNT

要发送的总措施数

表 50.59. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 50.60. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.61. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.62. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.13. 指标基准指标创建

对指标创建进行基准测试测试。

使用方法:

openstack metric benchmark metric create [-h]
                                                [--resource-id RESOURCE_ID]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--archive-policy-name ARCHIVE_POLICY_NAME]
                                                [--workers WORKERS] --count
                                                COUNT [--keep]

表 50.63. 命令参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的 ID

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

归档策略的名称

--workers WORKERS, -w WORKERS

要使用的 worker 数量

--count COUNT, -n COUNT

要创建的指标数

--keep, -k

保留创建的指标

表 50.64. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.65. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.66. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.67. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.14. 指标基准指标显示

对指标进行基准测试测试显示。

使用方法:

openstack metric benchmark metric show [-h] [--resource-id RESOURCE_ID]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--workers WORKERS] --count
                                              COUNT
                                              metric [metric ...]

表 50.68. positional 参数
概述

metric

指标的 ID 或名称

表 50.69. 命令参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的 ID

--workers WORKERS, -w WORKERS

要使用的 worker 数量

--count COUNT, -n COUNT

要获取的指标数

表 50.70. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.71. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.72. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.73. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.15. 指标功能列表

列出功能。

使用方法:

openstack metric capabilities list [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]

表 50.74. 命令参数
概述

-h, --help

显示帮助信息并退出

表 50.75. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.76. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.77. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.78. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.16. 指标创建

创建指标。

使用方法:

openstack metric create [-h] [--resource-id RESOURCE_ID]
                               [-f {json,shell,table,value,yaml}] [-c COLUMN]
                               [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               [--archive-policy-name ARCHIVE_POLICY_NAME]
                               [--unit UNIT]
                               [METRIC_NAME]

表 50.79. positional 参数
概述

METRIC_NAME

指标的名称

表 50.80. 命令参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的 ID

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

归档策略的名称

--unit UNIT, -u UNIT

指标的单元

表 50.81. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.82. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.83. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.84. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.17. 指标删除

删除指标。

使用方法:

openstack metric delete [-h] [--resource-id RESOURCE_ID]
                               metric [metric ...]

表 50.85. positional 参数
概述

metric

指标的 ID 或名称

表 50.86. 命令参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的 ID

50.18. 指标列表

列出指标。

使用方法:

openstack metric list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--limit <LIMIT>]
                             [--marker <MARKER>] [--sort <SORT>]

表 50.87. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit <LIMIT>

要返回的指标数(默认为服务器默认)

--marker <MARKER>

上一个列表的最后项。在这个值后返回下一个结果

--sort <SORT>

指标属性的排序(示例: user_id:desc- nullslast

表 50.88. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 50.89. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 50.90. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.91. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.19. 指标测量添加

向指标添加测量。

使用方法:

openstack metric measures add [-h] [--resource-id RESOURCE_ID] -m
                                     MEASURE
                                     metric

表 50.92. positional 参数
概述

metric

指标的 ID 或名称

表 50.93. 命令参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的 ID

-m MEASURE, --measure MEASURE

使用 @分隔的指标的时间戳和值

50.20. 指标测量聚合

获取聚合指标的测量。

使用方法:

openstack metric measures aggregation [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--noindent]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--sort-column SORT_COLUMN]
                                             [--utc] -m METRIC [METRIC ...]
                                             [--aggregation AGGREGATION]
                                             [--reaggregation REAGGREGATION]
                                             [--start START] [--stop STOP]
                                             [--granularity GRANULARITY]
                                             [--needed-overlap NEEDED_OVERLAP]
                                             [--query QUERY]
                                             [--resource-type RESOURCE_TYPE]
                                             [--groupby GROUPBY] [--refresh]
                                             [--resample RESAMPLE]
                                             [--fill FILL]

表 50.94. 命令参数
概述

-h, --help

显示帮助信息并退出

--utc

将时间戳返回为 utc

-m METRIC [METRIC …​], --metric METRIC [METRIC …​]

指标 ID 或指标名称

--aggregation AGGREGATION

检索的粒度聚合功能

--reaggregation REAGGREGATION

要检索的 groupBy 聚合功能

--start START

周期开始

--stop STOP

周期结束

--granularity GRANULARITY

检索的粒度

--needed-overlap NEEDED_OVERLAP

所需每个指标中数据点的百分比

--query QUERY

过滤资源的查询。语法是属性、operator 和值的组合。例如: id=90d58eea-70d7-4294-a49a-170dcdf44c3c 会过滤具有特定 id 的资源。可以构建更复杂的查询,例如:not (flavor_id!="1" 和 memory>=24)。使用 "" 来强制将数据解释为字符串。支持的运算符有: not, and, eXecut, >=, HQ, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, in, 在.

--resource-type RESOURCE_TYPE

要查询的资源类型

--groupBy GROUPBY

用于对资源进行分组的属性

--refresh

强制聚合所有已知的措施

--resample RESAMPLE

将时间序列重新到的粒度(以秒为单位)

--fill FILL

在回填时间戳时,使用值,在一系列子集中缺少值。值应该是浮点或 空值

表 50.95. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 50.96. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 50.97. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.98. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.21. 指标测量 batch-metrics

使用方法:

openstack metric measures batch-metrics [-h] file

表 50.99. positional 参数
概述

file

包含批处理或 - 用于 stdin 的文件(请参阅 Gnocchi REST API 文档)

表 50.100. 命令参数
概述

-h, --help

显示帮助信息并退出

50.22. 指标测量 batch-resources-metrics

使用方法:

openstack metric measures batch-resources-metrics [-h]
                                                         [--create-metrics]
                                                         file

表 50.101. positional 参数
概述

file

包含批处理或 - 用于 stdin 的文件(请参阅 Gnocchi REST API 文档)

表 50.102. 命令参数
概述

-h, --help

显示帮助信息并退出

--create-metrics

创建未知的指标

50.23. 指标测量显示

获取指标的测量。

使用方法:

openstack metric measures show [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN] [--utc]
                                      [--resource-id RESOURCE_ID]
                                      [--aggregation AGGREGATION]
                                      [--start START] [--stop STOP]
                                      [--granularity GRANULARITY] [--refresh]
                                      [--resample RESAMPLE]
                                      metric

表 50.103. positional 参数
概述

metric

指标的 ID 或名称

表 50.104. 命令参数
概述

-h, --help

显示帮助信息并退出

--utc

将时间戳返回为 utc

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的 ID

--aggregation AGGREGATION

要检索的聚合

--start START

周期开始

--stop STOP

周期结束

--granularity GRANULARITY

检索的粒度

--refresh

强制聚合所有已知的措施

--resample RESAMPLE

将时间序列重新到的粒度(以秒为单位)

表 50.105. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 50.106. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 50.107. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.108. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.24. 指标指标创建

弃用 :创建一个指标。

使用方法:

openstack metric metric create [-h] [--resource-id RESOURCE_ID]
                                      [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--archive-policy-name ARCHIVE_POLICY_NAME]
                                      [--unit UNIT]
                                      [METRIC_NAME]

表 50.109. positional 参数
概述

METRIC_NAME

指标的名称

表 50.110. 命令参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的 ID

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

归档策略的名称

--unit UNIT, -u UNIT

指标的单元

表 50.111. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.112. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.113. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.114. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.25. 指标指标删除

弃用:删除指标。

使用方法:

openstack metric metric delete [-h] [--resource-id RESOURCE_ID]
                                      metric [metric ...]

表 50.115. positional 参数
概述

metric

指标的 ID 或名称

表 50.116. 命令参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的 ID

50.26. 指标指标列表

弃用 :列出指标。

使用方法:

openstack metric metric list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--limit <LIMIT>] [--marker <MARKER>]
                                    [--sort <SORT>]

表 50.117. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit <LIMIT>

要返回的指标数(默认为服务器默认)

--marker <MARKER>

上一个列表的最后项。在这个值后返回下一个结果

--sort <SORT>

指标属性的排序(示例: user_id:desc- nullslast

表 50.118. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 50.119. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 50.120. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.121. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.27. 指标指标显示

弃用 :显示指标。

使用方法:

openstack metric metric show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    [--resource-id RESOURCE_ID]
                                    metric

表 50.122. positional 参数
概述

metric

指标的 ID 或名称

表 50.123. 命令参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的 ID

表 50.124. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.125. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.126. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.127. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.28. 指标资源批处理删除

根据属性值删除资源批处理。

使用方法:

openstack metric resource batch delete [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--type RESOURCE_TYPE]
                                              query

表 50.128. positional 参数
概述

query

过滤资源的查询。语法是属性、operator 和值的组合。例如: id=90d58eea-70d7-4294-a49a-170dcdf44c3c 会过滤具有特定 id 的资源。可以构建更复杂的查询,例如:not (flavor_id!="1" 和 memory>=24)。使用 "" 来强制将数据解释为字符串。支持的运算符有: not, and, eXecut, >=, HQ, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, in, 在.

表 50.129. 命令参数
概述

-h, --help

显示帮助信息并退出

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

表 50.130. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.131. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.132. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.133. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.29. 指标资源创建

创建资源。

使用方法:

openstack metric resource create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--type RESOURCE_TYPE]
                                        [-a ATTRIBUTE] [-m ADD_METRIC]
                                        [-n CREATE_METRIC]
                                        resource_id

表 50.134. positional 参数
概述

resource_id

资源的 ID

表 50.135. 命令参数
概述

-h, --help

显示帮助信息并退出

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

-a ATTRIBUTE, --attribute ATTRIBUTE

属性的名称和值,用 分隔

-M ADD_METRIC, --add-metric ADD_METRIC

要添加的指标的 name:id

-n CREATE_METRIC, --create-metric CREATE_METRIC

名称:要创建的指标的archive_policy_name

表 50.136. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.137. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.138. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.139. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.30. 指标资源删除

删除一个资源。

使用方法:

openstack metric resource delete [-h] resource_id

表 50.140. positional 参数
概述

resource_id

资源的 ID

表 50.141. 命令参数
概述

-h, --help

显示帮助信息并退出

50.31. 指标资源历史记录

显示资源的历史记录。

使用方法:

openstack metric resource history [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]
                                         [--details] [--limit <LIMIT>]
                                         [--marker <MARKER>] [--sort <SORT>]
                                         [--type RESOURCE_TYPE]
                                         resource_id

表 50.142. positional 参数
概述

resource_id

资源的 ID

表 50.143. 命令参数
概述

-h, --help

显示帮助信息并退出

--details

显示通用资源的所有属性

--limit <LIMIT>

要返回的资源数量(默认为服务器默认)

--marker <MARKER>

上一个列表的最后项。在这个值后返回下一个结果

--sort <SORT>

资源属性的排序(示例: user_id:desc- nullslast

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

表 50.144. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 50.145. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 50.146. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.147. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.32. 指标资源列表

列出资源。

使用方法:

openstack metric resource list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN] [--details]
                                      [--history] [--limit <LIMIT>]
                                      [--marker <MARKER>] [--sort <SORT>]
                                      [--type RESOURCE_TYPE]

表 50.148. 命令参数
概述

-h, --help

显示帮助信息并退出

--details

显示通用资源的所有属性

--history

显示资源的历史记录

--limit <LIMIT>

要返回的资源数量(默认为服务器默认)

--marker <MARKER>

上一个列表的最后项。在这个值后返回下一个结果

--sort <SORT>

资源属性的排序(示例: user_id:desc- nullslast

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

表 50.149. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 50.150. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 50.151. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.152. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.34. 指标资源显示

显示资源。

使用方法:

openstack metric resource show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--type RESOURCE_TYPE]
                                      resource_id

表 50.159. positional 参数
概述

resource_id

资源的 ID

表 50.160. 命令参数
概述

-h, --help

显示帮助信息并退出

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

表 50.161. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.162. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.163. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.164. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.35. metric resource-type create

创建资源类型。

使用方法:

openstack metric resource-type create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [-a ATTRIBUTE]
                                             name

表 50.165. positional 参数
概述

name

资源类型的名称

表 50.166. 命令参数
概述

-h, --help

显示帮助信息并退出

-a ATTRIBUTE, --attribute ATTRIBUTE

attribute definition, attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:…​ For example: display_name:string:true:max_length=255

表 50.167. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.168. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.169. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.170. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.36. 指标资源类型删除

删除资源类型。

使用方法:

openstack metric resource-type delete [-h] name

表 50.171. positional 参数
概述

name

资源类型的名称

表 50.172. 命令参数
概述

-h, --help

显示帮助信息并退出

50.37. 指标资源类型列表

列出资源类型。

使用方法:

openstack metric resource-type list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]

表 50.173. 命令参数
概述

-h, --help

显示帮助信息并退出

表 50.174. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 50.175. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 50.176. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.177. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.38. metric resource-type show

显示资源类型。

使用方法:

openstack metric resource-type show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           name

表 50.178. positional 参数
概述

name

资源类型的名称

表 50.179. 命令参数
概述

-h, --help

显示帮助信息并退出

表 50.180. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.181. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.182. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.183. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.39. 指标资源类型更新

创建资源类型。

使用方法:

openstack metric resource-type update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [-a ATTRIBUTE]
                                             [-r REMOVE_ATTRIBUTE]
                                             name

表 50.184. positional 参数
概述

name

资源类型的名称

表 50.185. 命令参数
概述

-h, --help

显示帮助信息并退出

-a ATTRIBUTE, --attribute ATTRIBUTE

attribute definition, attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:…​ For example: display_name:string:true:max_length=255

-r REMOVE_ATTRIBUTE, --remove-attribute REMOVE_ATTRIBUTE

属性名称

表 50.186. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.187. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.188. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.189. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.40. 指标资源更新

更新资源。

使用方法:

openstack metric resource update [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--type RESOURCE_TYPE]
                                        [-a ATTRIBUTE] [-m ADD_METRIC]
                                        [-n CREATE_METRIC] [-d DELETE_METRIC]
                                        resource_id

表 50.190. positional 参数
概述

resource_id

资源的 ID

表 50.191. 命令参数
概述

-h, --help

显示帮助信息并退出

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

-a ATTRIBUTE, --attribute ATTRIBUTE

属性的名称和值,用 分隔

-M ADD_METRIC, --add-metric ADD_METRIC

要添加的指标的 name:id

-n CREATE_METRIC, --create-metric CREATE_METRIC

名称:要创建的指标的archive_policy_name

-d DELETE_METRIC, --delete-metric DELETE_METRIC

要删除的指标名称

表 50.192. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.193. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.194. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.195. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.41. 指标服务器版本

显示 Gnocchi 服务器的版本。

使用方法:

openstack metric server version [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]

表 50.196. 命令参数
概述

-h, --help

显示帮助信息并退出

表 50.197. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.198. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.199. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.200. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.42. 指标显示

显示指标。

使用方法:

openstack metric show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--resource-id RESOURCE_ID]
                             metric

表 50.201. positional 参数
概述

metric

指标的 ID 或名称

表 50.202. 命令参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源的 ID

表 50.203. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.204. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.205. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.206. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

50.43. 指标状态

显示测量处理的状态。

使用方法:

openstack metric status [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]

表 50.207. 命令参数
概述

-h, --help

显示帮助信息并退出

表 50.208. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 50.209. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 50.210. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.211. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 51 章 module

本章描述了 module 命令下的命令。

51.1. 模块列表

列出模块版本

使用方法:

openstack module list [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--all]

表 51.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--all

显示具有版本信息的所有模块

表 51.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 51.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 51.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 51.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 52 章 network

本章描述了 network 命令下的命令。

52.1. 网络代理添加网络

在代理中添加网络

使用方法:

openstack network agent add network [-h] [--dhcp] <agent-id> <network>

表 52.1. positional 参数
概述

<agent-id>

添加网络的代理(仅限id)

<network>

要添加到代理的网络(名称或 id)

表 52.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--dhcp

将网络添加到 dhcp 代理

52.2. 网络代理添加路由器

将路由器添加到代理

使用方法:

openstack network agent add router [-h] [--l3] <agent-id> <router>

表 52.3. positional 参数
概述

<agent-id>

添加路由器的代理(仅限id)

<router>

要添加到代理的路由器(名称或 ID)

表 52.4. 命令参数
概述

-h, --help

显示帮助信息并退出

--l3

将路由器添加到 l3 代理

52.3. 网络代理删除

删除网络代理

使用方法:

openstack network agent delete [-h]
                                      <network-agent> [<network-agent> ...]

表 52.5. positional 参数
概述

<network-agent>

要删除的网络代理(仅限id)

表 52.6. 命令参数
概述

-h, --help

显示帮助信息并退出

52.4. 网络代理列表

列出网络代理

使用方法:

openstack network agent list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--agent-type <agent-type>]
                                    [--host <host>]
                                    [--network <network> | --router <router>]
                                    [--long]

表 52.7. 命令参数
概述

-h, --help

显示帮助信息并退出

--agent-type <agent-type>

仅列出具有指定代理类型的代理。支持的代理类型是: dhcp, open-vswitch, linux-bridge, ofa, l3, loadbalancer, metering, metadata, macvtap, nic。

--host <host>

仅列出在指定主机上运行的代理

--network <network>

列出托管网络的代理(名称或 id)

--router <router>

列出托管此路由器的代理(名称或 id)

--long

列出输出中的其他字段

表 52.8. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.9. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.10. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.11. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.5. 网络代理删除网络

从代理中删除网络。

使用方法:

openstack network agent remove network [-h] [--dhcp]
                                              <agent-id> <network>

表 52.12. positional 参数
概述

<agent-id>

删除网络的代理(仅限id)

<network>

要从代理中删除的网络(名称或 id)

表 52.13. 命令参数
概述

-h, --help

显示帮助信息并退出

--dhcp

从 dhcp 代理中删除网络

52.6. 网络代理移除路由器

从代理中删除路由器

使用方法:

openstack network agent remove router [-h] [--l3] <agent-id> <router>

表 52.14. positional 参数
概述

<agent-id>

将从中删除路由器的代理(仅限id)

<router>

要从代理中删除的路由器(名称或 id)

表 52.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--l3

从 l3 代理中删除路由器

52.7. 网络代理设置

设置网络代理属性

使用方法:

openstack network agent set [-h] [--description <description>]
                                   [--enable | --disable]
                                   <network-agent>

表 52.16. positional 参数
概述

<network-agent>

要修改的网络代理(仅id)

表 52.17. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

设置网络代理描述

--enable

启用网络代理

--disable

禁用网络代理

52.8. 网络代理显示

显示网络代理详情

使用方法:

openstack network agent show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <network-agent>

表 52.18. positional 参数
概述

<network-agent>

要显示的网络代理(仅id)

表 52.19. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.20. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.21. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.22. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.23. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.9. 网络自动分配拓扑创建

为项目创建自动分配拓扑

使用方法:

openstack network auto allocated topology create [-h]
                                                        [-f {json,shell,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--noindent]
                                                        [--prefix PREFIX]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]
                                                        [--check-resources]
                                                        [--or-show]

表 52.24. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

返回给定项目的自动分配拓扑。默认为当前项目

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--check-resources

验证自动分配拓扑的要求。不要返回拓扑。

--or-show

如果拓扑存在返回拓扑信息(默认)

表 52.25. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.26. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.27. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.28. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.10. 网络自动分配拓扑删除

删除项目的自动分配拓扑

使用方法:

openstack network auto allocated topology delete [-h]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]

表 52.29. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

删除给定项目的自动分配拓扑。默认为当前项目

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

52.11. 网络创建

创建新网络

使用方法:

openstack network create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--share | --no-share]
                                [--enable | --disable] [--project <project>]
                                [--description <description>] [--mtu <mtu>]
                                [--project-domain <project-domain>]
                                [--availability-zone-hint <availability-zone>]
                                [--enable-port-security | --disable-port-security]
                                [--external | --internal]
                                [--default | --no-default]
                                [--qos-policy <qos-policy>]
                                [--transparent-vlan | --no-transparent-vlan]
                                [--provider-network-type <provider-network-type>]
                                [--provider-physical-network <provider-physical-network>]
                                [--provider-segment <provider-segment>]
                                [--dns-domain <dns-domain>]
                                [--tag <tag> | --no-tag]
                                <name>

表 52.30. positional 参数
概述

<name>

新网络名称

表 52.31. 命令参数
概述

-h, --help

显示帮助信息并退出

--share

在项目间共享网络

--no-share

不要在项目间共享网络

--enable

启用网络(默认)

--disable

禁用网络

--project <project>

所有者的项目(名称或 id)

--description <description>

设置网络描述

--mtu <mtu>

设置网络 mtu

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--availability-zone-hint <availability-zone>

要创建此网络的可用区(需要网络可用区扩展,重复选项来设置多个可用区)

--enable-port-security

对于在此网络上创建的端口(默认)启用端口安全性

--disable-port-security

对于在此网络上创建的端口,默认禁用端口安全性

--external

将此网络设置为外部网络(需要外部网络扩展)

--internal

将此网络设置为内部网络(默认)

--default

指定是否应将此网络用作默认的外部网络

--no-default

不要使用网络作为默认外部网络(默认)

--qos-policy <qos-policy>

附加到此网络的 QoS 策略(名称或 id)

--transparent-vlan

使 network vlan 透明

--no-transparent-vlan

不要使 network vlan 透明

--provider-network-type <provider-network-type>

实施虚拟网络的物理机制。例如: flat, geneve, gre, local, vlan, vxlan。

--provider-physical-network <provider-physical-network>

实施虚拟网络的物理网络的名称

--provider-segment <provider-segment>

用于 GENEVE/GRE/VXLAN 网络的 vlan 网络或隧道 ID 的 VLAN ID

--dns-domain <dns-domain>

为此网络设置 dns 域(需要 dns 集成扩展)

--tag <tag>

要添加到网络的标签(重复选项来设置多个标签)

--no-tag

没有与网络关联的标签

表 52.32. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.33. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.34. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.35. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.12. 网络删除

删除网络

使用方法:

openstack network delete [-h] <network> [<network> ...]

表 52.36. positional 参数
概述

<network>

要删除的网络(名称或 id)

表 52.37. 命令参数
概述

-h, --help

显示帮助信息并退出

52.13. 网络类别添加配置集

将服务配置文件添加到网络类别

使用方法:

openstack network flavor add profile [-h] <flavor> <service-profile>

表 52.38. positional 参数
概述

<flavor>

网络类别(名称或 id)

<service-profile>

服务配置文件(仅限id)

表 52.39. 命令参数
概述

-h, --help

显示帮助信息并退出

52.14. 网络类别创建

创建新网络类别

使用方法:

openstack network flavor create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] --service-type
                                       <service-type>
                                       [--description DESCRIPTION]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       [--enable | --disable]
                                       <name>

表 52.40. positional 参数
概述

<name>

类别的名称

表 52.41. 命令参数
概述

-h, --help

显示帮助信息并退出

--service-type <service-type>

类别应用到的服务类型:例如: vpn (请参阅 openstack network service provider list 用于加载的示例)。

--description DESCRIPTION

类别的描述

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--enable

启用类别(默认)

--disable

禁用类别

表 52.42. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.43. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.44. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.45. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.15. 网络类别删除

删除网络类别

使用方法:

openstack network flavor delete [-h] <flavor> [<flavor> ...]

表 52.46. positional 参数
概述

<flavor>

要删除的类别(名称或 ID)

表 52.47. 命令参数
概述

-h, --help

显示帮助信息并退出

52.16. 网络类别列表

列出网络类别

使用方法:

openstack network flavor list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]

表 52.48. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.49. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.50. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.51. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.52. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.17. 网络类别配置集创建

创建新网络类别配置集

使用方法:

openstack network flavor profile create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--project <project>]
                                               [--project-domain <project-domain>]
                                               [--description <description>]
                                               [--enable | --disable]
                                               [--driver DRIVER]
                                               [--metainfo METAINFO]

表 52.53. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--description <description>

类别配置集的描述

--enable

启用 flavor 配置集

--disable

禁用 flavor 配置集

--driver DRIVER

Python 模块路径到驱动程序。如果缺少 --metainfo,则需要此路径,反之亦然

--metainfo METAINFO

类别配置文件的 metainfo。如果缺少 --driver,则需要此项,反之亦然

表 52.54. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.55. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.56. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.57. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.18. 网络类别配置集删除

删除网络类别配置集

使用方法:

openstack network flavor profile delete [-h]
                                               <flavor-profile>
                                               [<flavor-profile> ...]

表 52.58. positional 参数
概述

<flavor-profile>

要删除的类别配置文件(仅限id)

表 52.59. 命令参数
概述

-h, --help

显示帮助信息并退出

52.19. 网络类别配置集列表

列出网络类别配置集

使用方法:

openstack network flavor profile list [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--noindent]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--sort-column SORT_COLUMN]

表 52.60. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.61. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.62. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.63. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.64. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.20. 网络类别配置集集

设置网络类别配置集属性

使用方法:

openstack network flavor profile set [-h]
                                            [--project-domain <project-domain>]
                                            [--description <description>]
                                            [--enable | --disable]
                                            [--driver DRIVER]
                                            [--metainfo METAINFO]
                                            <flavor-profile>

表 52.65. positional 参数
概述

<flavor-profile>

要更新的 flavor 配置集(仅id)

表 52.66. 命令参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--description <description>

类别配置集的描述

--enable

启用 flavor 配置集

--disable

禁用 flavor 配置集

--driver DRIVER

Python 模块路径到驱动程序。如果缺少 --metainfo,则需要此路径,反之亦然

--metainfo METAINFO

类别配置文件的 metainfo。如果缺少 --driver,则需要此项,反之亦然

52.21. 网络类别配置集显示

显示网络类别配置集详情

使用方法:

openstack network flavor profile show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <flavor-profile>

表 52.67. positional 参数
概述

<flavor-profile>

要显示的类别配置文件(仅id)

表 52.68. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.69. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.70. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.71. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.72. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.22. 网络类别删除配置集

从网络类型中删除服务配置文件

使用方法:

openstack network flavor remove profile [-h] <flavor> <service-profile>

表 52.73. positional 参数
概述

<flavor>

网络类别(名称或 id)

<service-profile>

服务配置文件(仅限id)

表 52.74. 命令参数
概述

-h, --help

显示帮助信息并退出

52.23. 网络类别集

设置网络类别属性

使用方法:

openstack network flavor set [-h] [--description DESCRIPTION]
                                    [--disable | --enable] [--name <name>]
                                    <flavor>

表 52.75. positional 参数
概述

<flavor>

要更新的类别(名称或 id)

表 52.76. 命令参数
概述

-h, --help

显示帮助信息并退出

--description DESCRIPTION

设置网络类别描述

--disable

禁用网络类型

--enable

启用网络类型

--name <name>

设置类别名称

52.24. 网络类别显示

显示网络类别详情

使用方法:

openstack network flavor show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <flavor>

表 52.77. positional 参数
概述

<flavor>

要显示的类别(名称或 id)

表 52.78. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.79. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.80. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.81. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.82. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.25. 网络列表

列出网络

使用方法:

openstack network list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN]
                              [--external | --internal] [--long]
                              [--name <name>] [--enable | --disable]
                              [--project <project>]
                              [--project-domain <project-domain>]
                              [--share | --no-share] [--status <status>]
                              [--provider-network-type <provider-network-type>]
                              [--provider-physical-network <provider-physical-network>]
                              [--provider-segment <provider-segment>]
                              [--agent <agent-id>] [--tags <tag>[,<tag>,...]]
                              [--any-tags <tag>[,<tag>,...]]
                              [--not-tags <tag>[,<tag>,...]]
                              [--not-any-tags <tag>[,<tag>,...]]

表 52.83. 命令参数
概述

-h, --help

显示帮助信息并退出

--external

列出外部网络

--internal

列出内部网络

--long

列出输出中的其他字段

--name <name>

根据网络的名称列出网络

--enable

列出启用的网络

--disable

列出禁用的网络

--project <project>

根据项目(名称或 ID)列出网络

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--share

列出项目间共享的网络

--no-share

列出没有在项目间共享的网络

--status <status>

根据其状态列出网络(活跃,BUILD,DOWN,ERROR)

--provider-network-type <provider-network-type>

根据其物理机制列出网络。支持的选项有: flat, geneve, gre, local, vlan, vxlan。

--provider-physical-network <provider-physical-network>

根据物理网络的名称列出网络

--provider-segment <provider-segment>

根据 vlan 网络的 vlan id 或 GENEVE/GRE/VXLAN 网络的 Tunnel ID 列出网络

--agent <agent-id>

列出由代理托管的网络(仅限id)

--tags <tag>[,<tag>,…​]

列出具有所有给定标签的网络(以逗号分隔的标签列表)

--any-tags <tag>[,<tag>,…​]

列出具有任何给定标签的网络(以逗号分隔的标签列表)

--not-tags <tag>[,<tag>,…​]

排除具有所有给定标签的网络(以逗号分隔的标签列表)

--not-any-tags <tag>[,<tag>,…​]

排除具有任何给定标签的网络(以逗号分隔的标签列表)

表 52.84. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.85. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.86. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.87. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.26. 网络日志创建

创建新网络日志

使用方法:

openstack network log create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    [--description <description>]
                                    [--enable | --disable]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--event {ALL,ACCEPT,DROP}]
                                    --resource-type <resource-type>
                                    [--resource <resource>]
                                    [--target <target>]
                                    <name>

表 52.88. positional 参数
概述

<name>

网络日志的名称

表 52.89. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

网络日志的描述

--enable

启用此日志(默认为禁用)

--disable

禁用此日志

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--event {ALL,ACCEPT,DROP}

使用日志存储的事件

--resource-type <resource-type>

网络日志类型。您可以使用以下命令查看支持的类型:$ openstack network loggable resources list

--resource <resource>

用于日志记录的资源(安全组或防火墙组)的名称或 ID。您可以使用 --target 选项控制日志记录目标组合。

--target <target>

用于日志记录的端口(名称或 id)。您可以控制使用 --resource 选项记录目标组合。

表 52.90. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.91. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.92. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.93. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.27. 网络日志删除

删除网络日志

使用方法:

openstack network log delete [-h] <network-log> [<network-log> ...]

表 52.94. positional 参数
概述

<network-log>

要删除的网络日志(名称或 id)

表 52.95. 命令参数
概述

-h, --help

显示帮助信息并退出

52.28. 网络日志列表

列出网络日志

使用方法:

openstack network log list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN] [--long]

表 52.96. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 52.97. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.98. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.99. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.100. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.29. 网络日志集

设置网络日志属性

使用方法:

openstack network log set [-h] [--description <description>]
                                 [--enable | --disable] [--name <name>]
                                 <network-log>

表 52.101. positional 参数
概述

<network-log>

要设置的网络日志(名称或 id)

表 52.102. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

网络日志的描述

--enable

启用此日志(默认为禁用)

--disable

禁用此日志

--name <name>

网络日志的名称

52.30. 网络日志显示

显示网络日志详情

使用方法:

openstack network log show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <network-log>

表 52.103. positional 参数
概述

<network-log>

要显示的网络日志(名称或 id)

表 52.104. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.105. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.106. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.107. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.108. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.31. 网络可日志资源列表

列出支持的可日志资源

使用方法:

openstack network loggable resources list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]
                                                 [--long]

表 52.109. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 52.110. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.111. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.112. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.113. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.32. 网络分段创建

创建网络分段

使用方法:

openstack network meter create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--description <description>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--share | --no-share]
                                      <name>

表 52.114. positional 参数
概述

<name>

游戏的名称

表 52.115. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

创建游戏的描述

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--share

项目间共享分段

--no-share

不要在项目间共享诊断

表 52.116. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.117. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.118. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.119. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.33. 网络分段删除

删除网络分析器

使用方法:

openstack network meter delete [-h] <meter> [<meter> ...]

表 52.120. positional 参数
概述

<meter>

要删除的温度(名称或 id)

表 52.121. 命令参数
概述

-h, --help

显示帮助信息并退出

52.34. 网络分段列表

列出网络分段

使用方法:

openstack network meter list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]

表 52.122. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.123. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.124. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.125. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.126. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.35. 网络分段规则创建

创建新的音频规则

使用方法:

openstack network meter rule create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--project <project>]
                                           [--project-domain <project-domain>]
                                           [--exclude | --include]
                                           [--ingress | --egress]
                                           --remote-ip-prefix
                                           <remote-ip-prefix>
                                           <meter>

表 52.127. positional 参数
概述

<meter>

与此 metering 规则关联的标签(名称或 ID)

表 52.128. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--exclude

从流量计数中排除远程 ip 前缀

--include

包括来自流量数的远程 ip 前缀(默认)

--ingress

将规则应用到传入的网络流量(默认)

--egress

将规则应用到传出流量

--remote-ip-prefix <remote-ip-prefix>

与这个规则关联的远程 ip 前缀

表 52.129. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.130. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.131. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.132. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.36. 网络分析规则删除

删除分段规则

使用方法:

openstack network meter rule delete [-h]
                                           <meter-rule-id>
                                           [<meter-rule-id> ...]

表 52.133. positional 参数
概述

<meter-rule-id>

要删除的温度规则(仅id)

表 52.134. 命令参数
概述

-h, --help

显示帮助信息并退出

52.37. 网络粒度规则列表

列出地理规则

使用方法:

openstack network meter rule list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]

表 52.135. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.136. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.137. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.138. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.139. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.38. 网络分段规则显示

显示粒度规则详情

使用方法:

openstack network meter rule show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <meter-rule-id>

表 52.140. positional 参数
概述

<meter-rule-id>

分段规则(仅id)

表 52.141. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.142. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.143. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.144. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.145. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.39. 网络分段演示

显示网络分析器

使用方法:

openstack network meter show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <meter>

表 52.146. positional 参数
概述

<meter>

要显示的温度(名称或 id)

表 52.147. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.148. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.149. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.150. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.151. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.40. 网络板载子网

将网络子网添加到子网池中

使用方法:

openstack network onboard subnets [-h] <network> <subnetpool>

表 52.152. positional 参数
概述

<network>

载入与此网络关联的所有子网

<subnetpool>

用于加入子网的目标子网池

表 52.153. 命令参数
概述

-h, --help

显示帮助信息并退出

52.41. 网络 qos 策略创建

创建 QoS 策略

使用方法:

openstack network qos policy create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--description <description>]
                                           [--share | --no-share]
                                           [--project <project>]
                                           [--project-domain <project-domain>]
                                           [--default | --no-default]
                                           <name>

表 52.154. positional 参数
概述

<name>

要创建的 qos 策略的名称

表 52.155. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

qos 策略的描述

--share

使 qos 策略可供其他项目访问

--no-share

使 qos 策略不能被其他项目访问(默认)

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--default

把它设置为默认网络 qos 策略

--no-default

把它设置为非默认网络 qos 策略

表 52.156. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.157. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.158. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.159. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.42. 网络 qos 策略删除

删除 Qos 策略

使用方法:

openstack network qos policy delete [-h]
                                           <qos-policy> [<qos-policy> ...]

表 52.160. positional 参数
概述

<qos-policy>

要删除的 QoS 策略(名称或 id)

表 52.161. 命令参数
概述

-h, --help

显示帮助信息并退出

52.43. 网络 qos 策略列表

列出 QoS 策略

使用方法:

openstack network qos policy list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]
                                         [--project <project>]
                                         [--project-domain <project-domain>]
                                         [--share | --no-share]

表 52.162. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

根据项目(名称或 ID)列出 qos 策略

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--share

列出项目之间共享的 qos 策略

--no-share

列出没有在项目之间共享的 qos 策略

表 52.163. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.164. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.165. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.166. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.44. 网络 qos 策略集

设置 QoS 策略属性

使用方法:

openstack network qos policy set [-h] [--name <name>]
                                        [--description <description>]
                                        [--share | --no-share]
                                        [--default | --no-default]
                                        <qos-policy>

表 52.167. positional 参数
概述

<qos-policy>

要修改的 QoS 策略(名称或 id)

表 52.168. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置 qos 策略名称

--description <description>

qos 策略的描述

--share

使 qos 策略可供其他项目访问

--no-share

使 qos 策略不能被其他项目访问

--default

把它设置为默认网络 qos 策略

--no-default

把它设置为非默认网络 qos 策略

52.45. 网络 qos 策略显示

显示 QoS 策略详情

使用方法:

openstack network qos policy show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <qos-policy>

表 52.169. positional 参数
概述

<qos-policy>

要显示的 QoS 策略(名称或 id)

表 52.170. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.171. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.172. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.173. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.174. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.46. 网络 qos 规则创建

创建新的网络 QoS 规则

使用方法:

openstack network qos rule create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty] --type <type>
                                         [--max-kbps <max-kbps>]
                                         [--max-burst-kbits <max-burst-kbits>]
                                         [--dscp-mark <dscp-mark>]
                                         [--min-kbps <min-kbps>]
                                         [--ingress | --egress]
                                         <qos-policy>

表 52.175. positional 参数
概述

<qos-policy>

包含规则的 QoS 策略(名称或 id)

表 52.176. 命令参数
概述

-h, --help

显示帮助信息并退出

--type <type>

QoS 规则类型(minimum-bandwidth, dscp-marking, bandwidth-limit)

--max-kbps <max-kbps>

最大带宽(以 kbps 为单位)

--max-burst-kbits <max-burst-kbits>

最大突发(以 KB 为单位)表示自动指定,即带宽限制的 80%,它们适用于典型的 TCP 流量。检查 QoS 用户工作流的详情。

--dscp-mark <dscp-mark>

过程标记:值可以是 0,即使从 8 到56,不包括 42、44、50、52 和 54

--min-kbps <min-kbps>

最低保证带宽(以 kbps 为单位)

--ingress

来自项目视角的入口流量方向

--egress

来自项目视图的出口流量方向

表 52.177. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.178. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.179. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.180. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.47. 网络 qos 规则删除

删除网络 QoS 规则

使用方法:

openstack network qos rule delete [-h] <qos-policy> <rule-id>

表 52.181. positional 参数
概述

<qos-policy>

包含规则的 QoS 策略(名称或 id)

<rule-id>

要删除的网络 qos 规则(id)

表 52.182. 命令参数
概述

-h, --help

显示帮助信息并退出

52.48. 网络 qos 规则列表

列出网络 QoS 规则

使用方法:

openstack network qos rule list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       <qos-policy>

表 52.183. positional 参数
概述

<qos-policy>

包含规则的 QoS 策略(名称或 id)

表 52.184. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.185. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.186. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.187. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.188. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.49. 网络 qos 规则集

设置网络 QoS 规则属性

使用方法:

openstack network qos rule set [-h] [--max-kbps <max-kbps>]
                                      [--max-burst-kbits <max-burst-kbits>]
                                      [--dscp-mark <dscp-mark>]
                                      [--min-kbps <min-kbps>]
                                      [--ingress | --egress]
                                      <qos-policy> <rule-id>

表 52.189. positional 参数
概述

<qos-policy>

包含规则的 QoS 策略(名称或 id)

<rule-id>

要删除的网络 qos 规则(id)

表 52.190. 命令参数
概述

-h, --help

显示帮助信息并退出

--max-kbps <max-kbps>

最大带宽(以 kbps 为单位)

--max-burst-kbits <max-burst-kbits>

最大突发(以 KB 为单位)表示自动指定,即带宽限制的 80%,它们适用于典型的 TCP 流量。检查 QoS 用户工作流的详情。

--dscp-mark <dscp-mark>

过程标记:值可以是 0,即使从 8 到56,不包括 42、44、50、52 和 54

--min-kbps <min-kbps>

最低保证带宽(以 kbps 为单位)

--ingress

来自项目视角的入口流量方向

--egress

来自项目视图的出口流量方向

52.50. 网络 qos 规则显示

显示网络 QoS 规则详情

使用方法:

openstack network qos rule show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <qos-policy> <rule-id>

表 52.191. positional 参数
概述

<qos-policy>

包含规则的 QoS 策略(名称或 id)

<rule-id>

要删除的网络 qos 规则(id)

表 52.192. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.193. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.194. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.195. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.196. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.51. 网络 qos 规则类型列表

列出 QoS 规则类型

使用方法:

openstack network qos rule type list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]

表 52.197. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.198. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.199. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.200. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.201. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.52. 网络 qos 规则类型 show

显示支持的 QoS 规则类型的详情

使用方法:

openstack network qos rule type show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <qos-rule-type-name>

表 52.202. positional 参数
概述

<qos-rule-type-name>

qos 规则类型的名称

表 52.203. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.204. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.205. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.206. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.207. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.53. Network rbac create

创建网络 RBAC 策略

使用方法:

openstack network rbac create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty] --type
                                     <type> --action <action>
                                     (--target-project <target-project> | --target-all-projects)
                                     [--target-project-domain <target-project-domain>]
                                     [--project <project>]
                                     [--project-domain <project-domain>]
                                     <rbac-object>

表 52.208. positional 参数
概述

<RBAC-object>

此 rbac 策略影响的对象(名称或 ID)

表 52.209. 命令参数
概述

-h, --help

显示帮助信息并退出

--type <type>

rbac 策略影响的对象类型("security_group", "qos_policy" 或 "network")

--action <action>

rbac 策略的操作("access_as_external" 或 "access_as_shared")

--target-project <target-project>

将强制执行 rbac 策略的项目(名称或 ID)

--target-all-projects

允许为所有项目创建 rbac 策略。

--target-project-domain <target-project-domain>

目标项目所属的域(名称或 id)。当项目名称之间存在冲突时,可以使用此选项。

--project <project>

所有者项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

表 52.210. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.211. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.212. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.213. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.54. Network rbac delete

删除网络 RBAC 策略

使用方法:

openstack network rbac delete [-h] <rbac-policy> [<rbac-policy> ...]

表 52.214. positional 参数
概述

<RBAC-policy>

要删除的 RBAC 策略(仅限id)

表 52.215. 命令参数
概述

-h, --help

显示帮助信息并退出

52.55. 网络 rbac 列表

列出网络 RBAC 策略

使用方法:

openstack network rbac list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN] [--type <type>]
                                   [--action <action>] [--long]

表 52.216. 命令参数
概述

-h, --help

显示帮助信息并退出

--type <type>

根据给定的对象类型("security_group", "qos_policy" 或 "network")列出网络 rbac 策略

--action <action>

根据给定的操作("access_as_external" 或 "access_as_shared")列出网络 rbac 策略

--long

列出输出中的其他字段

表 52.217. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.218. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.219. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.220. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.56. 网络 rbac 集

设置网络 RBAC 策略属性

使用方法:

openstack network rbac set [-h] [--target-project <target-project>]
                                  [--target-project-domain <target-project-domain>]
                                  <rbac-policy>

表 52.221. positional 参数
概述

<RBAC-policy>

要修改的 RBAC 策略(仅限id)

表 52.222. 命令参数
概述

-h, --help

显示帮助信息并退出

--target-project <target-project>

将强制执行 rbac 策略的项目(名称或 ID)

--target-project-domain <target-project-domain>

目标项目所属的域(名称或 id)。当项目名称之间存在冲突时,可以使用此选项。

52.57. Network rbac show

显示网络 RBAC 策略详情

使用方法:

openstack network rbac show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <rbac-policy>

表 52.223. positional 参数
概述

<RBAC-policy>

RBAC 策略(仅限id)

表 52.224. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.225. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.226. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.227. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.228. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.58. 网络片段创建

创建新网络片段

使用方法:

openstack network segment create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--description <description>]
                                        [--physical-network <physical-network>]
                                        [--segment <segment>] --network
                                        <network> --network-type
                                        <network-type>
                                        <name>

表 52.229. positional 参数
概述

<name>

新网络片段名称

表 52.230. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

网络片段描述

--physical-network <physical-network>

这个网络片段的物理网络名称

--segment <segment>

此网络片段的片段标识符基于网络类型、vlan 网络类型的 VLAN ID 和 geneve、gre 和 vxlan 网络类型的隧道 ID

--network <network>

此网络段所属的网络片段(名称或 id)

--network-type <network-type>

此网络片段的网络类型(flat、geneve、gre、local、vlan 或 vxlan)

表 52.231. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.232. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.233. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.234. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.59. 网络片段删除

删除网络段

使用方法:

openstack network segment delete [-h]
                                        <network-segment>
                                        [<network-segment> ...]

表 52.235. positional 参数
概述

<network-segment>

要删除的网络片段(名称或 id)

表 52.236. 命令参数
概述

-h, --help

显示帮助信息并退出

52.60. 网络片段列表

列出网络片段

使用方法:

openstack network segment list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN] [--long]
                                      [--network <network>]

表 52.237. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

--network <network>

列出属于此网络的网络片段(名称或 ID)

表 52.238. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.239. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.240. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.241. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.61. 网络片段范围创建

创建新网络片段范围

使用方法:

openstack network segment range create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--private | --shared]
                                              [--project <project>]
                                              [--project-domain <project-domain>]
                                              --network-type <network-type>
                                              [--physical-network <physical-network-name>]
                                              --minimum
                                              <minimum-segmentation-id>
                                              --maximum
                                              <maximum-segmentation-id>
                                              <name>

表 52.242. positional 参数
概述

<name>

新网络段范围的名称

表 52.243. 命令参数
概述

-h, --help

显示帮助信息并退出

--private

网络段范围被专门分配给项目

--shared

网络段范围与其他项目共享

--project <project>

网络段范围所有者(名称或 id)。当片段范围共享时是可选的

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--network-type <network-type>

此网络片段范围的网络类型(geneve, gre, vlan 或 vxlan)

--physical-network <physical-network-name>

此网络片段范围的物理网络名称

--minimum <minimum-segmentation-id>

此网络片段范围的最低片段标识符基于网络类型,vlan 网络类型的 VLAN ID,以及 geneve、gre 和 vxlan 网络类型的隧道 ID

--maximum <maximum-segmentation-id>

此网络片段范围的最大片段标识符基于网络类型,vlan 网络类型的 VLAN ID,以及 geneve、gre 和 vxlan 网络类型的隧道 ID

表 52.244. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.245. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.246. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.247. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.62. 网络片段范围删除

删除网络段范围

使用方法:

openstack network segment range delete [-h]
                                              <network-segment-range>
                                              [<network-segment-range> ...]

表 52.248. positional 参数
概述

<network-segment-range>

要删除的网络片段范围(名称或 id)

表 52.249. 命令参数
概述

-h, --help

显示帮助信息并退出

52.63. 网络片段范围列表

列出网络片段范围

使用方法:

openstack network segment range list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]
                                            [--long] [--used | --unused]
                                            [--available | --unavailable]

表 52.250. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

--used

列出使用片段的网络片段范围

--unused

列出没有使用片段的网络片段范围

--available

列出有可用片段的网络片段范围

--unavailable

列出没有可用片段的网络片段范围

表 52.251. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.252. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.253. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.254. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.64. 网络片段范围集

设置网络段范围属性

使用方法:

openstack network segment range set [-h] [--name <name>]
                                           [--minimum <minimum-segmentation-id>]
                                           [--maximum <maximum-segmentation-id>]
                                           <network-segment-range>

表 52.255. positional 参数
概述

<network-segment-range>

要修改的网络片段范围(名称或 id)

表 52.256. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置网络片段名称

--minimum <minimum-segmentation-id>

设置网络片段范围最小片段标识符

--maximum <maximum-segmentation-id>

设置网络片段范围最大片段标识符

52.65. 网络片段范围显示

显示网络片段范围详情

使用方法:

openstack network segment range show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <network-segment-range>

表 52.257. positional 参数
概述

<network-segment-range>

要显示的网络片段范围(名称或 id)

表 52.258. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.259. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.260. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.261. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.262. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.66. 网络片段集

设置网络片段属性

使用方法:

openstack network segment set [-h] [--description <description>]
                                     [--name <name>]
                                     <network-segment>

表 52.263. positional 参数
概述

<network-segment>

要修改的网络片段(名称或 id)

表 52.264. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

设置网络片段描述

--name <name>

设置网络片段名称

52.67. 网络片段显示

显示网络片段详情

使用方法:

openstack network segment show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <network-segment>

表 52.265. positional 参数
概述

<network-segment>

要显示的网络片段(名称或 id)

表 52.266. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.267. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.268. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.269. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.270. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.68. 网络服务提供商列表

列出服务提供商

使用方法:

openstack network service provider list [-h]
                                               [-f {csv,json,table,value,yaml}]
                                               [-c COLUMN]
                                               [--quote {all,minimal,none,nonnumeric}]
                                               [--noindent]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--sort-column SORT_COLUMN]

表 52.271. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.272. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.273. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.274. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.275. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.69. 网络集

设置网络属性

使用方法:

openstack network set [-h] [--name <name>] [--enable | --disable]
                             [--share | --no-share]
                             [--description <description] [--mtu <mtu]
                             [--enable-port-security | --disable-port-security]
                             [--external | --internal]
                             [--default | --no-default]
                             [--qos-policy <qos-policy> | --no-qos-policy]
                             [--tag <tag>] [--no-tag]
                             [--provider-network-type <provider-network-type>]
                             [--provider-physical-network <provider-physical-network>]
                             [--provider-segment <provider-segment>]
                             [--dns-domain <dns-domain>]
                             <network>

表 52.276. positional 参数
概述

<network>

要修改的网络(名称或 id)

表 52.277. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置网络名称

--enable

启用网络

--disable

禁用网络

--share

在项目间共享网络

--no-share

不要在项目间共享网络

--description <description

设置网络描述

--mtu <mtu

设置网络 mtu

--enable-port-security

为在此网络上创建的端口默认启用端口安全性

--disable-port-security

对于在此网络上创建的端口,默认禁用端口安全性

--external

将此网络设置为外部网络(需要外部网络扩展)

--internal

将此网络设置为内部网络

--default

将网络设置为默认的外部网络

--no-default

不要将网络用作默认的外部网络

--qos-policy <qos-policy>

附加到此网络的 QoS 策略(名称或 id)

--no-qos-policy

删除附加到此网络的 qos 策略

--tag <tag>

要添加到网络的标签(重复选项来设置多个标签)

--no-tag

清除与网络关联的标签。指定 --tag 和 --no-tag 来覆盖当前标签

--provider-network-type <provider-network-type>

实施虚拟网络的物理机制。例如: flat, geneve, gre, local, vlan, vxlan。

--provider-physical-network <provider-physical-network>

实施虚拟网络的物理网络的名称

--provider-segment <provider-segment>

用于 GENEVE/GRE/VXLAN 网络的 vlan 网络或隧道 ID 的 VLAN ID

--dns-domain <dns-domain>

为此网络设置 dns 域(需要 dns 集成扩展)

52.70. 网络显示

显示网络详情

使用方法:

openstack network show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <network>

表 52.278. positional 参数
概述

<network>

要显示的网络(名称或 id)

表 52.279. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.280. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.281. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.282. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.283. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.71. 网络子端口列表

列出给定网络中继的所有子端口

使用方法:

openstack network subport list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN] --trunk
                                      <trunk>

表 52.284. 命令参数
概述

-h, --help

显示帮助信息并退出

--trunk <trunk>

列出属于此中继(名称或 id)的子端口

表 52.285. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.286. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.287. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.288. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.72. 网络中继创建

为给定项目创建网络中继

使用方法:

openstack network trunk create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--description <description>]
                                      --parent-port <parent-port>
                                      [--subport <port=,segmentation-type=,segmentation-id=>]
                                      [--enable | --disable]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      <name>

表 52.289. positional 参数
概述

<name>

要创建的中继名称

表 52.290. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

中继的描述

--parent-port <parent-port>

属于此中继的父端口(名称或 id)

--subport <port=,segmentation-type=,segmentation-id⇒

要添加的 Subport。子端口格式为 port=<name 或 ID>,segmentation-type=,segmentation-ID= (--subport)选项

--enable

启用中继(默认)

--disable

禁用中继

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

表 52.291. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.292. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.293. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.294. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.73. 网络中继删除

删除给定网络中继

使用方法:

openstack network trunk delete [-h] <trunk> [<trunk> ...]

表 52.295. positional 参数
概述

<trunk>

要删除的中继(名称或 id)

表 52.296. 命令参数
概述

-h, --help

显示帮助信息并退出

52.74. 网络中继列表

列出所有网络中继

使用方法:

openstack network trunk list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN] [--long]

表 52.297. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 52.298. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 52.299. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 52.300. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.301. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.75. 网络中继集

设置网络中继属性

使用方法:

openstack network trunk set [-h] [--name <name>]
                                   [--description <description>]
                                   [--subport <port=,segmentation-type=,segmentation-id=>]
                                   [--enable | --disable]
                                   <trunk>

表 52.302. positional 参数
概述

<trunk>

要修改的中继(名称或 id)

表 52.303. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置中继名称

--description <description>

中继的描述

--subport <port=,segmentation-type=,segmentation-id⇒

要添加的 Subport。子端口格式为 port=<name 或 ID>,segmentation-type=,segmentation-ID=(--subport)选项

--enable

启用中继

--disable

禁用中继

52.76. 网络中继显示

显示给定网络中继的信息

使用方法:

openstack network trunk show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <trunk>

表 52.304. positional 参数
概述

<trunk>

要显示的中继(名称或 id)

表 52.305. 命令参数
概述

-h, --help

显示帮助信息并退出

表 52.306. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 52.307. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 52.308. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 52.309. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

52.77. 网络中继未设置

从给定网络中继中取消设置子端口

使用方法:

openstack network trunk unset [-h] --subport <subport> <trunk>

表 52.310. positional 参数
概述

<trunk>

从此中继中取消设置子端口(名称或 id)

表 52.311. 命令参数
概述

-h, --help

显示帮助信息并退出

--subport <subport>

可以重复要删除的 Subport (端口的名称或 ID)(--subport)选项

52.78. 网络取消设置

取消设置网络属性

使用方法:

openstack network unset [-h] [--tag <tag> | --all-tag] <network>

表 52.312. positional 参数
概述

<network>

要修改的网络(名称或 id)

表 52.313. 命令参数
概述

-h, --help

显示帮助信息并退出

--tag <tag>

要从网络中删除的标签(需要删除多个标签)

--all-tag

清除与网络关联的所有标签

第 53 章 对象

本章描述了 对象 命令下的命令。

53.1. 对象创建

将对象上传到容器

使用方法:

openstack object create [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN] [--name <name>]
                               <container> <filename> [<filename> ...]

表 53.1. positional 参数
概述

<Container>

新对象的容器

<filename>

要上传的本地文件名

表 53.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

上传文件并重命名该文件。只能在上传单个对象时使用

表 53.3. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 53.4. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 53.5. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 53.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

53.2. 对象删除

从容器中删除对象

使用方法:

openstack object delete [-h] <container> <object> [<object> ...]

表 53.7. positional 参数
概述

<Container>

从 <container> 中删除对象

<object>

要删除的对象

表 53.8. 命令参数
概述

-h, --help

显示帮助信息并退出

53.3. 对象列表

列出对象

使用方法:

openstack object list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--prefix <prefix>]
                             [--delimiter <delimiter>] [--marker <marker>]
                             [--end-marker <end-marker>]
                             [--limit <num-objects>] [--long] [--all]
                             <container>

表 53.9. positional 参数
概述

<Container>

容器列出

表 53.10. 命令参数
概述

-h, --help

显示帮助信息并退出

--prefix <prefix>

使用 <prefix> 过滤列表

--delimiter <delimiter>

使用 <delimiter> 滚动项目

--marker <marker>

分页的 Anchor

--end-marker <end-marker>

分页的端点

--limit <num-objects>

限制返回的对象数量

--long

列出输出中的其他字段

--all

列出容器中的所有对象(默认为 10000)

表 53.11. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 53.12. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 53.13. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 53.14. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

53.4. 对象保存

本地保存对象

使用方法:

openstack object save [-h] [--file <filename>] <container> <object>

表 53.15. positional 参数
概述

<Container>

从 <container> 下载 <object>

<object>

要保存的对象

表 53.16. 命令参数
概述

-h, --help

显示帮助信息并退出

--file <filename>

目标文件名(默认为对象名称);使用 - 作为文件名会将文件输出到 stdout

53.5. 对象集

设置对象属性

使用方法:

openstack object set [-h] --property <key=value> <container> <object>

表 53.17. positional 参数
概述

<Container>

从 <container> 修改 <object>

<object>

要修改的对象

表 53.18. 命令参数
概述

-h, --help

显示帮助信息并退出

--property <key=value>

设置此对象上的属性(重复选项来设置多个属性)

53.6. 对象显示

显示对象详情

使用方法:

openstack object show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <container> <object>

表 53.19. positional 参数
概述

<Container>

从 <container> 显示 <object>

<object>

要显示的对象

表 53.20. 命令参数
概述

-h, --help

显示帮助信息并退出

表 53.21. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 53.22. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 53.23. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 53.24. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

53.7. 对象存储帐户集

设置帐户属性

使用方法:

openstack object store account set [-h] --property <key=value>

表 53.25. 命令参数
概述

-h, --help

显示帮助信息并退出

--property <key=value>

设置此帐户上的属性(重复选项来设置多个属性)

53.8. 对象存储帐户显示

显示帐户详情

使用方法:

openstack object store account show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]

表 53.26. 命令参数
概述

-h, --help

显示帮助信息并退出

表 53.27. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 53.28. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 53.29. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 53.30. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

53.9. 对象存储帐户未设置

取消设置帐户属性

使用方法:

openstack object store account unset [-h] --property <key>

表 53.31. 命令参数
概述

-h, --help

显示帮助信息并退出

--property <key>

要从帐户中删除的属性(重复选项来删除多个属性)

53.10. 对象取消设置

取消设置对象属性

使用方法:

openstack object unset [-h] --property <key> <container> <object>

表 53.32. positional 参数
概述

<Container>

从 <container> 修改 <object>

<object>

要修改的对象

表 53.33. 命令参数
概述

-h, --help

显示帮助信息并退出

--property <key>

要从对象中删除的属性(重复选项来删除多个属性)

第 54 章 Orchestration

本章描述了 编配 命令下的命令。

54.1. 编配构建信息

检索构建信息。

使用方法:

openstack orchestration build info [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]

表 54.1. 命令参数
概述

-h, --help

显示帮助信息并退出

表 54.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 54.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 54.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 54.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

54.2. 编配资源类型列表

列出资源类型。

使用方法:

openstack orchestration resource type list [-h]
                                                  [-f {csv,json,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--quote {all,minimal,none,nonnumeric}]
                                                  [--noindent]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--sort-column SORT_COLUMN]
                                                  [--filter <key=value>]
                                                  [--long]

表 54.6. 命令参数
概述

-h, --help

显示帮助信息并退出

--filter <key=value>

过滤参数以应用到返回的资源类型。这可以多次指定。它可以是任何名称、版本或 support_status

--long

显示资源类型,其中包含每种资源类型的相应描述。

表 54.7. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 54.8. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 54.9. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 54.10. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

54.3. 编配资源类型显示

显示详情并选择性地为资源类型生成模板。

使用方法:

openstack orchestration resource type show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--template-type <template-type>]
                                                  [--long]
                                                  <resource-type>

表 54.11. positional 参数
概述

<resource-type>

显示详情的资源类型

表 54.12. 命令参数
概述

-h, --help

显示帮助信息并退出

--template-type <template-type>

要生成的可选模板类型、热或 cfn

--long

显示包含对应描述的资源类型。

表 54.13. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 54.14. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 54.15. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 54.16. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

54.4. 编排服务列表

列出 Heat 引擎。

使用方法:

openstack orchestration service list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]

表 54.17. 命令参数
概述

-h, --help

显示帮助信息并退出

表 54.18. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 54.19. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 54.20. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 54.21. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

54.5. 编排服务功能列表

列出可用的功能。

使用方法:

openstack orchestration template function list [-h]
                                                      [-f {csv,json,table,value,yaml}]
                                                      [-c COLUMN]
                                                      [--quote {all,minimal,none,nonnumeric}]
                                                      [--noindent]
                                                      [--max-width <integer>]
                                                      [--fit-width]
                                                      [--print-empty]
                                                      [--sort-column SORT_COLUMN]
                                                      [--with_conditions]
                                                      <template-version>

表 54.22. positional 参数
概述

<template-version>

用于获取模板功能的模板版本

表 54.23. 命令参数
概述

-h, --help

显示帮助信息并退出

--with_conditions

显示模板的条件功能。

表 54.24. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 54.25. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 54.26. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 54.27. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

54.6. 编配模板验证

验证模板

使用方法:

openstack orchestration template validate [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [-e <environment>]
                                                 [--show-nested]
                                                 [--parameter <key=value>]
                                                 [--ignore-errors <error1,error2,...>]
                                                 -t <template>

表 54.28. 命令参数
概述

-h, --help

显示帮助信息并退出

-e <environment>, --environment <environment>

到环境的路径。可多次指定

--show-nested

也从嵌套模板解析参数

--parameter <key=value>

用于创建堆栈的参数值。这可以多次指定

--ignore-errors <error1,error2,…​>

要忽略的 heat 错误列表

-T <template>, --template <template>

模板的路径

表 54.29. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 54.30. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 54.31. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 54.32. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

54.7. 编排服务版本列表

列出可用的模板版本。

使用方法:

openstack orchestration template version list [-h]
                                                     [-f {csv,json,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--quote {all,minimal,none,nonnumeric}]
                                                     [--noindent]
                                                     [--max-width <integer>]
                                                     [--fit-width]
                                                     [--print-empty]
                                                     [--sort-column SORT_COLUMN]

表 54.33. 命令参数
概述

-h, --help

显示帮助信息并退出

表 54.34. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 54.35. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 54.36. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 54.37. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 55 章 overcloud

本章描述了 overcloud 命令下的命令。

55.1. Overcloud 管理员授权

部署 Mistral 所需的 ssh 密钥。

使用方法:

openstack overcloud admin authorize [-h] [--stack STACK]
                                           [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                           [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                           [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                           [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT]
                                           [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]

表 55.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--stack STACK

heat 堆栈的名称或 id (default=env: OVERCLOUD_STACK_NAME)

--overcloud-ssh-user OVERCLOUD_SSH_USER

用于 ssh 访问 overcloud 节点的用户

--overcloud-ssh-key OVERCLOUD_SSH_KEY

用于 ssh 访问 overcloud 节点的关键路径。当定义密钥将被自动探测到时。

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

用于 ssh 访问 overcloud 节点的网络名称。

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

ssh 启用进程的超时时间完成。

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

等待 ssh 端口处于活跃状态的超时时间。

55.2. Overcloud 备份

备份 Overcloud

使用方法:

openstack overcloud backup [--init [INIT]] [--setup-nfs] [--setup-rear]
                                  [--cron] [--inventory INVENTORY]
                                  [--storage-ip STORAGE_IP]
                                  [--extra-vars EXTRA_VARS]

表 55.2. 命令参数
概述

--init [INIT]

初始化用于备份的环境,使用 rearnfs 作为 args,它将检查软件包安装和配置的 ReaR 或者 NFS 服务器。默认为:rear. 例如 --init rear。警告:此标志将被弃用,并由 --setup-rear--setup-nfs 替代。

--setup-nfs

在备份节点上设置 nfs 服务器,它将在 ansible 清单的主机 BackupNode 上安装所需的软件包和配置。

--setup-rear

在将安装和配置 ReaR 的 overcloud 控制器 主机上设置重新执行。

--cron

设置一个新的 cron 作业,默认情况下将在 Sundays 周等执行每周备份,但可以使用 tripleo_backup_and_restore_cron 额外变量进行自定义。

--inventory INVENTORY

使用 tripleo-ansible- inventory 命令生成的 tripleo 清单文件。默认为: /home/stack/tripleo- inventory.yaml。

--storage-ip STORAGE_IP

Storage ip 是一个可选参数,允许指定存储服务器的 ip,覆盖默认 undercloud。警告:此标志将被弃用,而 --extra-vars 将允许传递这个和其他变量。

--extra-vars EXTRA_VARS

将额外变量设置为 dict 或为 JSON 或 YAML 文件类型的绝对路径。例如 --extra-vars {"key": "val", "key2": "val2"} i.e. --extra-vars /path/to/my_vars.yaml i.e. --extra-vars /path/to/my_vars.json。有关可传递的变量的更多信息,请访问 :https://opendev.org/openstack/tripleo-ansible/src/bran ch/master/tripleo_ansible/roles/backup_and_restore/def aults/main.yml。

55.3. Overcloud 单元导出

导出作为另一个单元导入的单元信息

使用方法:

openstack overcloud cell export [-h]
                                       [--control-plane-stack <control plane stack>]
                                       [--cell-stack <cell stack>]
                                       [--output-file <output file>]
                                       [--config-download-dir CONFIG_DOWNLOAD_DIR]
                                       [--force-overwrite]

表 55.3. 命令参数
概述

-h, --help

显示帮助信息并退出

--control-plane-stack <control plane stack>

从中导出信息的环境主要 heat 堆栈的名称。(default=Env: OVERCLOUD_STACK_NAME)

--cell-stack <cell stack>, -e <cell stack>

要从中导出信息的控制器单元 heat 堆栈的名称。如果是:control plane stack → cell controller stack → multiple compute stack

--output-file <output file>, -o <output file>

单元数据导出的输出文件的名称。它将默认为 "<name>.yaml"

--config-download-dir CONFIG_DOWNLOAD_DIR

搜索 config-download 导出数据的目录。默认为 $HOME/config-download

--force-overwrite, -f

如果输出文件存在,则覆盖它。

55.4. overcloud 配置下载

下载 Overcloud 配置

使用方法:

openstack overcloud config download [-h] [--name NAME]
                                           [--config-dir CONFIG_DIR]
                                           [--config-type CONFIG_TYPE]
                                           [--no-preserve-config]

表 55.4. 命令参数
概述

-h, --help

显示帮助信息并退出

--name NAME

计划的名称,用于对象存储容器、工作流环境和监控堆栈名称。

--config-dir CONFIG_DIR

将推送配置文件的目录

--config-type CONFIG_TYPE

要从部署中提取的对象类型,默认为所有可用的键

--no-preserve-config

如果指定,将删除并重新创建 --config- dir (如果已存在)。默认为使用现有的 dir 位置并覆盖文件。默认情况下,--config-dir 中的文件来自堆栈中的文件将被保留。

55.5. Overcloud 容器镜像构建

使用 kolla-build 构建 overcloud 容器镜像。

使用方法:

openstack overcloud container image build [-h]
                                                 [--config-file <yaml config file>]
                                                 --kolla-config-file <config
                                                 file> [--list-images]
                                                 [--list-dependencies]
                                                 [--exclude <container-name>]
                                                 [--use-buildah]
                                                 [--work-dir <container builds directory>]

表 55.5. 命令参数
概述

-h, --help

显示帮助信息并退出

--config-file <yaml config file>

YAML 配置文件指定要构建的镜像。可多次指定。保留顺序,之后的文件将覆盖前面文件中的一些选项。其他选项将被附加。如果没有指定,则会构建默认容器集合。

--kolla-config-file <config file>

要使用的 kolla 配置文件的路径。可以指定多个配置文件,之后的文件中的值优先使用。默认情况下,添加了 tripleo kolla conf 文件 /usr/share/tripleo-common/container- images/tripleo_kolla_config_overrides.conf。

--list-images

显示将要构建的镜像,而不是构建它们。

--list-dependencies

显示镜像构建依赖项,而不是构建它们。

--exclude <container-name>

要与要跳过的容器列表匹配的容器名称。可多次指定。

--use-buildah

使用 buildah 而不是 docker 使用 Kolla 构建镜像。

--work-dir <container builds directory>

tripleo 容器构建目录,存储各个镜像及其依赖项的配置和日志。

55.6. overcloud 容器镜像准备

生成定义镜像、标签和 registry 的文件。

使用方法:

openstack overcloud container image prepare [-h]
                                                   [--template-file <yaml template file>]
                                                   [--push-destination <location>]
                                                   [--tag <tag>]
                                                   [--tag-from-label <image label>]
                                                   [--namespace <namespace>]
                                                   [--prefix <prefix>]
                                                   [--suffix <suffix>]
                                                   [--set <variable=value>]
                                                   [--exclude <regex>]
                                                   [--include <regex>]
                                                   [--output-images-file <file path>]
                                                   [--environment-file <file path>]
                                                   [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                                   [--output-env-file <file path>]
                                                   [--roles-file ROLES_FILE]
                                                   [--modify-role MODIFY_ROLE]
                                                   [--modify-vars MODIFY_VARS]

表 55.6. 命令参数
概述

-h, --help

显示帮助信息并退出

--template-file <yaml template file>

从中构建镜像配置文件的 yaml 模板文件。默认: /usr/share/tripleo-common/container- images/tripleo_containers.yaml.j2

--push-destination <location>

要将镜像推送到的镜像 registry 的位置。如果指定,则会为每个镜像条目设置一个 push_destination。

--tag <tag>

覆盖默认标签替换。如果指定了 --tag-from- 标签,请使用此标签开始发现。默认: 16.2

--tag-from-label <image label>

使用指定标签值来发现标签。标签可以以模板格式合并,例如: {version}-{release}

--namespace <namespace>

覆盖默认命名空间替换。默认:registry.redhat.io/rhosp-rhel8

--prefix <prefix>

覆盖默认名称前缀替换。默认:openstack-

--suffix <suffix>

覆盖默认名称后缀替换。Default:

--set <variable=value>

在模板中设置变量的值,即使它没有专用参数,如 "--suffix"。

--exclude <regex>

与生成的 imagename 条目匹配的模式,要从最终输出中排除。可多次指定。

--include <regex>

与生成的 imagename 条目匹配的模式,用于包括在最终输出中。可以多次指定,不匹配任何 --include 的条目将被排除。如果使用 --include,则忽略 --exclude。

--output-images-file <file path>

将生成的镜像条目写入的文件以及 stdout。任何现有文件都会被覆盖。

--environment-file <file path>, -e <file path>

指定容器化服务的环境文件。条目将过滤为仅包含容器化服务使用的镜像。(可多次指定。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

自动添加到 update 命令的环境文件目录。条目将过滤为仅包含容器化服务使用的镜像。可以多次指定。目录中的文件以升序顺序加载。

--output-env-file <file path>

用于编写指定所有镜像参数的 heat 环境文件的文件。任何现有文件都会被覆盖。

--roles-file ROLES_FILE, -r ROLES_FILE

角色文件,覆盖用于部署的 t-h-t templates 目录中的默认 roles_data.yaml。可以是绝对路径或相对于模板目录的路径。

--modify-role MODIFY_ROLE

要在每个镜像上传拉取和推送之间运行的 ansible 角色的名称。

--modify-vars MODIFY_VARS

Ansible 变量文件,其中包含在调用角色 --modify-role 时要使用的变量。

55.7. overcloud 容器镜像标签发现

发现镜像的 versioned 标签。

使用方法:

openstack overcloud container image tag discover [-h] --image
                                                        <container image>
                                                        [--tag-from-label <image label>]

表 55.7. 命令参数
概述

-h, --help

显示帮助信息并退出

--image <container image>

要发现标签的镜像名称(不包括 registry 和 stable 标签)。

--tag-from-label <image label>

使用指定标签值来发现标签。标签可以以模板格式合并,例如: {version}-{release}

55.8. Overcloud 容器镜像上传

将 overcloud 容器镜像推送到 registry。

使用方法:

openstack overcloud container image upload [-h] --config-file <yaml
                                                  config file>
                                                  [--cleanup <full, partial, none>]

表 55.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--config-file <yaml config file>

指定镜像构建的 yaml 配置文件。可多次指定。保留顺序,之后的文件将覆盖前面文件中的一些选项。其他选项将被附加。

--cleanup <full, partial, none>

上传后保留本地镜像的清理行为。默认 full 将尝试删除所有本地镜像。部分 将保留在此主机上部署所需的镜像。none 将不进行清理。

55.9. Overcloud 凭证

创建 overcloudrc 文件

使用方法:

openstack overcloud credentials [-h] [--directory [DIRECTORY]] plan

表 55.9. positional 参数
概述

plan

要为创建 rc 文件的计划名称。

表 55.10. 命令参数
概述

-h, --help

显示帮助信息并退出

--directory [DIRECTORY]

创建 rc 文件的目录。默认为当前目录。

55.10. overcloud 删除

删除 overcloud 堆栈和计划

使用方法:

openstack overcloud delete [-h] [-y] [-s] [stack]

表 55.11. positional 参数
概述

queue

要删除的 heat 堆栈的名称或 ID (default=env: OVERCLOUD_STACK_NAME)

表 55.12. 命令参数
概述

-h, --help

显示帮助信息并退出

-y, --yes

跳过是/无提示(假设是 yes)。

-s, --skip-ipa-cleanup

跳过从 FreeIPA 中删除 overcloud 主机、服务和 dns 记录。这对使用 FreeIPA 中的证书用于 TLS 的部署尤其重要。默认情况下,overcloud 主机、服务和 DNS 记录将从 FreeIPA 中删除,然后再删除 overcloud。使用这个选项可能需要稍后手动清理 FreeIPA。

55.11. Overcloud 部署

部署 Overcloud

使用方法:

openstack overcloud deploy [--templates [TEMPLATES]] [--stack STACK]
                                  [--timeout <TIMEOUT>]
                                  [--control-scale CONTROL_SCALE]
                                  [--compute-scale COMPUTE_SCALE]
                                  [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                  [--block-storage-scale BLOCK_STORAGE_SCALE]
                                  [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                  [--control-flavor CONTROL_FLAVOR]
                                  [--compute-flavor COMPUTE_FLAVOR]
                                  [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                  [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                  [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                  [--libvirt-type {kvm,qemu}]
                                  [--ntp-server NTP_SERVER]
                                  [--no-proxy NO_PROXY]
                                  [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                  [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                  [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                  [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT]
                                  [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]
                                  [--environment-file <HEAT ENVIRONMENT FILE>]
                                  [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                  [--roles-file ROLES_FILE]
                                  [--networks-file NETWORKS_FILE]
                                  [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                  [--no-cleanup] [--update-plan-only]
                                  [--validation-errors-nonfatal]
                                  [--validation-warnings-fatal]
                                  [--disable-validations]
                                  [--inflight-validations] [--dry-run]
                                  [--run-validations] [--skip-postconfig]
                                  [--force-postconfig]
                                  [--skip-deploy-identifier]
                                  [--answers-file ANSWERS_FILE]
                                  [--disable-password-generation]
                                  [--deployed-server] [--config-download]
                                  [--no-config-download]
                                  [--config-download-only]
                                  [--output-dir OUTPUT_DIR]
                                  [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                  [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                  [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                  [-b <baremetal_deployment.yaml>]
                                  [--limit LIMIT] [--tags TAGS]
                                  [--skip-tags SKIP_TAGS]
                                  [--ansible-forks ANSIBLE_FORKS]

表 55.13. 命令参数
概述

--templates [TEMPLATES]

要部署的 heat 模板的目录

--stack STACK

创建或更新的堆栈名称

--timeout <TIMEOUT>, -t <TIMEOUT>

部署超时(以分钟为单位)。

--control-scale CONTROL_SCALE

新节点数量(已弃用)。使用环境文件并设置参数 ControllerCount。这个选项将在"U"发行版本中删除。

--compute-scale COMPUTE_SCALE

新节点的新数量(已弃用)。使用环境文件并设置参数 ComputeCount。这个选项将在"U"发行版本中删除。

--ceph-storage-scale CEPH_STORAGE_SCALE

新的 ceph 存储节点数量(已弃用)。使用环境文件并设置参数 CephStorageCount。这个选项将在"U"发行版本中删除。

--block-storage-scale BLOCK_STORAGE_SCALE

新的 cinder 存储节点数量(已弃用)。使用环境文件并设置参数 BlockStorageCount。这个选项将在"U"发行版本中删除。

--swift-storage-scale SWIFT_STORAGE_SCALE

新的 swift 存储节点数量(已弃用)。使用环境文件并设置参数 ObjectStorageCount。这个选项将在"U"发行版本中删除。

--control-flavor CONTROL_FLAVOR

用于控制节点的 Nova 类别(已弃用)。使用环境文件并设置参数 OvercloudControlFlavor。这个选项将在"U"发行版本中删除。

--compute-flavor COMPUTE_FLAVOR

用于计算节点的 Nova 类别(已弃用)。使用环境文件并设置参数 OvercloudComputeFlavor。这个选项将在"U"发行版本中删除。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

用于 ceph 存储节点的 Nova 类别。(已弃用)。使用环境文件并设置参数 OvercloudCephStorageFlavor。这个选项将在"U"发行版本中删除。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

用于 Cinder 存储节点(DEPRECATED 的 Nova 类别。使用环境文件并设置参数 OvercloudBlockStorageFlavor。这个选项将在"U"发行版本中删除。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

用于 swift 存储节点的 Nova 类别(DEPRECATED。使用环境文件并设置参数 OvercloudSwiftStorageFlavor。这个选项将在"U"发行版本中删除。

--libvirt-type {kvm,qemu}

libvirt 域类型。

--ntp-server NTP_SERVER

overcloud 节点的 ntp。

--no-proxy NO_PROXY

不应代理的以逗号分隔的主机列表。

--overcloud-ssh-user OVERCLOUD_SSH_USER

用于 ssh 访问 overcloud 节点的用户

--overcloud-ssh-key OVERCLOUD_SSH_KEY

用于 ssh 访问 overcloud 节点的关键路径。当定义密钥将被自动探测到时。

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

用于 ssh 访问 overcloud 节点的网络名称。

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

ssh 启用进程的超时时间完成。

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

等待 ssh 端口处于活跃状态的超时时间。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

要传递给 heat stack-create 或 heat stack-update 命令的环境文件。(可多次指定。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

自动添加到 heat stack-create 或 heat stack-update 命令的环境文件目录。可以多次指定。目录中的文件以升序顺序加载。

--roles-file ROLES_FILE, -r ROLES_FILE

角色文件,覆盖 --templates 目录中的默认 roles_data.yaml。可以是绝对路径或相对于 --templates 的路径

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

网络文件,覆盖 --templates 目录中的默认 network_data.yaml

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

计划环境文件,覆盖 --templates 目录中的默认 plan- environment.yaml

--no-cleanup

不要清理临时文件,只记录其位置

--update-plan-only

仅更新计划。请勿执行实际部署。注意:将在以后的版本中移至离散命令。

--validation-errors-nonfatal

即使验证错误,允许部署继续。请注意,在存在错误时尝试部署可能会失败。

--validation-warnings-fatal

如果配置预检查出现警告,则退出。

--disable-validations

弃用。完全禁用部署前验证。这些验证是内置预部署验证。要从 tripleo-validations 启用外部验证,请使用 --run-validations 标志。这些验证现在通过 tripleo-validations 中的外部验证运行。

--inflight-validations

在部署期间激活动态验证。动态验证提供了一种强大的方法,以确保部署的服务在激活后运行。默认值为 False。

--dry-run

仅运行验证,但不应用任何更改。

--run-validations

从 tripleo-validations 项目运行外部验证。

--skip-postconfig

跳过 overcloud 部署后配置。

--force-postconfig

强制进行 overcloud 部署后配置。

--skip-deploy-identifier

跳过为 DeployIdentifier 参数生成唯一标识符。只有在配置实际更改时,才会触发软件配置部署步骤。这个选项应当与 Caution 一起使用,只有在认为软件配置不需要运行时才需要运行,比如在扩展某些角色时。

--answers-file ANSWERS_FILE

到带有参数和参数的 yaml 文件的路径。

--disable-password-generation

禁用密码生成。

--deployed-server

使用预置备的 overcloud 节点。从 undercloud 节点中删除 baremetal、compute 和镜像服务要求。只能与-- disable-validations 一起使用。

--config-download

通过 config-download 机制运行部署。现在这是默认设置,以后可能会删除此 CLI 选项。

--no-config-download, --stack-only

禁用 config-download 工作流,仅创建堆栈和相关 OpenStack 资源。不会应用软件配置。

--config-download-only

禁用堆栈创建/更新,并且仅运行 config-download 工作流以应用软件配置。

--output-dir OUTPUT_DIR

使用 --config- download 时用于保存输出的目录。该目录必须可由 mistral 用户写入。如果没有指定,则使用默认的服务器端值(/var/lib/mistral/<execution id>。

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

ansible 配置文件的路径。该文件中的配置将覆盖默认覆盖 config-download 使用的任何配置。

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

用于 config-download 步骤的超时(以分钟为单位)。如果未设置,则在堆栈操作后,将从 --timeout 参数保留大量时间。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

用于部署操作的 python 解释器的路径。如果在 python3 系统的 python2 主机上部署,或者反之之,则可能需要使用它。

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

描述裸机部署的配置文件

--limit LIMIT

标识单个节点或以逗号分隔的节点列表的字符串,config-download Ansible playbook 执行将限制为。例如:--limit "compute-0,compute-1,compute-5"。

--tags TAGS

运行 config-download ansible-playbook 命令时使用的标签列表。

--skip-tags SKIP_TAGS

运行 config- download ansible-playbook 命令时要跳过的标签列表。

--ansible-forks ANSIBLE_FORKS

用于 config- download ansible-playbook 命令的 ansible fork 数量。

55.12. overcloud 执行

在服务器上执行 Heat 软件配置。

使用方法:

openstack overcloud execute [-h] [-s SERVER_NAME] [-g GROUP] file_in

表 55.14. positional 参数
概述

file_in

None

表 55.15. 命令参数
概述

-h, --help

显示帮助信息并退出

-s SERVER_NAME, --server_name SERVER_NAME

要匹配的 Nova server_name 或部分名称。

-g GROUP, --group GROUP

Heat 软件配置"group"类型。默认为 "script"。

55.13. overcloud 导出 ceph

导出用作从一个或多个堆栈导入另一个堆栈导出 Ceph 信息的 Ceph 信息,用作另一个堆栈的输入。使用填充的 CephExternalMultiConfig 参数创建有效的 YAML 文件。

使用方法:

openstack overcloud export ceph [-h] [--stack <stack>]
                                       [--cephx-key-client-name <cephx>]
                                       [--output-file <output file>]
                                       [--force-overwrite]
                                       [--config-download-dir CONFIG_DOWNLOAD_DIR]

表 55.16. 命令参数
概述

-h, --help

显示帮助信息并退出

--stack <stack>

从中导出 ceph 信息的 overcloud 堆栈的名称。如果传递以逗号分隔的堆栈列表,则所有堆栈的 Ceph 信息将导出到单个文件中。(default=Env: OVERCLOUD_STACK_NAME)

--cephx-key-client-name <cephx>, -k <cephx>

要导出的 cephx 客户端密钥的名称。(default=openstack)

--output-file <output file>, -o <output file>

ceph 数据导出的输出文件的名称。如果提供了堆栈,则默认为 "ceph-export-<STACK>.yaml"。如果提供了 N 堆栈,则默认为 "ceph-export-<N>-stacks.yaml"。

--force-overwrite, -f

如果输出文件存在,则覆盖它。

--config-download-dir CONFIG_DOWNLOAD_DIR

搜索 config-download 导出数据的目录。默认为 /var/lib/mistral

55.14. Overcloud 导出

导出用作另一个堆栈导入的堆栈信息

使用方法:

openstack overcloud export [-h] [--stack <stack>]
                                  [--output-file <output file>]
                                  [--force-overwrite]
                                  [--config-download-dir CONFIG_DOWNLOAD_DIR]
                                  [--no-password-excludes]

表 55.17. 命令参数
概述

-h, --help

显示帮助信息并退出

--stack <stack>

从中导出信息的环境主要 heat 堆栈的名称。(default=Env: OVERCLOUD_STACK_NAME)

--output-file <output file>, -o <output file>

堆栈数据导出的输出文件的名称。它将默认为 "<name>.yaml"

--force-overwrite, -f

如果输出文件存在,则覆盖它。

--config-download-dir CONFIG_DOWNLOAD_DIR

搜索 config-download 导出数据的目录。默认为 /var/lib/mistral/<stack>

--no-password-excludes

不要从密码导出中排除某些密码。在 中,默认为 False,因为一些密码通常不需要。

55.15. overcloud external-update run

运行外部次要更新 Ansible playbook,这将运行外部次要更新 Ansible playbook,从 undercloud 执行任务。完成 overcloud update prepare 命令后,会提供更新 playbook。

使用方法:

openstack overcloud external-update run [-h]
                                               [--static-inventory STATIC_INVENTORY]
                                               [--ssh-user SSH_USER]
                                               [--tags TAGS]
                                               [--skip-tags SKIP_TAGS]
                                               [--stack STACK] [-e EXTRA_VARS]
                                               [--no-workflow] [-y]
                                               [--limit LIMIT]
                                               [--ansible-forks ANSIBLE_FORKS]

表 55.18. 命令参数
概述

-h, --help

显示帮助信息并退出

--static-inventory STATIC_INVENTORY

要使用的现有 ansible 清单的路径。如果没有指定,则会在 ~/tripleo-ansible- inventory.yaml 中生成一个

--ssh-user SSH_USER

已弃用:只有 tripleo-admin 应用作 ssh 用户。

--tags TAGS

指定要作为 --tags 传递给 ansible-playbook 的标签列表或以逗号分隔的标签列表的字符串。

--skip-tags SKIP_TAGS

指定要作为 --skip-tags 传递给 ansible-playbook 的标签列表或以逗号分隔的标签列表的字符串。

--stack STACK

heat 堆栈的名称或 id (default=env: OVERCLOUD_STACK_NAME)

-e EXTRA_VARS, --extra-vars EXTRA_VARS

将额外变量设置为 key=value 或 yaml/json

--no-workflow

直接通过系统命令运行 ansible-playbook,而不是通过 TripleO mistral 工作流运行 Ansible。

-y, --yes

使用 -y 或 --yes 跳过任何升级操作前所需的确认。请谨慎使用这个选项!

--limit LIMIT

标识单个节点或以逗号分隔的节点列表的字符串,config-download Ansible playbook 执行将限制为。例如:--limit "compute-0,compute-1,compute-5"。

--ansible-forks ANSIBLE_FORKS

用于 config- download ansible-playbook 命令的 ansible fork 数量。

55.16. overcloud 外部升级运行

运行外部主要升级 Ansible playbook,这将运行外部主要升级 Ansible playbook,从 undercloud 执行任务。升级 playbook 在 overcloud upgrade prepare 命令完成后可用。

使用方法:

openstack overcloud external-upgrade run [-h]
                                                [--static-inventory STATIC_INVENTORY]
                                                [--ssh-user SSH_USER]
                                                [--tags TAGS]
                                                [--skip-tags SKIP_TAGS]
                                                [--stack STACK]
                                                [-e EXTRA_VARS]
                                                [--no-workflow] [-y]
                                                [--limit LIMIT]
                                                [--ansible-forks ANSIBLE_FORKS]

表 55.19. 命令参数
概述

-h, --help

显示帮助信息并退出

--static-inventory STATIC_INVENTORY

要使用的现有 ansible 清单的路径。如果没有指定,则会在 ~/tripleo-ansible- inventory.yaml 中生成一个

--ssh-user SSH_USER

已弃用:只有 tripleo-admin 应用作 ssh 用户。

--tags TAGS

指定要作为 --tags 传递给 ansible-playbook 的标签列表或以逗号分隔的标签列表的字符串。

--skip-tags SKIP_TAGS

指定要作为 --skip-tags 传递给 ansible-playbook 的标签列表或以逗号分隔的标签列表的字符串。

--stack STACK

heat 堆栈的名称或 id (default=env: OVERCLOUD_STACK_NAME)

-e EXTRA_VARS, --extra-vars EXTRA_VARS

将额外变量设置为 key=value 或 yaml/json

--no-workflow

直接通过系统命令运行 ansible-playbook,而不是通过 TripleO mistral 工作流运行 Ansible。

-y, --yes

使用 -y 或 --yes 跳过任何升级操作前所需的确认。请谨慎使用这个选项!

--limit LIMIT

标识单个节点或以逗号分隔的节点列表的字符串,config-download Ansible playbook 执行将限制为。例如:--limit "compute-0,compute-1,compute-5"。

--ansible-forks ANSIBLE_FORKS

用于 config- download ansible-playbook 命令的 ansible fork 数量。

55.17. overcloud 失败

获取部署失败

使用方法:

openstack overcloud failures [-h] [--plan PLAN]

表 55.20. 命令参数
概述

-h, --help

显示帮助信息并退出

--plan PLAN, --stack PLAN

堆栈/计划的名称(默认:overcloud)

55.18. overcloud 生成隔离

生成隔离参数

使用方法:

openstack overcloud generate fencing [-h] [-a FENCE_ACTION]
                                            [--delay DELAY] [--ipmi-lanplus]
                                            [--ipmi-no-lanplus]
                                            [--ipmi-cipher IPMI_CIPHER]
                                            [--ipmi-level IPMI_LEVEL]
                                            [--output OUTPUT]
                                            instackenv

表 55.21. positional 参数
概述

instackenv

None

表 55.22. 命令参数
概述

-h, --help

显示帮助信息并退出

-a FENCE_ACTION, --action FENCE_ACTION

弃用:这个选项将被忽略。

--delay DELAY

在隔离启动前等待延迟秒数

--ipmi-lanplus

deprecated:这是默认设置。

--ipmi-no-lanplus

不要使用 lanplus。默认为:false

--ipmi-cipher IPMI_CIPHER

Ciphersuite 使用(与 ipmitool -c 参数相同)。

--ipmi-level IPMI_LEVEL

ipmi 设备上的 Privilegel 级别。有效的级别:回调、用户、操作员、管理员。

--output OUTPUT

将参数写入文件

55.19. Overcloud 镜像构建

为 overcloud 构建镜像

使用方法:

openstack overcloud image build [-h] [--config-file <yaml config file>]
                                       [--image-name <image name>] [--no-skip]
                                       [--output-directory OUTPUT_DIRECTORY]
                                       [--temp-dir TEMP_DIR]

表 55.23. 命令参数
概述

-h, --help

显示帮助信息并退出

--config-file <yaml config file>

指定镜像构建的 yaml 配置文件。可多次指定。保留顺序,之后的文件将覆盖前面文件中的一些选项。其他选项将被附加。

--image-name <image name>

要构建的镜像名称。可多次指定。如果未指定,将在给定的 YAML 文件中构建所有镜像。

--no-skip

如果存在缓存的镜像,请跳过构建。

--output-directory OUTPUT_DIRECTORY

镜像的输出目录。如果未设置,则默认为 $TRIPLEO_ROOT、或当前目录。

--temp-dir TEMP_DIR

构建镜像时要使用的临时目录。如果未设置,则默认为 $TMPDIR 或当前目录。

55.20. overcloud 镜像上传

使现有镜像文件可用于 overcloud 部署。

使用方法:

openstack overcloud image upload [-h] [--image-path IMAGE_PATH]
                                        [--os-image-name OS_IMAGE_NAME]
                                        [--ironic-python-agent-name IPA_NAME]
                                        [--http-boot HTTP_BOOT]
                                        [--update-existing] [--whole-disk]
                                        [--architecture ARCHITECTURE]
                                        [--platform PLATFORM]
                                        [--image-type {os,ironic-python-agent}]
                                        [--progress] [--local]
                                        [--local-path LOCAL_PATH]

表 55.24. 命令参数
概述

-h, --help

显示帮助信息并退出

--image-path IMAGE_PATH

包含镜像文件的目录路径

--os-image-name OS_IMAGE_NAME

OpenStack 磁盘镜像 filename

--ironic-python-agent-name IPA_NAME

openstack ironic-python-agent (agent)镜像文件名

--http-boot HTTP_BOOT

ironic-python-agent 镜像的根目录。如果为多个架构/平台上传镜像,则有所不同,以便为每个架构/平台创建不同的文件夹。

--update-existing

如果已存在,请更新镜像

--whole-disk

设置之后,要上传的 overcloud-full 镜像将被视为整个磁盘

--architecture ARCHITECTURE

这些镜像的架构类型、x86_64i386ppc64le 是常见的选项。这个选项应至少匹配 instackenv.json 中的 arch

--platform PLATFORM

这些镜像的平台类型。平台是架构的子类别。例如,您可能具有 x86_64 的通用镜像,但提供特定于 SandyBridge (SNB)的镜像。

--image-type {os,ironic-python-agent}

如果指定,允许限制要上传的镜像类型(用于 overcloud 镜像的值,或 ironic-python-agent 的 ironic-python- 代理一个代理)

--progress

显示上传文件操作的进度条

--local

在本地复制文件,即使有镜像服务端点

--local-path LOCAL_PATH

如果没有镜像端点,或者在指定 --local 时镜像文件复制目的地的根目录

55.21. overcloud netenv validate

验证网络环境文件。

使用方法:

openstack overcloud netenv validate [-h] [-f NETENV]

表 55.25. 命令参数
概述

-h, --help

显示帮助信息并退出

-f NETENV, --file NETENV

网络环境文件的路径

55.22. Overcloud 节点 bios 配置

在给定节点上应用 BIOS 配置

使用方法:

openstack overcloud node bios configure [-h] [--all-manageable]
                                               [--configuration <configuration>]
                                               [<node_uuid> [<node_uuid> ...]]

表 55.26. positional 参数
概述

<node_uuid>

节点配置 bios 的裸机节点 uuid

表 55.27. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-manageable

为当前处于 manageable 状态的所有节点配置 bios

--configuration <configuration>

BIOS 配置(yaml/json 字符串或文件名)。

55.23. overcloud 节点 bios 重置

将 BIOS 配置重置为工厂默认值

使用方法:

openstack overcloud node bios reset [-h] [--all-manageable]
                                           [<node_uuid> [<node_uuid> ...]]

表 55.28. positional 参数
概述

<node_uuid>

节点要重置 bios 的裸机节点 uuid

表 55.29. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-manageable

在当前处于 manageable 状态的所有节点上重置 bios

55.24. overcloud 节点清理

通过清理运行节点。

使用方法:

openstack overcloud node clean [-h] [--all-manageable] [--provide]
                                      [<node_uuid> [<node_uuid> ...]]

表 55.30. positional 参数
概述

<node_uuid>

要清理节点的裸机节点 uuid

表 55.31. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-manageable

清理当前处于 manageable 状态的所有节点

--provide

清理后提供(提供)节点

55.25. Overcloud 节点配置

配置节点引导选项。

使用方法:

openstack overcloud node configure [-h] [--all-manageable]
                                          [--deploy-kernel DEPLOY_KERNEL]
                                          [--deploy-ramdisk DEPLOY_RAMDISK]
                                          [--instance-boot-option {local,netboot}]
                                          [--root-device ROOT_DEVICE]
                                          [--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE]
                                          [--overwrite-root-device-hints]
                                          [<node_uuid> [<node_uuid> ...]]

表 55.32. positional 参数
概述

<node_uuid>

要配置的节点的裸机节点 uuid

表 55.33. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-manageable

配置当前处于 manageable 状态的所有节点

--deploy-kernel DEPLOY_KERNEL

部署了内核的镜像。

--deploy-ramdisk DEPLOY_RAMDISK

部署了 ramdisk 的镜像。

--instance-boot-option {local,netboot}

是否要为从本地硬盘(本地)还是网络(netboot)启动设置实例。

--root-device ROOT_DEVICE

为节点定义根设备。可以是要从两个策略中选择的设备名称(不带 /dev)的列表:max 或 minimal。要使该命令在内省后运行。

--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE

检测到的根设备的最小大小(以 gib 为单位)。与 --root-device 一起使用。

--overwrite-root-device-hints

使用 --root-device 时是否覆盖现有的 root 设备提示。

55.26. overcloud 节点删除

删除 overcloud 节点。

使用方法:

openstack overcloud node delete [-h] [-b <BAREMETAL DEPLOYMENT FILE>]
                                       [--stack STACK]
                                       [--templates [TEMPLATES]]
                                       [-e <HEAT ENVIRONMENT FILE>]
                                       [--timeout <TIMEOUT>] [-y]
                                       [<node> [<node> ...]]

表 55.34. positional 参数
概述

<node>

要删除的节点 ID (另一个在 --baremetal-deployment 文件中指定)

表 55.35. 命令参数
概述

-h, --help

显示帮助信息并退出

-B <BAREMETAL DEPLOYMENT FILE>, --baremetal-deployment <BAREMETAL DEPLOYMENT FILE>

描述裸机部署的配置文件

--stack STACK

要缩放的 heat 堆栈的名称或 ID (default=env: OVERCLOUD_STACK_NAME)

--templates [TEMPLATES]

要部署的 heat 模板的目录。这个参数已弃用。命令现在使用一个部署计划,该计划应在运行此命令前更新,这是必需的。否则,此参数将静默忽略。

-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>

要传递给 heat stack-create 或 heat stack-update 命令的环境文件。(可多次指定。) 这个参数已弃用。命令现在使用一个部署计划,该计划应在运行此命令前更新,这是必需的。否则,此参数将静默忽略。

--timeout <TIMEOUT>

等待节点被删除的超时时间(以分钟为单位)。请记住,由于 keystone 会话持续时间的上限为 4 小时

-y, --yes

跳过是/无提示(假设是 yes)。

55.27. overcloud 节点发现

通过轮询其 BMC 来发现 overcloud 节点。

使用方法:

openstack overcloud node discover [-h] (--ip <ips> | --range <range>)
                                         --credentials <key:value>
                                         [--port <ports>] [--introspect]
                                         [--run-validations] [--provide]
                                         [--no-deploy-image]
                                         [--instance-boot-option {local,netboot}]
                                         [--concurrency CONCURRENCY]

表 55.36. 命令参数
概述

-h, --help

显示帮助信息并退出

--ip <ips>

要探测的 IP 地址

--range <range>

到探测的 IP 范围

--credentials <key:value>

可能凭证的键/值对

--port <ports>

要探测的 BMC 端口

--introspect

内省导入的节点

--run-validations

运行部署前验证。这些外部验证来自 TripleO Validations 项目。

--provide

提供(提供)节点

--no-deploy-image

跳过设置部署内核和 ramdisk。

--instance-boot-option {local,netboot}

是否要为从本地硬盘(本地)还是网络(netboot)启动设置实例。

--concurrency CONCURRENCY

要一次内省的最大节点数。

55.28. overcloud 节点导入

从 JSON、YAML 或 CSV 文件导入裸机节点。默认情况下,节点状态将设置为 manageable

使用方法:

openstack overcloud node import [-h] [--introspect] [--run-validations]
                                       [--validate-only] [--provide]
                                       [--no-deploy-image]
                                       [--instance-boot-option {local,netboot}]
                                       [--http-boot HTTP_BOOT]
                                       [--concurrency CONCURRENCY]
                                       env_file

表 55.37. positional 参数
概述

env_file

None

表 55.38. 命令参数
概述

-h, --help

显示帮助信息并退出

--introspect

内省导入的节点

--run-validations

运行部署前验证。这些外部验证来自 TripleO Validations 项目。

--validate-only

验证 env_file,然后在不实际导入节点的情况下退出。

--provide

提供(提供)节点

--no-deploy-image

跳过设置部署内核和 ramdisk。

--instance-boot-option {local,netboot}

是否要为从本地硬盘(本地)还是网络(netboot)启动设置实例。

--http-boot HTTP_BOOT

ironic-python-agent 镜像的根目录

--concurrency CONCURRENCY

要一次内省的最大节点数。

55.29. overcloud 节点内省

内省指定节点或处于 manageable 状态的所有节点。

使用方法:

openstack overcloud node introspect [-h] [--all-manageable] [--provide]
                                           [--run-validations]
                                           [--concurrency CONCURRENCY]
                                           [<node_uuid> [<node_uuid> ...]]

表 55.39. positional 参数
概述

<node_uuid>

要内省节点的裸机节点 uuids

表 55.40. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-manageable

内省当前处于 manageable 状态的所有节点

--provide

内省后提供(提供)节点

--run-validations

运行部署前验证。这些外部验证来自 TripleO Validations 项目。

--concurrency CONCURRENCY

要一次内省的最大节点数。

55.30. Overcloud 节点提供

根据 UUID 或当前 manageable 状态将节点标记为 available。

使用方法:

openstack overcloud node provide [-h] [--all-manageable]
                                        [<node_uuid> [<node_uuid> ...]]

表 55.41. positional 参数
概述

<node_uuid>

要安装的节点的裸机节点 uuids

表 55.42. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-manageable

提供当前处于 manageable 状态的所有节点

55.31. overcloud 节点置备

使用 Ironic 置备新节点。

使用方法:

openstack overcloud node provision [-h] [-o OUTPUT] [--stack STACK]
                                          [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                          [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                          [--concurrency CONCURRENCY]
                                          [--timeout TIMEOUT]
                                          <baremetal_deployment.yaml>

表 55.43. positional 参数
概述

<baremetal_deployment.yaml>

描述裸机部署的配置文件

表 55.44. 命令参数
概述

-h, --help

显示帮助信息并退出

-o OUTPUT, --output OUTPUT

输出环境文件路径

--stack STACK

heat 堆栈的名称或 id (default=env: OVERCLOUD_STACK_NAME)

--overcloud-ssh-user OVERCLOUD_SSH_USER

用于 ssh 访问新部署的节点的用户

--overcloud-ssh-key OVERCLOUD_SSH_KEY

对 overcloud 节点的 ssh 访问的关键路径。当未定义 keywill 时,会自动探测到密钥时。

--concurrency CONCURRENCY

要一次置备的最大节点数。(默认值=20)

--timeout TIMEOUT

等待节点置备完成的秒数。(default=3600)

55.32. overcloud 节点取消置备

使用 Ironic 取消置备节点。

使用方法:

openstack overcloud node unprovision [-h] [--stack STACK] [--all] [-y]
                                            <baremetal_deployment.yaml>

表 55.45. positional 参数
概述

<baremetal_deployment.yaml>

描述裸机部署的配置文件

表 55.46. 命令参数
概述

-h, --help

显示帮助信息并退出

--stack STACK

heat 堆栈的名称或 id (default=env: OVERCLOUD_STACK_NAME)

--all

取消置备部署中的每个实例

-y, --yes

跳过是/无提示(假设是)

55.33. overcloud 参数集

为计划设置参数

使用方法:

openstack overcloud parameters set [-h] name file_in

表 55.47. positional 参数
概述

name

计划的名称,用于 swift 容器、Mistral 环境和 Heat 堆栈名称。

file_in

None

表 55.48. 命令参数
概述

-h, --help

显示帮助信息并退出

55.34. overcloud 计划创建

创建部署计划

使用方法:

openstack overcloud plan create [-h] [--templates TEMPLATES]
                                       [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                       [--disable-password-generation]
                                       [--source-url SOURCE_URL]
                                       name

表 55.49. positional 参数
概述

name

计划的名称,用于对象存储容器、工作流环境和监控堆栈名称。

表 55.50. 命令参数
概述

-h, --help

显示帮助信息并退出

--templates TEMPLATES

要部署的 heat 模板的目录。如果没有提供此或 --source_url,则使用 undercloud 上打包的模板。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

计划环境文件,覆盖 --templates 目录中的默认 plan- environment.yaml

--disable-password-generation

禁用密码生成。

--source-url SOURCE_URL

包含要部署的 heat 模板的 git 存储库的 url。如果没有提供此或 --templates,则使用 undercloud 上打包的模板。

55.35. overcloud 计划删除

删除 overcloud 部署计划。如果堆栈具有相同名称的堆栈,则不会删除计划。

使用方法:

openstack overcloud plan delete [-h] <name> [<name> ...]

表 55.51. positional 参数
概述

<name>

要删除的计划的名称

表 55.52. 命令参数
概述

-h, --help

显示帮助信息并退出

55.36. Overcloud 计划部署

部署部署计划

使用方法:

openstack overcloud plan deploy [-h] [--timeout <TIMEOUT>]
                                       [--run-validations]
                                       name

表 55.53. positional 参数
概述

name

要部署的计划名称。

表 55.54. 命令参数
概述

-h, --help

显示帮助信息并退出

--timeout <TIMEOUT>, -t <TIMEOUT>

部署超时(以分钟为单位)。

--run-validations

运行部署前验证。这些外部验证来自 TripleO Validations 项目。

55.37. Overcloud 计划导出

导出部署计划

使用方法:

openstack overcloud plan export [-h] [--output-file <output file>]
                                       [--force-overwrite]
                                       <name>

表 55.55. positional 参数
概述

<name>

要导出的计划的名称。

表 55.56. 命令参数
概述

-h, --help

显示帮助信息并退出

--output-file <output file>, -o <output file>

导出的输出文件的名称。它将默认为 "<name>.tar.gz"。

--force-overwrite, -f

如果输出文件存在,则覆盖它。

55.38. overcloud 计划列表

列出 overcloud 部署计划。

使用方法:

openstack overcloud plan list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]

表 55.57. 命令参数
概述

-h, --help

显示帮助信息并退出

表 55.58. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 55.59. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 55.60. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 55.61. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

55.39. overcloud 配置集列表

列出 overcloud 节点配置集

使用方法:

openstack overcloud profiles list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN] [--all]
                                         [--control-scale CONTROL_SCALE]
                                         [--compute-scale COMPUTE_SCALE]
                                         [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                         [--block-storage-scale BLOCK_STORAGE_SCALE]
                                         [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                         [--control-flavor CONTROL_FLAVOR]
                                         [--compute-flavor COMPUTE_FLAVOR]
                                         [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                         [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                         [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]

表 55.62. 命令参数
概述

-h, --help

显示帮助信息并退出

--all

列出所有节点,甚至它们不可供 nova 使用。

--control-scale CONTROL_SCALE

新的控制节点数量。

--compute-scale COMPUTE_SCALE

新节点的新数量。

--ceph-storage-scale CEPH_STORAGE_SCALE

新数量的 ceph 存储节点。

--block-storage-scale BLOCK_STORAGE_SCALE

Cinder 存储节点的新数量。

--swift-storage-scale SWIFT_STORAGE_SCALE

swift 存储节点的新数量。

--control-flavor CONTROL_FLAVOR

用于控制节点的 Nova 类别。

--compute-flavor COMPUTE_FLAVOR

用于计算节点的 Nova 类别。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

用于 ceph 存储节点的 Nova 类别。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

用于 Cinder 存储节点的 Nova 类别

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

用于 swift 存储节点的 Nova 类别

表 55.63. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 55.64. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 55.65. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 55.66. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

55.40. Overcloud 配置集匹配

在节点上分配和验证配置集

使用方法:

openstack overcloud profiles match [-h] [--dry-run]
                                          [--control-scale CONTROL_SCALE]
                                          [--compute-scale COMPUTE_SCALE]
                                          [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                          [--block-storage-scale BLOCK_STORAGE_SCALE]
                                          [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                          [--control-flavor CONTROL_FLAVOR]
                                          [--compute-flavor COMPUTE_FLAVOR]
                                          [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                          [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                          [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]

表 55.67. 命令参数
概述

-h, --help

显示帮助信息并退出

--dry-run

仅运行验证,但不应用任何更改。

--control-scale CONTROL_SCALE

新的控制节点数量。

--compute-scale COMPUTE_SCALE

新节点的新数量。

--ceph-storage-scale CEPH_STORAGE_SCALE

新数量的 ceph 存储节点。

--block-storage-scale BLOCK_STORAGE_SCALE

Cinder 存储节点的新数量。

--swift-storage-scale SWIFT_STORAGE_SCALE

swift 存储节点的新数量。

--control-flavor CONTROL_FLAVOR

用于控制节点的 Nova 类别。

--compute-flavor COMPUTE_FLAVOR

用于计算节点的 Nova 类别。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

用于 ceph 存储节点的 Nova 类别。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

用于 Cinder 存储节点的 Nova 类别

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

用于 swift 存储节点的 Nova 类别

55.41. overcloud raid create

在给定节点上创建 RAID

使用方法:

openstack overcloud raid create [-h] --node NODE configuration

表 55.68. positional 参数
概述

配置

RAID 配置(yaml/json 字符串或文件名)。

表 55.69. 命令参数
概述

-h, --help

显示帮助信息并退出

--node NODE

在 上创建 raid 的节点(预期处于 manageable 状态)。可多次指定。

55.42. overcloud 角色列表

列出可用的角色(DEPRECATED)。请使用 "openstack overcloud roles list" 替代。

使用方法:

openstack overcloud role list [-h] [--roles-path <roles directory>]

表 55.70. 命令参数
概述

-h, --help

显示帮助信息并退出

--roles-path <roles directory>

包含角色 yaml 文件的文件系统路径。默认情况下,这是 /usr/share/openstack-tripleo-heat- templates/roles

55.43. overcloud 角色演示

显示有关给定角色(DEPRECATED)的信息。请使用 "openstack overcloud roles show" intead。

使用方法:

openstack overcloud role show [-h] [--roles-path <roles directory>]
                                     <role>

表 55.71. positional 参数
概述

<role>

显示有关的更多信息的角色。

表 55.72. 命令参数
概述

-h, --help

显示帮助信息并退出

--roles-path <roles directory>

包含角色 yaml 文件的文件系统路径。默认情况下,这是 /usr/share/openstack-tripleo-heat- templates/roles

55.44. overcloud 角色生成

生成 roles_data.yaml 文件

使用方法:

openstack overcloud roles generate [-h]
                                          [--roles-path <roles directory>]
                                          [-o <output file>] [--skip-validate]
                                          <role> [<role> ...]

表 55.73. positional 参数
概述

<role>

用于为部署生成 roles_data.yaml 文件的角色列表。注意:如果没有角色具有"主"和"控制器"标签,则顺序非常重要。如果没有标记角色,则列出的第一个角色将被视为主要角色。这通常是控制器角色。

表 55.74. 命令参数
概述

-h, --help

显示帮助信息并退出

--roles-path <roles directory>

包含角色 yaml 文件的文件系统路径。默认情况下,这是 /usr/share/openstack-tripleo-heat- templates/roles

-o <output file>, --output-file <output file>

捕获所有输出的文件,例如 roles_data.yaml

--skip-validate

在生成 roles_data.yaml 时跳过角色元数据类型验证

55.45. Overcloud 角色列表

列出给定计划中的当前和可用角色

使用方法:

openstack overcloud roles list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--name NAME] [--detail] [--current]

表 55.75. 命令参数
概述

-h, --help

显示帮助信息并退出

--name NAME

计划的名称,用于对象存储容器、工作流环境和监控堆栈名称。

--detail

包括每个角色的详情

--current

仅显示目前为计划启用的角色的信息。

表 55.76. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 55.77. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 55.78. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 55.79. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

55.46. Overcloud 角色显示

显示特定角色的详情,给出一个计划

使用方法:

openstack overcloud roles show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--name NAME]
                                      <role>

表 55.80. positional 参数
概述

<role>

要查找的角色的名称。

表 55.81. 命令参数
概述

-h, --help

显示帮助信息并退出

--name NAME

计划的名称,用于对象存储容器、工作流环境和监控堆栈名称。

表 55.82. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 55.83. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 55.84. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 55.85. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

55.47. overcloud 状态

获取部署状态

使用方法:

openstack overcloud status [-h] [--plan PLAN]

表 55.86. 命令参数
概述

-h, --help

显示帮助信息并退出

--plan PLAN, --stack PLAN

堆栈/计划的名称(默认:overcloud)

55.48. Overcloud 支持报告收集

在所选服务器上运行 sosreport。

使用方法:

openstack overcloud support report collect [-h] [-c] [-o DESTINATION]
                                                  [--stack STACK]
                                                  [--skip-container-delete]
                                                  [-t TIMEOUT]
                                                  [-n CONCURRENCY]
                                                  [--collect-only | --download-only]
                                                  [-v VERBOSITY]
                                                  server_name

表 55.87. positional 参数
概述

server_name

要匹配的服务器名称、组名称或部分名称。例如"Controller"将匹配环境的所有控制器。

表 55.88. 命令参数
概述

-h, --help

显示帮助信息并退出

-c,--container

弃用:将日志存储到的 swift 容器

-o DESTINATION, --output DESTINATION

报告输出目录

--stack STACK

用于日志收集的堆栈名称。

--skip-container-delete

弃用:在下载文件后不会删除容器。如果提供了 --collect-only 或 --download-only,则忽略。

-t TIMEOUT, --timeout TIMEOUT

等待日志收集和容器删除工作流完成的最长时间。

-n CONCURRENCY, --concurrency CONCURRENCY

要运行的并行日志集合和对象删除任务的数量。

--collect-only

弃用:跳过日志下载,只收集日志并放入容器中

--download-only

弃用:跳过生成,只从提供的容器下载

-v VERBOSITY, --verbose VERBOSITY

None

55.49. overcloud 更新聚合

聚合 Overcloud 节点上的更新。这会恢复计划和堆栈,以便恢复正常部署工作流。

使用方法:

openstack overcloud update converge [--templates [TEMPLATES]]
                                           [--stack STACK]
                                           [--timeout <TIMEOUT>]
                                           [--control-scale CONTROL_SCALE]
                                           [--compute-scale COMPUTE_SCALE]
                                           [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                           [--block-storage-scale BLOCK_STORAGE_SCALE]
                                           [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                           [--control-flavor CONTROL_FLAVOR]
                                           [--compute-flavor COMPUTE_FLAVOR]
                                           [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                           [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                           [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                           [--libvirt-type {kvm,qemu}]
                                           [--ntp-server NTP_SERVER]
                                           [--no-proxy NO_PROXY]
                                           [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                           [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                           [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                           [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT]
                                           [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]
                                           [--environment-file <HEAT ENVIRONMENT FILE>]
                                           [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                           [--roles-file ROLES_FILE]
                                           [--networks-file NETWORKS_FILE]
                                           [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                           [--no-cleanup] [--update-plan-only]
                                           [--validation-errors-nonfatal]
                                           [--validation-warnings-fatal]
                                           [--disable-validations]
                                           [--inflight-validations]
                                           [--dry-run] [--run-validations]
                                           [--skip-postconfig]
                                           [--force-postconfig]
                                           [--skip-deploy-identifier]
                                           [--answers-file ANSWERS_FILE]
                                           [--disable-password-generation]
                                           [--deployed-server]
                                           [--config-download]
                                           [--no-config-download]
                                           [--config-download-only]
                                           [--output-dir OUTPUT_DIR]
                                           [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                           [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                           [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                           [-b <baremetal_deployment.yaml>]
                                           [--limit LIMIT] [--tags TAGS]
                                           [--skip-tags SKIP_TAGS]
                                           [--ansible-forks ANSIBLE_FORKS]
                                           [-y]

表 55.89. 命令参数
概述

--templates [TEMPLATES]

要部署的 heat 模板的目录

--stack STACK

创建或更新的堆栈名称

--timeout <TIMEOUT>, -t <TIMEOUT>

部署超时(以分钟为单位)。

--control-scale CONTROL_SCALE

新节点数量(已弃用)。使用环境文件并设置参数 ControllerCount。这个选项将在"U"发行版本中删除。

--compute-scale COMPUTE_SCALE

新节点的新数量(已弃用)。使用环境文件并设置参数 ComputeCount。这个选项将在"U"发行版本中删除。

--ceph-storage-scale CEPH_STORAGE_SCALE

新的 ceph 存储节点数量(已弃用)。使用环境文件并设置参数 CephStorageCount。这个选项将在"U"发行版本中删除。

--block-storage-scale BLOCK_STORAGE_SCALE

新的 cinder 存储节点数量(已弃用)。使用环境文件并设置参数 BlockStorageCount。这个选项将在"U"发行版本中删除。

--swift-storage-scale SWIFT_STORAGE_SCALE

新的 swift 存储节点数量(已弃用)。使用环境文件并设置参数 ObjectStorageCount。这个选项将在"U"发行版本中删除。

--control-flavor CONTROL_FLAVOR

用于控制节点的 Nova 类别(已弃用)。使用环境文件并设置参数 OvercloudControlFlavor。这个选项将在"U"发行版本中删除。

--compute-flavor COMPUTE_FLAVOR

用于计算节点的 Nova 类别(已弃用)。使用环境文件并设置参数 OvercloudComputeFlavor。这个选项将在"U"发行版本中删除。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

用于 ceph 存储节点的 Nova 类别。(已弃用)。使用环境文件并设置参数 OvercloudCephStorageFlavor。这个选项将在"U"发行版本中删除。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

用于 Cinder 存储节点(DEPRECATED 的 Nova 类别。使用环境文件并设置参数 OvercloudBlockStorageFlavor。这个选项将在"U"发行版本中删除。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

用于 swift 存储节点的 Nova 类别(DEPRECATED。使用环境文件并设置参数 OvercloudSwiftStorageFlavor。这个选项将在"U"发行版本中删除。

--libvirt-type {kvm,qemu}

libvirt 域类型。

--ntp-server NTP_SERVER

overcloud 节点的 ntp。

--no-proxy NO_PROXY

不应代理的以逗号分隔的主机列表。

--overcloud-ssh-user OVERCLOUD_SSH_USER

用于 ssh 访问 overcloud 节点的用户

--overcloud-ssh-key OVERCLOUD_SSH_KEY

用于 ssh 访问 overcloud 节点的关键路径。当定义密钥将被自动探测到时。

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

用于 ssh 访问 overcloud 节点的网络名称。

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

ssh 启用进程的超时时间完成。

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

等待 ssh 端口处于活跃状态的超时时间。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

要传递给 heat stack-create 或 heat stack-update 命令的环境文件。(可多次指定。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

自动添加到 heat stack-create 或 heat stack-update 命令的环境文件目录。可以多次指定。目录中的文件以升序顺序加载。

--roles-file ROLES_FILE, -r ROLES_FILE

角色文件,覆盖 --templates 目录中的默认 roles_data.yaml。可以是绝对路径或相对于 --templates 的路径

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

网络文件,覆盖 --templates 目录中的默认 network_data.yaml

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

计划环境文件,覆盖 --templates 目录中的默认 plan- environment.yaml

--no-cleanup

不要清理临时文件,只记录其位置

--update-plan-only

仅更新计划。请勿执行实际部署。注意:将在以后的版本中移至离散命令。

--validation-errors-nonfatal

即使验证错误,允许部署继续。请注意,在存在错误时尝试部署可能会失败。

--validation-warnings-fatal

如果配置预检查出现警告,则退出。

--disable-validations

弃用。完全禁用部署前验证。这些验证是内置预部署验证。要从 tripleo-validations 启用外部验证,请使用 --run-validations 标志。这些验证现在通过 tripleo-validations 中的外部验证运行。

--inflight-validations

在部署期间激活动态验证。动态验证提供了一种强大的方法,以确保部署的服务在激活后运行。默认值为 False。

--dry-run

仅运行验证,但不应用任何更改。

--run-validations

从 tripleo-validations 项目运行外部验证。

--skip-postconfig

跳过 overcloud 部署后配置。

--force-postconfig

强制进行 overcloud 部署后配置。

--skip-deploy-identifier

跳过为 DeployIdentifier 参数生成唯一标识符。只有在配置实际更改时,才会触发软件配置部署步骤。这个选项应当与 Caution 一起使用,只有在认为软件配置不需要运行时才需要运行,比如在扩展某些角色时。

--answers-file ANSWERS_FILE

到带有参数和参数的 yaml 文件的路径。

--disable-password-generation

禁用密码生成。

--deployed-server

使用预置备的 overcloud 节点。从 undercloud 节点中删除 baremetal、compute 和镜像服务要求。只能与-- disable-validations 一起使用。

--config-download

通过 config-download 机制运行部署。现在这是默认设置,以后可能会删除此 CLI 选项。

--no-config-download, --stack-only

禁用 config-download 工作流,仅创建堆栈和相关 OpenStack 资源。不会应用软件配置。

--config-download-only

禁用堆栈创建/更新,并且仅运行 config-download 工作流以应用软件配置。

--output-dir OUTPUT_DIR

使用 --config- download 时用于保存输出的目录。该目录必须可由 mistral 用户写入。如果没有指定,则使用默认的服务器端值(/var/lib/mistral/<execution id>。

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

ansible 配置文件的路径。该文件中的配置将覆盖默认覆盖 config-download 使用的任何配置。

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

用于 config-download 步骤的超时(以分钟为单位)。如果未设置,则在堆栈操作后,将从 --timeout 参数保留大量时间。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

用于部署操作的 python 解释器的路径。如果在 python3 系统的 python2 主机上部署,或者反之之,则可能需要使用它。

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

描述裸机部署的配置文件

--limit LIMIT

标识单个节点或以逗号分隔的节点列表的字符串,config-download Ansible playbook 执行将限制为。例如:--limit "compute-0,compute-1,compute-5"。

--tags TAGS

运行 config-download ansible-playbook 命令时使用的标签列表。

--skip-tags SKIP_TAGS

运行 config- download ansible-playbook 命令时要跳过的标签列表。

--ansible-forks ANSIBLE_FORKS

用于 config- download ansible-playbook 命令的 ansible fork 数量。

-y, --yes

使用 -y 或 --yes 跳过任何更新操作前所需的确认。请谨慎使用这个选项!

55.50. overcloud 更新准备

为 overcloud 节点运行 heat 堆栈更新,以刷新 heat 堆栈输出。稍后使用 heat 堆栈输出来生成 ansible playbook,它提供次要更新工作流。这作为 overcloud 次要更新的第一步。

使用方法:

openstack overcloud update prepare [--templates [TEMPLATES]]
                                          [--stack STACK]
                                          [--timeout <TIMEOUT>]
                                          [--control-scale CONTROL_SCALE]
                                          [--compute-scale COMPUTE_SCALE]
                                          [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                          [--block-storage-scale BLOCK_STORAGE_SCALE]
                                          [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                          [--control-flavor CONTROL_FLAVOR]
                                          [--compute-flavor COMPUTE_FLAVOR]
                                          [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                          [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                          [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                          [--libvirt-type {kvm,qemu}]
                                          [--ntp-server NTP_SERVER]
                                          [--no-proxy NO_PROXY]
                                          [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                          [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                          [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                          [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT]
                                          [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]
                                          [--environment-file <HEAT ENVIRONMENT FILE>]
                                          [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                          [--roles-file ROLES_FILE]
                                          [--networks-file NETWORKS_FILE]
                                          [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                          [--no-cleanup] [--update-plan-only]
                                          [--validation-errors-nonfatal]
                                          [--validation-warnings-fatal]
                                          [--disable-validations]
                                          [--inflight-validations] [--dry-run]
                                          [--run-validations]
                                          [--skip-postconfig]
                                          [--force-postconfig]
                                          [--skip-deploy-identifier]
                                          [--answers-file ANSWERS_FILE]
                                          [--disable-password-generation]
                                          [--deployed-server]
                                          [--config-download]
                                          [--no-config-download]
                                          [--config-download-only]
                                          [--output-dir OUTPUT_DIR]
                                          [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                          [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                          [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                          [-b <baremetal_deployment.yaml>]
                                          [--limit LIMIT] [--tags TAGS]
                                          [--skip-tags SKIP_TAGS]
                                          [--ansible-forks ANSIBLE_FORKS] [-y]

表 55.90. 命令参数
概述

--templates [TEMPLATES]

要部署的 heat 模板的目录

--stack STACK

创建或更新的堆栈名称

--timeout <TIMEOUT>, -t <TIMEOUT>

部署超时(以分钟为单位)。

--control-scale CONTROL_SCALE

新节点数量(已弃用)。使用环境文件并设置参数 ControllerCount。这个选项将在"U"发行版本中删除。

--compute-scale COMPUTE_SCALE

新节点的新数量(已弃用)。使用环境文件并设置参数 ComputeCount。这个选项将在"U"发行版本中删除。

--ceph-storage-scale CEPH_STORAGE_SCALE

新的 ceph 存储节点数量(已弃用)。使用环境文件并设置参数 CephStorageCount。这个选项将在"U"发行版本中删除。

--block-storage-scale BLOCK_STORAGE_SCALE

新的 cinder 存储节点数量(已弃用)。使用环境文件并设置参数 BlockStorageCount。这个选项将在"U"发行版本中删除。

--swift-storage-scale SWIFT_STORAGE_SCALE

新的 swift 存储节点数量(已弃用)。使用环境文件并设置参数 ObjectStorageCount。这个选项将在"U"发行版本中删除。

--control-flavor CONTROL_FLAVOR

用于控制节点的 Nova 类别(已弃用)。使用环境文件并设置参数 OvercloudControlFlavor。这个选项将在"U"发行版本中删除。

--compute-flavor COMPUTE_FLAVOR

用于计算节点的 Nova 类别(已弃用)。使用环境文件并设置参数 OvercloudComputeFlavor。这个选项将在"U"发行版本中删除。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

用于 ceph 存储节点的 Nova 类别。(已弃用)。使用环境文件并设置参数 OvercloudCephStorageFlavor。这个选项将在"U"发行版本中删除。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

用于 Cinder 存储节点(DEPRECATED 的 Nova 类别。使用环境文件并设置参数 OvercloudBlockStorageFlavor。这个选项将在"U"发行版本中删除。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

用于 swift 存储节点的 Nova 类别(DEPRECATED。使用环境文件并设置参数 OvercloudSwiftStorageFlavor。这个选项将在"U"发行版本中删除。

--libvirt-type {kvm,qemu}

libvirt 域类型。

--ntp-server NTP_SERVER

overcloud 节点的 ntp。

--no-proxy NO_PROXY

不应代理的以逗号分隔的主机列表。

--overcloud-ssh-user OVERCLOUD_SSH_USER

用于 ssh 访问 overcloud 节点的用户

--overcloud-ssh-key OVERCLOUD_SSH_KEY

用于 ssh 访问 overcloud 节点的关键路径。当定义密钥将被自动探测到时。

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

用于 ssh 访问 overcloud 节点的网络名称。

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

ssh 启用进程的超时时间完成。

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

等待 ssh 端口处于活跃状态的超时时间。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

要传递给 heat stack-create 或 heat stack-update 命令的环境文件。(可多次指定。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

自动添加到 heat stack-create 或 heat stack-update 命令的环境文件目录。可以多次指定。目录中的文件以升序顺序加载。

--roles-file ROLES_FILE, -r ROLES_FILE

角色文件,覆盖 --templates 目录中的默认 roles_data.yaml。可以是绝对路径或相对于 --templates 的路径

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

网络文件,覆盖 --templates 目录中的默认 network_data.yaml

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

计划环境文件,覆盖 --templates 目录中的默认 plan- environment.yaml

--no-cleanup

不要清理临时文件,只记录其位置

--update-plan-only

仅更新计划。请勿执行实际部署。注意:将在以后的版本中移至离散命令。

--validation-errors-nonfatal

即使验证错误,允许部署继续。请注意,在存在错误时尝试部署可能会失败。

--validation-warnings-fatal

如果配置预检查出现警告,则退出。

--disable-validations

弃用。完全禁用部署前验证。这些验证是内置预部署验证。要从 tripleo-validations 启用外部验证,请使用 --run-validations 标志。这些验证现在通过 tripleo-validations 中的外部验证运行。

--inflight-validations

在部署期间激活动态验证。动态验证提供了一种强大的方法,以确保部署的服务在激活后运行。默认值为 False。

--dry-run

仅运行验证,但不应用任何更改。

--run-validations

从 tripleo-validations 项目运行外部验证。

--skip-postconfig

跳过 overcloud 部署后配置。

--force-postconfig

强制进行 overcloud 部署后配置。

--skip-deploy-identifier

跳过为 DeployIdentifier 参数生成唯一标识符。只有在配置实际更改时,才会触发软件配置部署步骤。这个选项应当与 Caution 一起使用,只有在认为软件配置不需要运行时才需要运行,比如在扩展某些角色时。

--answers-file ANSWERS_FILE

到带有参数和参数的 yaml 文件的路径。

--disable-password-generation

禁用密码生成。

--deployed-server

使用预置备的 overcloud 节点。从 undercloud 节点中删除 baremetal、compute 和镜像服务要求。只能与-- disable-validations 一起使用。

--config-download

通过 config-download 机制运行部署。现在这是默认设置,以后可能会删除此 CLI 选项。

--no-config-download, --stack-only

禁用 config-download 工作流,仅创建堆栈和相关 OpenStack 资源。不会应用软件配置。

--config-download-only

禁用堆栈创建/更新,并且仅运行 config-download 工作流以应用软件配置。

--output-dir OUTPUT_DIR

使用 --config- download 时用于保存输出的目录。该目录必须可由 mistral 用户写入。如果没有指定,则使用默认的服务器端值(/var/lib/mistral/<execution id>。

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

ansible 配置文件的路径。该文件中的配置将覆盖默认覆盖 config-download 使用的任何配置。

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

用于 config-download 步骤的超时(以分钟为单位)。如果未设置,则在堆栈操作后,将从 --timeout 参数保留大量时间。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

用于部署操作的 python 解释器的路径。如果在 python3 系统的 python2 主机上部署,或者反之之,则可能需要使用它。

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

描述裸机部署的配置文件

--limit LIMIT

标识单个节点或以逗号分隔的节点列表的字符串,config-download Ansible playbook 执行将限制为。例如:--limit "compute-0,compute-1,compute-5"。

--tags TAGS

运行 config-download ansible-playbook 命令时使用的标签列表。

--skip-tags SKIP_TAGS

运行 config- download ansible-playbook 命令时要跳过的标签列表。

--ansible-forks ANSIBLE_FORKS

用于 config- download ansible-playbook 命令的 ansible fork 数量。

-y, --yes

使用 -y 或 --yes 跳过任何更新操作前所需的确认。请谨慎使用这个选项!

55.51. Overcloud 更新运行

在 Overcloud 节点上运行次要更新 ansible playbook

使用方法:

openstack overcloud update run [-h] --limit LIMIT [--playbook PLAYBOOK]
                                      [--ssh-user SSH_USER]
                                      [--static-inventory STATIC_INVENTORY]
                                      [--stack STACK] [--no-workflow]
                                      [--tags TAGS] [--skip-tags SKIP_TAGS]
                                      [-y] [--ansible-forks ANSIBLE_FORKS]

表 55.91. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT

标识单个节点或以逗号分隔的节点列表的字符串,config-download Ansible playbook 执行将限制为。例如:--limit "compute-0,compute-1,compute-5"。

--playbook PLAYBOOK

用于次要更新的 Ansible playbook。默认为 all 的特殊值,这会导致执行所有更新 playbook。这是 update_steps_playbook.yaml,然后是deploy_steps_playbook.yaml。如果您希望手动运行,请将此选项设置为连续调用这些命令中的每个 playbook。注:确保同时运行这些 playbook,以便使用目标版本配置更新并运行所有服务。

--ssh-user SSH_USER

已弃用:只有 tripleo-admin 应用作 ssh 用户。

--static-inventory STATIC_INVENTORY

要使用的现有 ansible 清单的路径。如果没有指定,则会在 ~/tripleo-ansible- inventory.yaml 中生成一个

--stack STACK

heat 堆栈的名称或 id (default=env: OVERCLOUD_STACK_NAME)

--no-workflow

直接通过系统命令运行 ansible-playbook,而不是通过 TripleO mistral 工作流运行 Ansible。

--tags TAGS

运行 config-download ansible-playbook 命令时使用的标签列表。

--skip-tags SKIP_TAGS

运行 config- download ansible-playbook 命令时要跳过的标签列表。

-y, --yes

使用 -y 或 --yes 跳过任何更新操作前所需的确认。请谨慎使用这个选项!

--ansible-forks ANSIBLE_FORKS

用于 config- download ansible-playbook 命令的 ansible fork 数量。

55.52. overcloud 升级聚合

主要升级聚合 - 在存储的计划中重置 Heat 资源,这是完成 overcloud 主要升级的最后一步。主要任务更新计划和堆栈,以取消阻塞将来的堆栈更新。对于主要升级工作流,我们为某些堆栈 Heat 资源设置了特定值。这会取消设置它们的默认值。

使用方法:

openstack overcloud upgrade converge [--templates [TEMPLATES]]
                                            [--stack STACK]
                                            [--timeout <TIMEOUT>]
                                            [--control-scale CONTROL_SCALE]
                                            [--compute-scale COMPUTE_SCALE]
                                            [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                            [--block-storage-scale BLOCK_STORAGE_SCALE]
                                            [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                            [--control-flavor CONTROL_FLAVOR]
                                            [--compute-flavor COMPUTE_FLAVOR]
                                            [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                            [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                            [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                            [--libvirt-type {kvm,qemu}]
                                            [--ntp-server NTP_SERVER]
                                            [--no-proxy NO_PROXY]
                                            [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                            [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                            [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                            [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT]
                                            [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]
                                            [--environment-file <HEAT ENVIRONMENT FILE>]
                                            [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                            [--roles-file ROLES_FILE]
                                            [--networks-file NETWORKS_FILE]
                                            [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                            [--no-cleanup]
                                            [--update-plan-only]
                                            [--validation-errors-nonfatal]
                                            [--validation-warnings-fatal]
                                            [--disable-validations]
                                            [--inflight-validations]
                                            [--dry-run] [--run-validations]
                                            [--skip-postconfig]
                                            [--force-postconfig]
                                            [--skip-deploy-identifier]
                                            [--answers-file ANSWERS_FILE]
                                            [--disable-password-generation]
                                            [--deployed-server]
                                            [--config-download]
                                            [--no-config-download]
                                            [--config-download-only]
                                            [--output-dir OUTPUT_DIR]
                                            [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                            [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                            [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                            [-b <baremetal_deployment.yaml>]
                                            [--limit LIMIT] [--tags TAGS]
                                            [--skip-tags SKIP_TAGS]
                                            [--ansible-forks ANSIBLE_FORKS]
                                            [-y]

表 55.92. 命令参数
概述

--templates [TEMPLATES]

要部署的 heat 模板的目录

--stack STACK

创建或更新的堆栈名称

--timeout <TIMEOUT>, -t <TIMEOUT>

部署超时(以分钟为单位)。

--control-scale CONTROL_SCALE

新节点数量(已弃用)。使用环境文件并设置参数 ControllerCount。这个选项将在"U"发行版本中删除。

--compute-scale COMPUTE_SCALE

新节点的新数量(已弃用)。使用环境文件并设置参数 ComputeCount。这个选项将在"U"发行版本中删除。

--ceph-storage-scale CEPH_STORAGE_SCALE

新的 ceph 存储节点数量(已弃用)。使用环境文件并设置参数 CephStorageCount。这个选项将在"U"发行版本中删除。

--block-storage-scale BLOCK_STORAGE_SCALE

新的 cinder 存储节点数量(已弃用)。使用环境文件并设置参数 BlockStorageCount。这个选项将在"U"发行版本中删除。

--swift-storage-scale SWIFT_STORAGE_SCALE

新的 swift 存储节点数量(已弃用)。使用环境文件并设置参数 ObjectStorageCount。这个选项将在"U"发行版本中删除。

--control-flavor CONTROL_FLAVOR

用于控制节点的 Nova 类别(已弃用)。使用环境文件并设置参数 OvercloudControlFlavor。这个选项将在"U"发行版本中删除。

--compute-flavor COMPUTE_FLAVOR

用于计算节点的 Nova 类别(已弃用)。使用环境文件并设置参数 OvercloudComputeFlavor。这个选项将在"U"发行版本中删除。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

用于 ceph 存储节点的 Nova 类别。(已弃用)。使用环境文件并设置参数 OvercloudCephStorageFlavor。这个选项将在"U"发行版本中删除。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

用于 Cinder 存储节点(DEPRECATED 的 Nova 类别。使用环境文件并设置参数 OvercloudBlockStorageFlavor。这个选项将在"U"发行版本中删除。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

用于 swift 存储节点的 Nova 类别(DEPRECATED。使用环境文件并设置参数 OvercloudSwiftStorageFlavor。这个选项将在"U"发行版本中删除。

--libvirt-type {kvm,qemu}

libvirt 域类型。

--ntp-server NTP_SERVER

overcloud 节点的 ntp。

--no-proxy NO_PROXY

不应代理的以逗号分隔的主机列表。

--overcloud-ssh-user OVERCLOUD_SSH_USER

用于 ssh 访问 overcloud 节点的用户

--overcloud-ssh-key OVERCLOUD_SSH_KEY

用于 ssh 访问 overcloud 节点的关键路径。当定义密钥将被自动探测到时。

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

用于 ssh 访问 overcloud 节点的网络名称。

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

ssh 启用进程的超时时间完成。

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

等待 ssh 端口处于活跃状态的超时时间。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

要传递给 heat stack-create 或 heat stack-update 命令的环境文件。(可多次指定。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

自动添加到 heat stack-create 或 heat stack-update 命令的环境文件目录。可以多次指定。目录中的文件以升序顺序加载。

--roles-file ROLES_FILE, -r ROLES_FILE

角色文件,覆盖 --templates 目录中的默认 roles_data.yaml。可以是绝对路径或相对于 --templates 的路径

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

网络文件,覆盖 --templates 目录中的默认 network_data.yaml

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

计划环境文件,覆盖 --templates 目录中的默认 plan- environment.yaml

--no-cleanup

不要清理临时文件,只记录其位置

--update-plan-only

仅更新计划。请勿执行实际部署。注意:将在以后的版本中移至离散命令。

--validation-errors-nonfatal

即使验证错误,允许部署继续。请注意,在存在错误时尝试部署可能会失败。

--validation-warnings-fatal

如果配置预检查出现警告,则退出。

--disable-validations

弃用。完全禁用部署前验证。这些验证是内置预部署验证。要从 tripleo-validations 启用外部验证,请使用 --run-validations 标志。这些验证现在通过 tripleo-validations 中的外部验证运行。

--inflight-validations

在部署期间激活动态验证。动态验证提供了一种强大的方法,以确保部署的服务在激活后运行。默认值为 False。

--dry-run

仅运行验证,但不应用任何更改。

--run-validations

从 tripleo-validations 项目运行外部验证。

--skip-postconfig

跳过 overcloud 部署后配置。

--force-postconfig

强制进行 overcloud 部署后配置。

--skip-deploy-identifier

跳过为 DeployIdentifier 参数生成唯一标识符。只有在配置实际更改时,才会触发软件配置部署步骤。这个选项应当与 Caution 一起使用,只有在认为软件配置不需要运行时才需要运行,比如在扩展某些角色时。

--answers-file ANSWERS_FILE

到带有参数和参数的 yaml 文件的路径。

--disable-password-generation

禁用密码生成。

--deployed-server

使用预置备的 overcloud 节点。从 undercloud 节点中删除 baremetal、compute 和镜像服务要求。只能与-- disable-validations 一起使用。

--config-download

通过 config-download 机制运行部署。现在这是默认设置,以后可能会删除此 CLI 选项。

--no-config-download, --stack-only

禁用 config-download 工作流,仅创建堆栈和相关 OpenStack 资源。不会应用软件配置。

--config-download-only

禁用堆栈创建/更新,并且仅运行 config-download 工作流以应用软件配置。

--output-dir OUTPUT_DIR

使用 --config- download 时用于保存输出的目录。该目录必须可由 mistral 用户写入。如果没有指定,则使用默认的服务器端值(/var/lib/mistral/<execution id>。

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

ansible 配置文件的路径。该文件中的配置将覆盖默认覆盖 config-download 使用的任何配置。

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

用于 config-download 步骤的超时(以分钟为单位)。如果未设置,则在堆栈操作后,将从 --timeout 参数保留大量时间。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

用于部署操作的 python 解释器的路径。如果在 python3 系统的 python2 主机上部署,或者反之之,则可能需要使用它。

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

描述裸机部署的配置文件

--limit LIMIT

标识单个节点或以逗号分隔的节点列表的字符串,config-download Ansible playbook 执行将限制为。例如:--limit "compute-0,compute-1,compute-5"。

--tags TAGS

运行 config-download ansible-playbook 命令时使用的标签列表。

--skip-tags SKIP_TAGS

运行 config- download ansible-playbook 命令时要跳过的标签列表。

--ansible-forks ANSIBLE_FORKS

用于 config- download ansible-playbook 命令的 ansible fork 数量。

-y, --yes

使用 -y 或 --yes 跳过任何升级操作前所需的确认。请谨慎使用这个选项!

55.53. overcloud 升级准备

为 overcloud 节点运行 heat 堆栈更新,以刷新 heat 堆栈输出。稍后使用 heat 堆栈输出来生成 ansible playbook,它提供主要升级工作流。这作为 overcloud 的主要升级的第一步。

使用方法:

openstack overcloud upgrade prepare [--templates [TEMPLATES]]
                                           [--stack STACK]
                                           [--timeout <TIMEOUT>]
                                           [--control-scale CONTROL_SCALE]
                                           [--compute-scale COMPUTE_SCALE]
                                           [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                           [--block-storage-scale BLOCK_STORAGE_SCALE]
                                           [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                           [--control-flavor CONTROL_FLAVOR]
                                           [--compute-flavor COMPUTE_FLAVOR]
                                           [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                           [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                           [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                           [--libvirt-type {kvm,qemu}]
                                           [--ntp-server NTP_SERVER]
                                           [--no-proxy NO_PROXY]
                                           [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                           [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                           [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                           [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT]
                                           [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT]
                                           [--environment-file <HEAT ENVIRONMENT FILE>]
                                           [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                           [--roles-file ROLES_FILE]
                                           [--networks-file NETWORKS_FILE]
                                           [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                           [--no-cleanup] [--update-plan-only]
                                           [--validation-errors-nonfatal]
                                           [--validation-warnings-fatal]
                                           [--disable-validations]
                                           [--inflight-validations]
                                           [--dry-run] [--run-validations]
                                           [--skip-postconfig]
                                           [--force-postconfig]
                                           [--skip-deploy-identifier]
                                           [--answers-file ANSWERS_FILE]
                                           [--disable-password-generation]
                                           [--deployed-server]
                                           [--config-download]
                                           [--no-config-download]
                                           [--config-download-only]
                                           [--output-dir OUTPUT_DIR]
                                           [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                           [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                           [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                           [-b <baremetal_deployment.yaml>]
                                           [--limit LIMIT] [--tags TAGS]
                                           [--skip-tags SKIP_TAGS]
                                           [--ansible-forks ANSIBLE_FORKS]
                                           [-y]

表 55.93. 命令参数
概述

--templates [TEMPLATES]

要部署的 heat 模板的目录

--stack STACK

创建或更新的堆栈名称

--timeout <TIMEOUT>, -t <TIMEOUT>

部署超时(以分钟为单位)。

--control-scale CONTROL_SCALE

新节点数量(已弃用)。使用环境文件并设置参数 ControllerCount。这个选项将在"U"发行版本中删除。

--compute-scale COMPUTE_SCALE

新节点的新数量(已弃用)。使用环境文件并设置参数 ComputeCount。这个选项将在"U"发行版本中删除。

--ceph-storage-scale CEPH_STORAGE_SCALE

新的 ceph 存储节点数量(已弃用)。使用环境文件并设置参数 CephStorageCount。这个选项将在"U"发行版本中删除。

--block-storage-scale BLOCK_STORAGE_SCALE

新的 cinder 存储节点数量(已弃用)。使用环境文件并设置参数 BlockStorageCount。这个选项将在"U"发行版本中删除。

--swift-storage-scale SWIFT_STORAGE_SCALE

新的 swift 存储节点数量(已弃用)。使用环境文件并设置参数 ObjectStorageCount。这个选项将在"U"发行版本中删除。

--control-flavor CONTROL_FLAVOR

用于控制节点的 Nova 类别(已弃用)。使用环境文件并设置参数 OvercloudControlFlavor。这个选项将在"U"发行版本中删除。

--compute-flavor COMPUTE_FLAVOR

用于计算节点的 Nova 类别(已弃用)。使用环境文件并设置参数 OvercloudComputeFlavor。这个选项将在"U"发行版本中删除。

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

用于 ceph 存储节点的 Nova 类别。(已弃用)。使用环境文件并设置参数 OvercloudCephStorageFlavor。这个选项将在"U"发行版本中删除。

--block-storage-flavor BLOCK_STORAGE_FLAVOR

用于 Cinder 存储节点(DEPRECATED 的 Nova 类别。使用环境文件并设置参数 OvercloudBlockStorageFlavor。这个选项将在"U"发行版本中删除。

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

用于 swift 存储节点的 Nova 类别(DEPRECATED。使用环境文件并设置参数 OvercloudSwiftStorageFlavor。这个选项将在"U"发行版本中删除。

--libvirt-type {kvm,qemu}

libvirt 域类型。

--ntp-server NTP_SERVER

overcloud 节点的 ntp。

--no-proxy NO_PROXY

不应代理的以逗号分隔的主机列表。

--overcloud-ssh-user OVERCLOUD_SSH_USER

用于 ssh 访问 overcloud 节点的用户

--overcloud-ssh-key OVERCLOUD_SSH_KEY

用于 ssh 访问 overcloud 节点的关键路径。当定义密钥将被自动探测到时。

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

用于 ssh 访问 overcloud 节点的网络名称。

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

ssh 启用进程的超时时间完成。

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

等待 ssh 端口处于活跃状态的超时时间。

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

要传递给 heat stack-create 或 heat stack-update 命令的环境文件。(可多次指定。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

自动添加到 heat stack-create 或 heat stack-update 命令的环境文件目录。可以多次指定。目录中的文件以升序顺序加载。

--roles-file ROLES_FILE, -r ROLES_FILE

角色文件,覆盖 --templates 目录中的默认 roles_data.yaml。可以是绝对路径或相对于 --templates 的路径

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

网络文件,覆盖 --templates 目录中的默认 network_data.yaml

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

计划环境文件,覆盖 --templates 目录中的默认 plan- environment.yaml

--no-cleanup

不要清理临时文件,只记录其位置

--update-plan-only

仅更新计划。请勿执行实际部署。注意:将在以后的版本中移至离散命令。

--validation-errors-nonfatal

即使验证错误,允许部署继续。请注意,在存在错误时尝试部署可能会失败。

--validation-warnings-fatal

如果配置预检查出现警告,则退出。

--disable-validations

弃用。完全禁用部署前验证。这些验证是内置预部署验证。要从 tripleo-validations 启用外部验证,请使用 --run-validations 标志。这些验证现在通过 tripleo-validations 中的外部验证运行。

--inflight-validations

在部署期间激活动态验证。动态验证提供了一种强大的方法,以确保部署的服务在激活后运行。默认值为 False。

--dry-run

仅运行验证,但不应用任何更改。

--run-validations

从 tripleo-validations 项目运行外部验证。

--skip-postconfig

跳过 overcloud 部署后配置。

--force-postconfig

强制进行 overcloud 部署后配置。

--skip-deploy-identifier

跳过为 DeployIdentifier 参数生成唯一标识符。只有在配置实际更改时,才会触发软件配置部署步骤。这个选项应当与 Caution 一起使用,只有在认为软件配置不需要运行时才需要运行,比如在扩展某些角色时。

--answers-file ANSWERS_FILE

到带有参数和参数的 yaml 文件的路径。

--disable-password-generation

禁用密码生成。

--deployed-server

使用预置备的 overcloud 节点。从 undercloud 节点中删除 baremetal、compute 和镜像服务要求。只能与-- disable-validations 一起使用。

--config-download

通过 config-download 机制运行部署。现在这是默认设置,以后可能会删除此 CLI 选项。

--no-config-download, --stack-only

禁用 config-download 工作流,仅创建堆栈和相关 OpenStack 资源。不会应用软件配置。

--config-download-only

禁用堆栈创建/更新,并且仅运行 config-download 工作流以应用软件配置。

--output-dir OUTPUT_DIR

使用 --config- download 时用于保存输出的目录。该目录必须可由 mistral 用户写入。如果没有指定,则使用默认的服务器端值(/var/lib/mistral/<execution id>。

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

ansible 配置文件的路径。该文件中的配置将覆盖默认覆盖 config-download 使用的任何配置。

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

用于 config-download 步骤的超时(以分钟为单位)。如果未设置,则在堆栈操作后,将从 --timeout 参数保留大量时间。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

用于部署操作的 python 解释器的路径。如果在 python3 系统的 python2 主机上部署,或者反之之,则可能需要使用它。

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

描述裸机部署的配置文件

--limit LIMIT

标识单个节点或以逗号分隔的节点列表的字符串,config-download Ansible playbook 执行将限制为。例如:--limit "compute-0,compute-1,compute-5"。

--tags TAGS

运行 config-download ansible-playbook 命令时使用的标签列表。

--skip-tags SKIP_TAGS

运行 config- download ansible-playbook 命令时要跳过的标签列表。

--ansible-forks ANSIBLE_FORKS

用于 config- download ansible-playbook 命令的 ansible fork 数量。

-y, --yes

使用 -y 或 --yes 跳过任何升级操作前所需的确认。请谨慎使用这个选项!

55.54. Overcloud 升级运行

在 Overcloud 节点上运行主要升级 ansible playbook,这将在 overcloud 上运行主要升级 ansible playbook。默认情况下执行所有 playbook,即 upgrade_steps_playbook.yaml,然后是 deploy_steps_playbook.yaml,然后是 post_upgrade_steps_playbook.yaml。升级 playbook 在 overcloud upgrade prepare 命令完成后可用。此 overcloud upgrade run 命令是主要升级工作流中的第二个步骤。

使用方法:

openstack overcloud upgrade run [-h] --limit LIMIT
                                       [--playbook PLAYBOOK]
                                       [--static-inventory STATIC_INVENTORY]
                                       [--ssh-user SSH_USER] [--tags TAGS]
                                       [--skip-tags SKIP_TAGS] [--stack STACK]
                                       [--no-workflow] [-y]
                                       [--ansible-forks ANSIBLE_FORKS]

表 55.94. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT

标识单个节点或以逗号分隔的节点列表的字符串,config-download Ansible playbook 执行将限制为。例如:--limit "compute-0,compute-1,compute-5"。

--playbook PLAYBOOK

用于主要升级的 Ansible playbook。默认为特殊值 all,这会导致所有升级 playbook 运行。这是 upgrade_steps_playbook.yaml,然后 deploy_steps_playbook.yaml,然后是 post_upgrade_steps_playbook.yaml。如果您希望手动运行,请将此选项设置为连续调用这些命令中的每个 playbook。注: 您必须运行所有这些 playbook,以便所有服务都使用目标版本配置升级并运行。

--static-inventory STATIC_INVENTORY

要使用的现有 ansible 清单的路径。如果没有指定,则会在 ~/tripleo-ansible- inventory.yaml 中生成一个

--ssh-user SSH_USER

已弃用:只有 tripleo-admin 应用作 ssh 用户。

--tags TAGS

指定要作为 --tags 传递给 ansible-playbook 的标签列表或以逗号分隔的标签列表的字符串。

--skip-tags SKIP_TAGS

指定要作为 --skip-tags 传递给 ansible-playbook 的标签列表或以逗号分隔的标签列表的字符串。当前支持的值有 verify pre-upgrade。如果您必须在失败的升级后重新运行且一些服务无法启动,则特定 验证 很有用。

--stack STACK

heat 堆栈的名称或 id (default=env: OVERCLOUD_STACK_NAME)

--no-workflow

直接通过系统命令运行 ansible-playbook,而不是通过 TripleO mistral 工作流运行 Ansible。

-y, --yes

使用 -y 或 --yes 跳过任何升级操作前所需的确认。请谨慎使用这个选项!

--ansible-forks ANSIBLE_FORKS

用于 config- download ansible-playbook 命令的 ansible fork 数量。

第 56 章 policy

本章描述了 policy 命令下的命令。

56.1. 策略创建

创建新策略

使用方法:

openstack policy create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--type <type>]
                               <filename>

表 56.1. positional 参数
概述

<filename>

新的序列化策略规则文件

表 56.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--type <type>

策略规则文件的新 mime 类型(默认为 application/json)

表 56.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 56.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 56.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 56.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

56.2. policy delete

删除策略

使用方法:

openstack policy delete [-h] <policy> [<policy> ...]

表 56.7. positional 参数
概述

<policy>

要删除的策略

表 56.8. 命令参数
概述

-h, --help

显示帮助信息并退出

56.3. 策略列表

列出策略

使用方法:

openstack policy list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--long]

表 56.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 56.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 56.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 56.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 56.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

56.4. 策略集

设置策略属性

使用方法:

openstack policy set [-h] [--type <type>] [--rules <filename>] <policy>

表 56.14. positional 参数
概述

<policy>

要修改的策略

表 56.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--type <type>

策略规则文件的新 mime 类型

--rules <filename>

新的序列化策略规则文件

56.5. 策略显示

显示策略详情

使用方法:

openstack policy show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <policy>

表 56.16. positional 参数
概述

<policy>

要显示的策略

表 56.17. 命令参数
概述

-h, --help

显示帮助信息并退出

表 56.18. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 56.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 56.20. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 56.21. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 57 章 端口

本章描述了 port 命令下的命令。

57.1. 端口创建

创建新端口

使用方法:

openstack port create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] --network <network>
                             [--description <description>]
                             [--device <device-id>]
                             [--mac-address <mac-address>]
                             [--device-owner <device-owner>]
                             [--vnic-type <vnic-type>] [--host <host-id>]
                             [--dns-domain dns-domain] [--dns-name <dns-name>]
                             [--fixed-ip subnet=<subnet>,ip-address=<ip-address> | --no-fixed-ip]
                             [--binding-profile <binding-profile>]
                             [--enable | --disable]
                             [--enable-uplink-status-propagation | --disable-uplink-status-propagation]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--extra-dhcp-option name=<name>[,value=<value>,ip-version={4,6}]]
                             [--security-group <security-group> | --no-security-group]
                             [--qos-policy <qos-policy>]
                             [--enable-port-security | --disable-port-security]
                             [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
                             [--tag <tag> | --no-tag]
                             <name>

表 57.1. positional 参数
概述

<name>

此端口的名称

表 57.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--network <network>

此端口所属的网络(名称或 id)

--description <description>

此端口的描述

--device <device-id>

端口设备 ID

--mac-address <mac-address>

此端口的 MAC 地址(仅限管理员)

--device-owner <device-owner>

此端口的设备所有者。这是使用端口(如 network:dhcp)的实体。

--vnic-type <vnic-type>

此端口的 vNIC 类型(直接 | 直接 | macvtap | normal | baremetal | virtio-forwarder,默认: normal)

--host <host-id>

在主机 <host-id> 上分配端口(仅限id)

--dns-domain dns-domain

将 dns 域设置为此端口(端口需要 dns_domain 扩展)

--dns-name <dns-name>

为此端口设置 dns 名称(需要 dns 集成扩展)

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

此端口所需的 ip 和/或子网:subnet=<subnet>,ip-address=<ip-address> (repeat 选项设置多个固定 IP 地址)

--no-fixed-ip

此端口没有 ip 或 subnet。

--binding-profile <binding-profile>

要传递为 binding:profile 的自定义数据。数据可能会传递为 <key>=<value> 或 JSON。(重复设置多个 binding:profile 数据)

--enable

启用端口(默认)

--disable

禁用端口

--enable-uplink-status-propagation

启用 uplink 状态传播

--disable-uplink-status-propagation

禁用 uplink 状态传播(默认)

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--extra-dhcp-option name=<name>[,value=<value>,ip-version={4,6}]

要分配给此端口的额外 dhcp 选项: name=<name>[,value=<value>,ip-version={4,6}](repeat 选项用来设置多个额外 DHCP 选项)

--security-group <security-group>

与此端口(名称或 ID)关联的安全组(用于设置多个安全组)

--no-security-group

没有安全组与此端口关联

--qos-policy <qos-policy>

将 qos 策略附加到此端口(名称或 id)

--enable-port-security

为此端口启用端口安全性(默认)

--disable-port-security

禁用此端口的端口安全性

--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]

添加与此端口关联的允许地址对:ip-address=<ip-address>[,mac-address=<mac-address>](repeat 选项设置多个允许的地址对)

--tag <tag>

要添加到端口的标签(重复选项来设置多个标签)

--no-tag

没有与端口关联的标签

表 57.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 57.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 57.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 57.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

57.2. 端口删除

删除端口

使用方法:

openstack port delete [-h] <port> [<port> ...]

表 57.7. positional 参数
概述

<port>

要删除的端口(名称或 id)

表 57.8. 命令参数
概述

-h, --help

显示帮助信息并退出

57.3. 端口列表

列出端口

使用方法:

openstack port list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           [--device-owner <device-owner>]
                           [--network <network>]
                           [--router <router> | --server <server> | --device-id <device-id>]
                           [--mac-address <mac-address>] [--long]
                           [--project <project>]
                           [--project-domain <project-domain>]
                           [--fixed-ip subnet=<subnet>,ip-address=<ip-address>,ip-substring=<ip-substring>]
                           [--tags <tag>[,<tag>,...]]
                           [--any-tags <tag>[,<tag>,...]]
                           [--not-tags <tag>[,<tag>,...]]
                           [--not-any-tags <tag>[,<tag>,...]]

表 57.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--device-owner <device-owner>

仅列出具有指定设备所有者的端口。这是使用端口(如 network:dhcp)的实体。

--network <network>

仅列出连接到此网络的端口(名称或 id)

--router <router>

仅列出附加到此路由器的端口(名称或 id)

--server <server>

仅列出附加到此服务器的端口(名称或 id)

--device-id <device-id>

仅列出具有指定设备 ID 的端口

--mac-address <mac-address>

仅列出具有此 mac 地址的端口

--long

列出输出中的其他字段

--project <project>

根据项目(名称或 id)列出端口

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--fixed-ip subnet=<subnet>,ip-address=<ip-address>,ip-substring=<ip-substring>

所需的 ip 和/或子网用于过滤端口(名称或 ID):subnet=<subnet>,ip-address=<ip-address>,ip- substring=<ip-substring> (用于设置多个固定 IP 地址)

--tags <tag>[,<tag>,…​]

列出具有所有给定标签的端口(以逗号分隔的标签列表)

--any-tags <tag>[,<tag>,…​]

列出具有任何给定标签的端口(以逗号分隔的标签列表)

--not-tags <tag>[,<tag>,…​]

排除具有所有给定标签的端口(以逗号分隔的标签列表)

--not-any-tags <tag>[,<tag>,…​]

排除具有任何给定标签的端口(以逗号分隔的标签列表)

表 57.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 57.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 57.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 57.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

57.4. 端口集

设置端口属性

使用方法:

openstack port set [-h] [--description <description>]
                          [--device <device-id>] [--mac-address <mac-address>]
                          [--device-owner <device-owner>]
                          [--vnic-type <vnic-type>] [--host <host-id>]
                          [--dns-domain dns-domain] [--dns-name <dns-name>]
                          [--enable | --disable] [--name <name>]
                          [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
                          [--no-fixed-ip]
                          [--binding-profile <binding-profile>]
                          [--no-binding-profile] [--qos-policy <qos-policy>]
                          [--security-group <security-group>]
                          [--no-security-group]
                          [--enable-port-security | --disable-port-security]
                          [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
                          [--no-allowed-address]
                          [--data-plane-status <status>] [--tag <tag>]
                          [--no-tag]
                          <port>

表 57.14. positional 参数
概述

<port>

要修改的端口(名称或 id)

表 57.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

此端口的描述

--device <device-id>

端口设备 ID

--mac-address <mac-address>

此端口的 MAC 地址(仅限管理员)

--device-owner <device-owner>

此端口的设备所有者。这是使用端口(如 network:dhcp)的实体。

--vnic-type <vnic-type>

此端口的 vNIC 类型(直接 | 直接 | macvtap | normal | baremetal | virtio-forwarder,默认: normal)

--host <host-id>

在主机 <host-id> 上分配端口(仅限id)

--dns-domain dns-domain

将 dns 域设置为此端口(端口需要 dns_domain 扩展)

--dns-name <dns-name>

为此端口设置 dns 名称(需要 dns 集成扩展)

--enable

启用端口

--disable

禁用端口

--name <name>

设置端口名称

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

此端口所需的 ip 和/或子网:subnet=<subnet>,ip-address=<ip-address> (repeat 选项设置多个固定 IP 地址)

--no-fixed-ip

清除固定 ip address.Specify 和 --no-fixed-ip 的现有信息,以覆盖当前的固定 IP 地址。

--binding-profile <binding-profile>

要传递为 binding:profile 的自定义数据。数据可能会传递为 <key>=<value> 或 JSON。(重复设置多个 binding:profile 数据)

--no-binding-profile

清除 binding:profile. 的现有信息。指定 --binding-profile 和 --no-binding-profile,以覆盖当前的 binding:profile 信息。

--qos-policy <qos-policy>

将 qos 策略附加到此端口(名称或 id)

--security-group <security-group>

与此端口(名称或 ID)关联的安全组(用于设置多个安全组)

--no-security-group

清除与此端口关联的现有安全组

--enable-port-security

为此端口启用端口安全性

--disable-port-security

禁用此端口的端口安全性

--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]

添加与此端口关联的允许地址对:ip-address=<ip-address>[,mac-address=<mac-address>](repeat 选项设置多个允许的地址对)

--no-allowed-address

清除与此端口关联的现有允许地址对。(指定 --allowed-address 和 --no- allowed-address,以覆盖当前的允许的地址对)

--data-plane-status <status>

设置此端口的数据平面状态(活跃 | down)。使用 port unset 命令取消设置 None (需要 data plane 状态扩展)

--tag <tag>

要添加到端口的标签(重复选项来设置多个标签)

--no-tag

清除与端口关联的标签。指定 --tag 和 --no-tag 来覆盖当前标签

57.5. 端口显示

显示端口详情

使用方法:

openstack port show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty]
                           <port>

表 57.16. positional 参数
概述

<port>

要显示的端口(名称或 id)

表 57.17. 命令参数
概述

-h, --help

显示帮助信息并退出

表 57.18. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 57.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 57.20. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 57.21. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

57.6. 端口未设置

取消设置端口属性

使用方法:

openstack port unset [-h]
                            [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
                            [--binding-profile <binding-profile-key>]
                            [--security-group <security-group>]
                            [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
                            [--qos-policy] [--data-plane-status]
                            [--tag <tag> | --all-tag]
                            <port>

表 57.22. positional 参数
概述

<port>

要修改的端口(名称或 id)

表 57.23. 命令参数
概述

-h, --help

显示帮助信息并退出

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

需要的 ip 和/或子网应该从这个端口中删除(名称或 ID):subnet=<subnet>,ip- address=<ip-address> (重复设置多个固定 IP 地址)

--binding-profile <binding-profile-key>

从 binding:profile 中删除所需的键(重复选项,以取消设置多个 binding:profile 数据)

--security-group <security-group>

应该删除此端口的安全组(名称或 ID)(重复设置多个安全组)

--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]

所需的允许地址对应该从这个端口中删除: ip-address=<ip-address>[,mac- address=<mac-address>](repeat 选项设置多个允许地址对)

--qos-policy

删除附加到端口的 qos 策略

--data-plane-status

清除 data plane 状态的现有信息

--tag <tag>

要从端口中删除的标签(重复选项来删除多个标签)

--all-tag

清除与端口关联的所有标签

第 58 章 project

本章描述了 project 命令下的命令。

58.1. 项目创建

创建新项目

使用方法:

openstack project create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--domain <domain>]
                                [--parent <project>]
                                [--description <description>]
                                [--enable | --disable]
                                [--property <key=value>] [--or-show]
                                [--tag <tag>]
                                <project-name>

表 58.1. positional 参数
概述

<project-name>

新项目名称

表 58.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

拥有项目的域(名称或 id)

--parent <project>

项目的父项(名称或 id)

--description <description>

项目描述

--enable

启用项目

--disable

禁用项目

--property <key=value>

为 <name> 添加属性(重复选项来设置多个属性)

--or-show

返回现有项目

--tag <tag>

要添加到项目的标签(重复选项来设置多个标签)

表 58.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 58.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 58.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 58.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

58.2. 项目删除

删除项目

使用方法:

openstack project delete [-h] [--domain <domain>]
                                <project> [<project> ...]

表 58.7. positional 参数
概述

<project>

要删除的项目(名称或 id)

表 58.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

域拥有 <project> (名称或 id)

58.3. 项目列表

列出项目

使用方法:

openstack project list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN] [--domain <domain>]
                              [--user <user>] [--my-projects] [--long]
                              [--sort <key>[:<direction>]]
                              [--tags <tag>[,<tag>,...]]
                              [--tags-any <tag>[,<tag>,...]]
                              [--not-tags <tag>[,<tag>,...]]
                              [--not-tags-any <tag>[,<tag>,...]]

表 58.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

按 <domain> (名称或 id)过滤项目

--user <user>

按 <user> (名称或 id)过滤项目

--my-projects

列出经过身份验证的用户的项目。取代其他过滤器。

--long

列出输出中的其他字段

--sort <key>[:<direction>]

根据所选密钥和方向(asc 或 desc)对输出进行排序(默认:asc),重复这个选项来指定多个键和方向。

--tags <tag>[,<tag>,…​]

列出具有所有给定标签的项目(以逗号分隔的标签列表)

--tags-any <tag>[,<tag>,…​]

列出具有任何给定标签的项目(以逗号分隔的标签列表)

--not-tags <tag>[,<tag>,…​]

排除具有所有给定标签的项目(以逗号分隔的标签列表)

--not-tags-any <tag>[,<tag>,…​]

排除具有任何给定标签的项目(以逗号分隔的标签列表)

表 58.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 58.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 58.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 58.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

58.4. 项目清除

清理与项目关联的资源

使用方法:

openstack project purge [-h] [--dry-run] [--keep-project]
                               (--auth-project | --project <project>)
                               [--project-domain <project-domain>]

表 58.14. 命令参数
概述

-h, --help

显示帮助信息并退出

--dry-run

列出项目的资源

--keep-project

清理项目资源,但不删除项目

--auth-project

删除用于身份验证的项目的资源

--project <project>

清理的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

58.5. 项目集

设置项目属性

使用方法:

openstack project set [-h] [--name <name>] [--domain <domain>]
                             [--description <description>]
                             [--enable | --disable] [--property <key=value>]
                             [--tag <tag>] [--clear-tags] [--remove-tag <tag>]
                             <project>

表 58.15. positional 参数
概述

<project>

要修改的项目(名称或 id)

表 58.16. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置项目名称

--domain <domain>

域拥有 <project> (名称或 id)

--description <description>

设置项目描述

--enable

启用项目

--disable

禁用项目

--property <key=value>

在 <project> 上设置属性(重复选项来设置多个属性)

--tag <tag>

要添加到项目的标签(重复选项来设置多个标签)

--clear-tags

清除与项目关联的标签。指定 --tag 和 --clear-tags 来覆盖当前标签

--remove-tag <tag>

要从项目中删除的标签(重复选项来删除多个标签)

58.6. 项目显示

显示项目详情

使用方法:

openstack project show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--domain <domain>] [--parents]
                              [--children]
                              <project>

表 58.17. positional 参数
概述

<project>

要显示的项目(名称或 id)

表 58.18. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

域拥有 <project> (名称或 id)

--parents

以列表形式显示项目的父项

--children

以列表形式显示项目的子树(children)

表 58.19. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 58.20. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 58.21. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 58.22. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 59 章 PTR

本章描述了 ptr 命令下的命令。

59.1. PTR 记录列表

列出 floatingip ptr 记录

使用方法:

openstack ptr record list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN] [--all-projects]
                                 [--edit-managed]
                                 [--sudo-project-id SUDO_PROJECT_ID]

表 59.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 59.2. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 59.3. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 59.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 59.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

59.2. PTR 记录集

设置 floatingip ptr 记录

使用方法:

openstack ptr record set [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                [--description DESCRIPTION | --no-description]
                                [--ttl TTL | --no-ttl] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                floatingip_id ptrdname

表 59.6. positional 参数
概述

floatingip_id

浮动 ip id 格式 region:floatingip_id

ptrdname

Ptrd 名称

表 59.7. 命令参数
概述

-h, --help

显示帮助信息并退出

--description DESCRIPTION

描述

--no-description—​ttl TTL

TTL

--no-ttl—​all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 59.8. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 59.9. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 59.10. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 59.11. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

59.3. PTR 记录显示

显示 floatingip ptr 记录详情

使用方法:

openstack ptr record show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--all-projects]
                                 [--edit-managed]
                                 [--sudo-project-id SUDO_PROJECT_ID]
                                 floatingip_id

表 59.12. positional 参数
概述

floatingip_id

浮动 ip id 格式 region:floatingip_id

表 59.13. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 59.14. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 59.15. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 59.16. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 59.17. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

59.4. PTR 记录未设置

取消设置 floatingip ptr 记录

使用方法:

openstack ptr record unset [-h] [--all-projects] [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  floatingip_id

表 59.18. positional 参数
概述

floatingip_id

浮动 ip id 格式 region:floatingip_id

表 59.19. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

第 60 章 quota

本章描述了 quota 命令下的命令。

60.1. 配额列表

列出具有非默认配额值的所有项目配额,或列出所请求项目的详细配额信息

使用方法:

openstack quota list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--project <project>] [--detail]
                            (--compute | --volume | --network)

表 60.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

列出此项目的配额 <project> (名称或 id)

--detail

显示配额使用量详情

--compute

列出计算配额

--volume

列出卷配额

--network

列出网络配额

表 60.2. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 60.3. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 60.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 60.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

60.2. 配额集

为项目或类设置配额

使用方法:

openstack quota set [-h] [--class] [--cores <cores>]
                           [--fixed-ips <fixed-ips>]
                           [--injected-file-size <injected-file-size>]
                           [--injected-path-size <injected-path-size>]
                           [--injected-files <injected-files>]
                           [--instances <instances>] [--key-pairs <key-pairs>]
                           [--properties <properties>] [--ram <ram>]
                           [--server-groups <server-groups>]
                           [--server-group-members <server-group-members>]
                           [--backups <backups>]
                           [--backup-gigabytes <backup-gigabytes>]
                           [--gigabytes <gigabytes>]
                           [--per-volume-gigabytes <per-volume-gigabytes>]
                           [--snapshots <snapshots>] [--volumes <volumes>]
                           [--floating-ips <floating-ips>]
                           [--secgroup-rules <secgroup-rules>]
                           [--secgroups <secgroups>] [--networks <networks>]
                           [--subnets <subnets>] [--ports <ports>]
                           [--routers <routers>]
                           [--rbac-policies <rbac-policies>]
                           [--subnetpools <subnetpools>]
                           [--volume-type <volume-type>]
                           <project/class>

表 60.6. positional 参数
概述

<project/class>

为此项目或类设置配额(名称/id)

表 60.7. 命令参数
概述

-h, --help

显示帮助信息并退出

--class

为 <class> 设置配额

--cores <cores>

核心配额的新值

--fixed-ips <fixed-ips>

fixed-ips 配额的新值

--injected-file-size <injected-file-size>

injected-file-size 配额的新值

--injected-path-size <injected-path-size>

injected-path-size 配额的新值

--injected-files <injected-files>

injected-files 配额的新值

--instances <instances>

实例配额的新值

--key-pairs <key-pairs>

键值对配额的新值

--properties <properties>

属性配额的新值

--ram <ram>

ram 配额的新值

--server-groups <server-groups>

server-groups 配额的新值

--server-group-members <server-group-members>

server-group-members 配额的新值

--backups <backups>

备份配额的新值

--backup-gigabytes <backup-gigabytes>

backup-gigabytes 配额的新值

--gigabytes <gigabytes>

gigabytes 配额的新值

--per-volume-gigabytes <per-volume-gigabytes>

每容量配额的新值

--snapshots <snapshots>

快照配额的新值

--volumes <volumes>

卷配额的新值

--floating-ips <floating-ips>

floating-ips 配额的新值

--secgroup-rules <secgroup-rules>

rhcs-rules 配额的新值

--rhcss <rhcss>

Evolutions 配额的新值

--networks <networks>

网络配额的新值

--subnets <subnets>

子网配额的新值

--ports <ports>

端口配额的新值

--routers <routers>

路由器配额的新值

--rbac-policies <rbac-policies>

rbac-policies 配额的新值

--subnetpools <subnetpools>

subnetpools 配额的新值

--volume-type <volume-type>

为特定 <volume-type> 设置配额

60.3. 配额显示

显示项目或类的配额。指定 ''--os-compute-api-version 2.50'' 或更高版本来查看给定配额类的 ''server-groups'' 和 ''server-group-members'' 输出。

使用方法:

openstack quota show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--class | --default]
                            [<project/class>]

表 60.8. positional 参数
概述

<project/class>

显示此项目或类的配额(名称或 id)

表 60.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--class

显示 <class> 的配额

--default

显示 <project> 的默认配额

表 60.10. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 60.11. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 60.12. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 60.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 61 章 RecordSet

本章描述了 recordset 命令下的命令。

61.1. RecordSet create

创建新记录集

使用方法:

openstack recordset create [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] --record RECORD --type TYPE
                                  [--ttl TTL] [--description DESCRIPTION]
                                  [--all-projects] [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_id name

表 61.1. positional 参数
概述

zone_id

zone id

name

RecordSet name

表 61.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--record RECORD

RecordSet 记录,如果需要重复

--type TYPE

RecordSet 类型

--ttl TTL

生存时间(秒)

--description DESCRIPTION

描述

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 61.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 61.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 61.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 61.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

61.2. RecordSet delete

删除记录集

使用方法:

openstack recordset delete [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_id id

表 61.7. positional 参数
概述

zone_id

zone id

id

RecordSet id

表 61.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 61.9. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 61.10. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 61.11. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 61.12. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

61.3. RecordSet list

列出记录集

使用方法:

openstack recordset list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--noindent] [--max-width <integer>]
                                [--fit-width] [--print-empty]
                                [--sort-column SORT_COLUMN] [--name NAME]
                                [--type TYPE] [--data DATA] [--ttl TTL]
                                [--description DESCRIPTION] [--status STATUS]
                                [--action ACTION] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                zone_id

表 61.13. positional 参数
概述

zone_id

zone id. 用于列出所有记录集,指定 all

表 61.14. 命令参数
概述

-h, --help

显示帮助信息并退出

--name NAME

RecordSet name

--type TYPE

RecordSet 类型

--data DATA

RecordSet 记录数据

--ttl TTL

生存时间(秒)

--description DESCRIPTION

描述

--status STATUS

RecordSet 状态

--action ACTION

recordSet 操作

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 61.15. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 61.16. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 61.17. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 61.18. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

61.4. RecordSet set

设置 recordset 属性

使用方法:

openstack recordset set [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--record RECORD]
                               [--description DESCRIPTION | --no-description]
                               [--ttl TTL | --no-ttl] [--all-projects]
                               [--edit-managed]
                               [--sudo-project-id SUDO_PROJECT_ID]
                               zone_id id

表 61.19. positional 参数
概述

zone_id

zone id

id

RecordSet id

表 61.20. 命令参数
概述

-h, --help

显示帮助信息并退出

--record RECORD

RecordSet 记录,如果需要重复

--description DESCRIPTION

描述

--no-description—​ttl TTL

TTL

--no-ttl—​all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 61.21. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 61.22. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 61.23. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 61.24. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

61.5. RecordSet show

显示记录设置详情

使用方法:

openstack recordset show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                zone_id id

表 61.25. positional 参数
概述

zone_id

zone id

id

RecordSet id

表 61.26. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 61.27. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 61.28. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 61.29. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 61.30. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 62 章 region

本章描述了 region 命令下的命令。

62.1. region create

创建新区域

使用方法:

openstack region create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--parent-region <region-id>]
                               [--description <description>]
                               <region-id>

表 62.1. positional 参数
概述

<region-id>

新区域 ID

表 62.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--parent-region <region-id>

父区域 ID

--description <description>

新区域描述

表 62.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 62.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 62.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 62.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

62.2. region delete

删除区域

使用方法:

openstack region delete [-h] <region-id> [<region-id> ...]

表 62.7. positional 参数
概述

<region-id>

要删除的区域 ID

表 62.8. 命令参数
概述

-h, --help

显示帮助信息并退出

62.3. region list

列出区域

使用方法:

openstack region list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN]
                             [--parent-region <region-id>]

表 62.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--parent-region <region-id>

按父区域 ID 过滤

表 62.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 62.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 62.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 62.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

62.4. 区域集

设置区域属性

使用方法:

openstack region set [-h] [--parent-region <region-id>]
                            [--description <description>]
                            <region-id>

表 62.14. positional 参数
概述

<region-id>

要修改的区域

表 62.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--parent-region <region-id>

新的父区域 ID

--description <description>

新区域描述

62.5. 区域显示

显示区域详情

使用方法:

openstack region show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <region-id>

表 62.16. positional 参数
概述

<region-id>

要显示的区域

表 62.17. 命令参数
概述

-h, --help

显示帮助信息并退出

表 62.18. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 62.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 62.20. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 62.21. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 63 章 registered

本章描述了 注册 命令下的命令。

63.1. 注册的限制创建

创建注册的限制

使用方法:

openstack registered limit create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         [--description <description>]
                                         [--region <region>] --service
                                         <service> --default-limit
                                         <default-limit>
                                         <resource-name>

表 63.1. positional 参数
概述

<resource-name>

要限制的资源名称

表 63.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

注册限制的描述

--region <region>

要影响的注册限制的区域

--service <service>

负责限制资源(必需)的服务

--default-limit <default-limit>

要假定的资源的默认限制(必需)

表 63.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 63.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 63.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 63.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

63.2. 注册的限制删除

删除注册的限制

使用方法:

openstack registered limit delete [-h]
                                         <registered-limit-id>
                                         [<registered-limit-id> ...]

表 63.7. positional 参数
概述

<registered-limit-id>

注册的限制以删除(id)

表 63.8. 命令参数
概述

-h, --help

显示帮助信息并退出

63.3. 注册的限制列表

列出注册的限制

使用方法:

openstack registered limit list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--service <service>]
                                       [--resource-name <resource-name>]
                                       [--region <region>]

表 63.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--service <service>

负责限制资源的服务

--resource-name <resource-name>

要限制的资源名称

--region <region>

要影响的限制的区域。

表 63.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 63.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 63.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 63.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

63.4. 注册的限制集

更新有关注册限制的信息

使用方法:

openstack registered limit set [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--service <service>]
                                      [--resource-name <resource-name>]
                                      [--default-limit <default-limit>]
                                      [--description <description>]
                                      [--region <region>]
                                      <registered-limit-id>

表 63.14. positional 参数
概述

<registered-limit-id>

更新的注册限制(id)

表 63.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--service <service>

要更新的服务,负责限制资源。--service、--resource-name 或 --region 必须与现有值不同,否则它将是重复的条目

--resource-name <resource-name>

要更新的资源,负责限制资源。--service、--resource-name 或 --region 必须与现有值不同,否则它将是重复的条目

--default-limit <default-limit>

要假定的资源的默认限制

--description <description>

更新注册限制的描述

--region <region>

要影响的注册限制的区域。--service、--resource-name 或 --region 必须与现有值不同,否则它将是重复的条目

表 63.16. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 63.17. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 63.18. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 63.19. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

63.5. 注册的限制显示

显示注册的限制详情

使用方法:

openstack registered limit show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <registered-limit-id>

表 63.20. positional 参数
概述

<registered-limit-id>

要显示的注册限制(id)

表 63.21. 命令参数
概述

-h, --help

显示帮助信息并退出

表 63.22. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 63.23. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 63.24. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 63.25. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 64 章 Request

本章描述了 request 命令下的命令。

64.1. 请求令牌授权

授权请求令牌

使用方法:

openstack request token authorize [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty] --request-key
                                         <request-key> --role <role>

表 64.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--request-key <request-key>

请求令牌进行授权(仅id)(必需)

--role <role>

要授权(名称或 id)的角色(重复选项来设置多个值)(必需)

表 64.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 64.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 64.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 64.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

64.2. 请求令牌创建

创建请求令牌

使用方法:

openstack request token create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] --consumer-key
                                      <consumer-key> --consumer-secret
                                      <consumer-secret> --project <project>
                                      [--domain <domain>]

表 64.6. 命令参数
概述

-h, --help

显示帮助信息并退出

--consumer-key <consumer-key>

--consumer-secret <consumer-secret>

--project <project>

--domain <domain>

表 64.7. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 64.8. 
概述

--noindent

表 64.9. 
概述

--prefix PREFIX

表 64.10. 
概述

--max-width <integer>

--fit-width

--print-empty

第 65 章 resource

65.1. 

使用方法:

openstack resource member create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        resource_id resource_type member_id

表 65.1. 
概述

resource_id

resource_type

资源类型。

member_id

表 65.2. 命令参数
概述

-h, --help

显示帮助信息并退出

表 65.3. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 65.4. 
概述

--noindent

表 65.5. 
概述

--prefix PREFIX

表 65.6. 
概述

--max-width <integer>

--fit-width

--print-empty

65.2. 

使用方法:

openstack resource member delete [-h] resource resource_type member_id

表 65.7. 
概述

resource

resource_type

资源类型。

member_id

表 65.8. 命令参数
概述

-h, --help

显示帮助信息并退出

65.3. 

使用方法:

openstack resource member list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--marker [MARKER]] [--limit [LIMIT]]
                                      [--sort_keys [SORT_KEYS]]
                                      [--sort_dirs [SORT_DIRS]]
                                      [--filter FILTERS]
                                      resource_id resource_type

表 65.9. 
概述

resource_id

resource_type

资源类型。

表 65.10. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

--limit [LIMIT]

--sort_keys [SORT_KEYS]

--sort_dirs [SORT_DIRS]

表 65.11. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

--sort-column SORT_COLUMN

表 65.12. 
概述

--quote {all,minimal,none,nonnumeric}

表 65.13. 
概述

--noindent

表 65.14. 
概述

--max-width <integer>

--fit-width

--print-empty

65.4. 

使用方法:

openstack resource member show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [-m MEMBER_ID]
                                      resource resource_type

表 65.15. 
概述

resource

resource_type

资源类型。

表 65.16. 命令参数
概述

-h, --help

显示帮助信息并退出

-m MEMBER_ID, --member-id MEMBER_ID

表 65.17. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 65.18. 
概述

--noindent

表 65.19. 
概述

--prefix PREFIX

表 65.20. 
概述

--max-width <integer>

--fit-width

--print-empty

65.5. 

使用方法:

openstack resource member update [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [-m MEMBER_ID]
                                        [-s {pending,accepted,rejected}]
                                        resource_id resource_type

表 65.21. 
概述

resource_id

resource_type

资源类型。

表 65.22. 命令参数
概述

-h, --help

显示帮助信息并退出

-m MEMBER_ID, --member-id MEMBER_ID

-s {pending,accepted,rejected}, --status {pending,accepted,rejected}

表 65.23. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 65.24. 
概述

--noindent

表 65.25. 
概述

--prefix PREFIX

表 65.26. 
概述

--max-width <integer>

--fit-width

--print-empty

第 66 章 role

66.1. 

使用方法:

openstack role add [-h]
                          [--system <system> | --domain <domain> | --project <project>]
                          [--user <user> | --group <group>]
                          [--group-domain <group-domain>]
                          [--project-domain <project-domain>]
                          [--user-domain <user-domain>] [--inherited]
                          [--role-domain <role-domain>]
                          <role>

表 66.1. 
概述

<role>

表 66.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--system <system>

--domain <domain>

--project <project>

--user <user>

--group <group>

--group-domain <group-domain>

--project-domain <project-domain>

--user-domain <user-domain>

--inherited

--role-domain <role-domain>

66.2. 

使用方法:

openstack role assignment list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--effective] [--role <role>]
                                      [--role-domain <role-domain>] [--names]
                                      [--user <user>]
                                      [--user-domain <user-domain>]
                                      [--group <group>]
                                      [--group-domain <group-domain>]
                                      [--domain <domain> | --project <project> | --system <system>]
                                      [--project-domain <project-domain>]
                                      [--inherited] [--auth-user]
                                      [--auth-project]

表 66.3. 命令参数
概述

-h, --help

显示帮助信息并退出

--effective

--role <role>

--role-domain <role-domain>

--names

--user <user>

--user-domain <user-domain>

--group <group>

--group-domain <group-domain>

--domain <domain>

--project <project>

--system <system>

--project-domain <project-domain>

--inherited

--auth-user

--auth-project

表 66.4. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

--sort-column SORT_COLUMN

表 66.5. 
概述

--quote {all,minimal,none,nonnumeric}

表 66.6. 
概述

--noindent

表 66.7. 
概述

--max-width <integer>

--fit-width

--print-empty

66.3. 

使用方法:

openstack role create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--domain <domain>] [--or-show]
                             <role-name>

表 66.8. 
概述

<role-name>

表 66.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

--or-show

表 66.10. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 66.11. 
概述

--noindent

表 66.12. 
概述

--prefix PREFIX

表 66.13. 
概述

--max-width <integer>

--fit-width

--print-empty

66.4. 

使用方法:

openstack role delete [-h] [--domain <domain>] <role> [<role> ...]

表 66.14. 
概述

<role>

表 66.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

66.5. 

使用方法:

openstack role list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           [--domain <domain>]

表 66.16. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

表 66.17. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

--sort-column SORT_COLUMN

表 66.18. 
概述

--quote {all,minimal,none,nonnumeric}

表 66.19. 
概述

--noindent

表 66.20. 
概述

--max-width <integer>

--fit-width

--print-empty

66.6. 

使用方法:

openstack role remove [-h]
                             [--system <system> | --domain <domain> | --project <project>]
                             [--user <user> | --group <group>]
                             [--group-domain <group-domain>]
                             [--project-domain <project-domain>]
                             [--user-domain <user-domain>] [--inherited]
                             [--role-domain <role-domain>]
                             <role>

表 66.21. 
概述

<role>

表 66.22. 命令参数
概述

-h, --help

显示帮助信息并退出

--system <system>

--domain <domain>

--project <project>

--user <user>

--group <group>

--group-domain <group-domain>

--project-domain <project-domain>

--user-domain <user-domain>

--inherited

--role-domain <role-domain>

66.7. 

使用方法:

openstack role set [-h] [--domain <domain>] [--name <name>] <role>

表 66.23. 
概述

<role>

表 66.24. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

--name <name>

66.8. Role show

显示角色详情

使用方法:

openstack role show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--domain <domain>]
                           <role>

表 66.25. positional 参数
概述

<role>

要显示的角色(名称或 id)

表 66.26. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

角色所属的域(名称或 id)

表 66.27. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 66.28. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 66.29. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 66.30. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 67 章 路由器

本章描述了 router 命令下的命令。

67.1. 路由器添加端口

向路由器添加端口

使用方法:

openstack router add port [-h] <router> <port>

表 67.1. positional 参数
概述

<router>

将添加端口的路由器(名称或 id)

<port>

要添加的端口(名称或 id)

表 67.2. 命令参数
概述

-h, --help

显示帮助信息并退出

67.2. 路由器添加子网

将子网添加到路由器

使用方法:

openstack router add subnet [-h] <router> <subnet>

表 67.3. positional 参数
概述

<router>

将添加子网的路由器(名称或 ID)

<subnet>

要添加的子网(名称或 id)

表 67.4. 命令参数
概述

-h, --help

显示帮助信息并退出

67.3. 路由器创建

创建新路由器

使用方法:

openstack router create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--enable | --disable]
                               [--distributed | --centralized]
                               [--ha | --no-ha] [--description <description>]
                               [--project <project>]
                               [--project-domain <project-domain>]
                               [--availability-zone-hint <availability-zone>]
                               [--tag <tag> | --no-tag]
                               <name>

表 67.5. positional 参数
概述

<name>

新路由器名称

表 67.6. 命令参数
概述

-h, --help

显示帮助信息并退出

--enable

启用路由器(默认)

--disable

禁用路由器

--distributed

创建分布式路由器

--centralized

创建集中式路由器

--ha

创建高可用性路由器

--no-ha

创建传统路由器

--description <description>

设置路由器描述

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--availability-zone-hint <availability-zone>

在其中创建此路由器的可用区(需要路由可用区扩展,重复选项来设置多个可用区)

--tag <tag>

要添加到路由器的标签(重复选项来设置多个标签)

--no-tag

没有与路由器关联的标签

表 67.7. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 67.8. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 67.9. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 67.10. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

67.4. 路由器删除

删除路由器

使用方法:

openstack router delete [-h] <router> [<router> ...]

表 67.11. positional 参数
概述

<router>

要删除的路由器(名称或 ID)

表 67.12. 命令参数
概述

-h, --help

显示帮助信息并退出

67.5. 路由器列表

列出路由器

使用方法:

openstack router list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--name <name>]
                             [--enable | --disable] [--long]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--agent <agent-id>] [--tags <tag>[,<tag>,...]]
                             [--any-tags <tag>[,<tag>,...]]
                             [--not-tags <tag>[,<tag>,...]]
                             [--not-any-tags <tag>[,<tag>,...]]

表 67.13. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

根据路由器的名称列出路由器

--enable

列出启用的路由器

--disable

列出禁用的路由器

--long

列出输出中的其他字段

--project <project>

根据项目(名称或 ID)列出路由器

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--agent <agent-id>

列出由代理托管的路由器(仅限id)

--tags <tag>[,<tag>,…​]

列出具有所有给定标签(以逗号分隔的标签列表)的路由器

--any-tags <tag>[,<tag>,…​]

列出具有任何给定标签的路由器(以逗号分隔的标签列表)

--not-tags <tag>[,<tag>,…​]

排除具有所有给定标签(以逗号分隔的标签列表)的路由器

--not-any-tags <tag>[,<tag>,…​]

排除具有任何给定标签(以逗号分隔的标签列表)的路由器

表 67.14. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 67.15. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 67.16. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 67.17. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

67.6. 路由器移除端口

从路由器中删除端口

使用方法:

openstack router remove port [-h] <router> <port>

表 67.18. positional 参数
概述

<router>

将从中删除端口的路由器(名称或 id)

<port>

要删除和删除的端口(名称或 id)

表 67.19. 命令参数
概述

-h, --help

显示帮助信息并退出

67.7. 路由器移除子网

从路由器中删除子网

使用方法:

openstack router remove subnet [-h] <router> <subnet>

表 67.20. positional 参数
概述

<router>

将从中删除子网的路由器(名称或 id)

<subnet>

要删除的子网(名称或 id)

表 67.21. 命令参数
概述

-h, --help

显示帮助信息并退出

67.8. 路由器集

设置路由器属性

使用方法:

openstack router set [-h] [--name <name>] [--description <description>]
                            [--enable | --disable]
                            [--distributed | --centralized]
                            [--route destination=<subnet>,gateway=<ip-address>]
                            [--no-route] [--ha | --no-ha]
                            [--external-gateway <network>]
                            [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
                            [--enable-snat | --disable-snat]
                            [--qos-policy <qos-policy> | --no-qos-policy]
                            [--tag <tag>] [--no-tag]
                            <router>

表 67.22. positional 参数
概述

<router>

要修改的路由器(名称或 id)

表 67.23. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置路由器名称

--description <description>

设置路由器描述

--enable

启用路由器

--disable

禁用路由器

--distributed

将路由器设置为分布式模式(仅限禁用路由器)

--centralized

将路由器设置为集中式模式(仅限禁用路由器)

--route destination=<subnet>,gateway=<ip-address>

与路由器目的地关联的路由:目的地子网(以 CIDR 表示法)网关:下一步 IP 地址(需要设置多个路由)

--no-route

清除与路由器关联的路由。指定 --route 和 --no-route 来覆盖路由的当前值。

--ha

将路由器设置为高可用性(仅禁用路由器)

--no-ha

清除路由器的高可用性属性(仅限禁用路由器)

--external-gateway <network>

用作路由器的网关(名称或 id)的外部网络

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

外部网关上所需的 ip 和/或子网(名称或 id):subnet=<subnet>,ip-address=<ip-address> (用于设置多个固定 IP 地址的 repeat 选项)

--enable-snat

在外部网关上启用源 nat

--disable-snat

在外部网关中禁用源 nat

--qos-policy <qos-policy>

将 qos 策略附加到路由器网关 ips

--no-qos-policy

从路由器网关 ips 中删除 qos 策略

--tag <tag>

要添加到路由器的标签(重复选项来设置多个标签)

--no-tag

清除与路由器关联的标签。指定 --tag 和 --no-tag 来覆盖当前标签

67.9. 路由器显示

显示路由器详情

使用方法:

openstack router show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <router>

表 67.24. positional 参数
概述

<router>

要显示的路由器(名称或 id)

表 67.25. 命令参数
概述

-h, --help

显示帮助信息并退出

表 67.26. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 67.27. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 67.28. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 67.29. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

67.10. 路由器取消设置

取消设置路由器属性

使用方法:

openstack router unset [-h]
                              [--route destination=<subnet>,gateway=<ip-address>]
                              [--external-gateway] [--qos-policy]
                              [--tag <tag> | --all-tag]
                              <router>

表 67.30. positional 参数
概述

<router>

要修改的路由器(名称或 id)

表 67.31. 命令参数
概述

-h, --help

显示帮助信息并退出

--route destination=<subnet>,gateway=<ip-address>

要从路由器目的地中删除的路由:目的地子网(以 CIDR 表示法)网关:下一步 IP 地址(需要取消设置多个路由)

--external-gateway

从路由器中删除外部网关信息

--qos-policy

从路由器网关 ips 中删除 qos 策略

--tag <tag>

要从路由器中删除的标签(重复选项来删除多个标签)

--all-tag

清除与路由器关联的所有标签

第 68 章 secret

本章描述了 secret 命令下的命令。

68.1. Secret 容器创建

将容器存储在 Barbican 中。

使用方法:

openstack secret container create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty] [--name NAME]
                                         [--type TYPE] [--secret SECRET]

表 68.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--name NAME, -n NAME

人类友好的名称。

--type TYPE

要创建的容器类型(默认: generic)。

--secret SECRET, -s SECRET

要存储在容器中的一个 secret (可以多次设置)。示例:--secret "private_key=https://url.test/v1/secrets/1-2-3-4"

表 68.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 68.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 68.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 68.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

68.2. Secret 容器删除

通过提供其 href 来删除容器。

使用方法:

openstack secret container delete [-h] URI

表 68.6. positional 参数
概述

URI

容器的 uri 引用

表 68.7. 命令参数
概述

-h, --help

显示帮助信息并退出

68.3. Secret 容器获取

通过提供其 URI 来检索容器。

使用方法:

openstack secret container get [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      URI

表 68.8. positional 参数
概述

URI

容器的 uri 引用。

表 68.9. 命令参数
概述

-h, --help

显示帮助信息并退出

表 68.10. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 68.11. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 68.12. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 68.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

68.4. Secret 容器列表

列出容器。

使用方法:

openstack secret container list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--limit LIMIT] [--offset OFFSET]
                                       [--name NAME] [--type TYPE]

表 68.14. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT, -l LIMIT

指定每个页面列出的项目数量的限制(默认为 10;最大:100)

--offset OFFSET, -o OFFSET

指定页面偏移(默认为 0)

--name NAME, -n NAME

指定容器名称(默认为 none)

--type TYPE, -t TYPE

指定列表的类型过滤器(默认值:none)。

表 68.15. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 68.16. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 68.17. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 68.18. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

68.5. Secret delete

通过提供 URI 来删除 secret。

使用方法:

openstack secret delete [-h] URI

表 68.19. positional 参数
概述

URI

secret 的 uri 引用

表 68.20. 命令参数
概述

-h, --help

显示帮助信息并退出

68.6. Secret get

通过提供其 URI 来检索 secret。

使用方法:

openstack secret get [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty]
                            [--decrypt | --payload | --file <filename>]
                            [--payload_content_type PAYLOAD_CONTENT_TYPE]
                            URI

表 68.21. positional 参数
概述

URI

secret 的 uri 引用。

表 68.22. 命令参数
概述

-h, --help

显示帮助信息并退出

--decrypt, -d

如果指定,检索未加密的 secret 数据。

--payload, -p

如果指定,检索未加密的 secret 数据。

--file <filename>, -F <filename>

如果指定,请将有效负载保存到带有给定文件名的新文件。

--payload_content_type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

解密 secret 的内容类型(默认为 text/plain)。

表 68.23. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 68.24. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 68.25. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 68.26. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

68.7. Secret list

列出 secret。

使用方法:

openstack secret list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--limit LIMIT]
                             [--offset OFFSET] [--name NAME]
                             [--algorithm ALGORITHM] [--bit-length BIT_LENGTH]
                             [--mode MODE] [--secret-type SECRET_TYPE]

表 68.27. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT, -l LIMIT

指定每个页面列出的项目数量的限制(默认为 10;最大:100)

--offset OFFSET, -o OFFSET

指定页面偏移(默认为 0)

--name NAME, -n NAME

指定 secret 名称(默认为 none)

--algorithm ALGORITHM, -a ALGORITHM

列表的算法过滤器(default: none)。

--bit-length BIT_LENGTH, -b BIT_LENGTH

列表的位长度过滤器(默认: 0)。

--mode MODE, -m MODE

列表的算法模式过滤器(默认: None)。

--secret-type SECRET_TYPE, -s SECRET_TYPE

指定 secret 类型(默认为 none)。

表 68.28. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 68.29. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 68.30. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 68.31. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

68.8. Secret order create

创建新顺序。

使用方法:

openstack secret order create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--name NAME] [--algorithm ALGORITHM]
                                     [--bit-length BIT_LENGTH] [--mode MODE]
                                     [--payload-content-type PAYLOAD_CONTENT_TYPE]
                                     [--expiration EXPIRATION]
                                     [--request-type REQUEST_TYPE]
                                     [--subject-dn SUBJECT_DN]
                                     [--source-container-ref SOURCE_CONTAINER_REF]
                                     [--ca-id CA_ID] [--profile PROFILE]
                                     [--request-file REQUEST_FILE]
                                     type

表 68.32. positional 参数
概述

type

要创建的顺序(密钥、非对称、证书)的类型。

表 68.33. 命令参数
概述

-h, --help

显示帮助信息并退出

--name NAME, -n NAME

人类友好的名称。

--algorithm ALGORITHM, -a ALGORITHM

与请求的密钥一起使用的算法(默认: aes)。

--bit-length BIT_LENGTH, -b BIT_LENGTH

请求的 secret 密钥的位长度(默认为 256)。

--mode MODE, -m MODE

与请求的密钥一起使用的算法模式(默认为 cbc)。

--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

要生成的 secret 的 type/format (默认为 application/octet-stream)。

--expiration EXPIRATION, -x EXPIRATION

iso 8601 格式的 secret 的过期时间。

--request-type REQUEST_TYPE

证书请求的类型。

--subject-dn SUBJECT_DN

证书的主题。

--source-container-ref SOURCE_CONTAINER_REF

使用存储密钥请求时的证书源。

--ca-id CA_ID

用于证书请求的 ca 的标识符。

--profile PROFILE

要使用的证书配置文件。

--request-file REQUEST_FILE

包含 csr 的文件。

表 68.34. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 68.35. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 68.36. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 68.37. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

68.9. Secret order delete

通过提供 href 来删除顺序。

使用方法:

openstack secret order delete [-h] URI

表 68.38. positional 参数
概述

URI

顺序的 uri 引用

表 68.39. 命令参数
概述

-h, --help

显示帮助信息并退出

68.10. Secret order get

通过提供其 URI 来检索顺序。

使用方法:

openstack secret order get [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  URI

表 68.40. positional 参数
概述

URI

uri 参考顺序。

表 68.41. 命令参数
概述

-h, --help

显示帮助信息并退出

表 68.42. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 68.43. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 68.44. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 68.45. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

68.11. Secret order list

列出订购。

使用方法:

openstack secret order list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN] [--limit LIMIT]
                                   [--offset OFFSET]

表 68.46. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT, -l LIMIT

指定每个页面列出的项目数量的限制(默认为 10;最大:100)

--offset OFFSET, -o OFFSET

指定页面偏移(默认为 0)

表 68.47. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 68.48. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 68.49. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 68.50. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

68.12. Secret 存储

将 secret 存储在 Barbican 中。

使用方法:

openstack secret store [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--name NAME]
                              [--secret-type SECRET_TYPE]
                              [--payload-content-type PAYLOAD_CONTENT_TYPE]
                              [--payload-content-encoding PAYLOAD_CONTENT_ENCODING]
                              [--algorithm ALGORITHM]
                              [--bit-length BIT_LENGTH] [--mode MODE]
                              [--expiration EXPIRATION]
                              [--payload PAYLOAD | --file <filename>]

表 68.51. 命令参数
概述

-h, --help

显示帮助信息并退出

--name NAME, -n NAME

人类友好的名称。

--secret-type SECRET_TYPE, -s SECRET_TYPE

secret 类型;必须是对称、公共、私有、证书、密码短语、不透明(默认)

--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

提供的 secret 数据的 type/format; "text/plain" 被假定为 UTF-8;提供 --payload 时是必需的。

--payload-content-encoding PAYLOAD_CONTENT_ENCODING, -e PAYLOAD_CONTENT_ENCODING

如果 --payload-content-type 为 "application/octet-stream",则需要此项。

--algorithm ALGORITHM, -a ALGORITHM

算法(默认:aes)。

--bit-length BIT_LENGTH, -b BIT_LENGTH

位长度(默认为 256)。

--mode MODE, -m MODE

算法模式;仅用于参考(默认: cbc)

--expiration EXPIRATION, -x EXPIRATION

iso 8601 格式的 secret 的过期时间。

--payload PAYLOAD, -p PAYLOAD

未加密的 secret 数据。

--file <filename>, -F <filename>

包含 secret 有效负载的文件

表 68.52. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 68.53. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 68.54. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 68.55. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

68.13. Secret 更新

更新一个 secret,且没有 Barbican 中的有效负载。

使用方法:

openstack secret update [-h] URI payload

表 68.56. positional 参数
概述

URI

secret 的 uri 引用。

payload

未加密的 secret

表 68.57. 命令参数
概述

-h, --help

显示帮助信息并退出

第 69 章 安全

本章描述了 security 命令下的命令。

69.1. 安全组创建

创建新安全组

使用方法:

openstack security group create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--description <description>]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       [--tag <tag> | --no-tag]
                                       <name>

表 69.1. positional 参数
概述

<name>

新的安全组名称

表 69.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

安全组描述

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--tag <tag>

要添加到安全组的标签(重复选项来设置多个标签)

--no-tag

没有与安全组关联的标签

表 69.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 69.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 69.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 69.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

69.2. 安全组删除

删除安全组

使用方法:

openstack security group delete [-h] <group> [<group> ...]

表 69.7. positional 参数
概述

<bx id="1" />

要删除的安全组(名称或 id)

表 69.8. 命令参数
概述

-h, --help

显示帮助信息并退出

69.3. 安全组列表

列出安全组

使用方法:

openstack security group list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--project <project>]
                                     [--project-domain <project-domain>]
                                     [--tags <tag>[,<tag>,...]]
                                     [--any-tags <tag>[,<tag>,...]]
                                     [--not-tags <tag>[,<tag>,...]]
                                     [--not-any-tags <tag>[,<tag>,...]]

表 69.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

根据项目(名称或 ID)列出安全组

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--tags <tag>[,<tag>,…​]

列出具有所有给定标签的安全组(Comma 分隔标签列表)

--any-tags <tag>[,<tag>,…​]

列出具有任何给定标签的安全组(以逗号分隔的标签列表)

--not-tags <tag>[,<tag>,…​]

排除所有给定标签(Comma 分隔标签列表)的安全组

--not-any-tags <tag>[,<tag>,…​]

排除任何给定标签(Comma 分隔标签列表)的安全组

表 69.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 69.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 69.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 69.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

69.4. 安全组规则创建

创建新的安全组规则

使用方法:

openstack security group rule create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--remote-ip <ip-address> | --remote-group <group>]
                                            [--description <description>]
                                            [--dst-port <port-range>]
                                            [--icmp-type <icmp-type>]
                                            [--icmp-code <icmp-code>]
                                            [--protocol <protocol>]
                                            [--ingress | --egress]
                                            [--ethertype <ethertype>]
                                            [--project <project>]
                                            [--project-domain <project-domain>]
                                            <group>

表 69.14. positional 参数
概述

<bx id="1" />

在此安全组中创建规则(名称或 id)

表 69.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--remote-ip <ip-address>

远程 ip 地址块(may 使用 cidr 表示法;对于 IPv4 规则,默认为 0.0.0.0/0,对于 IPv6 规则:::/0)

--remote-group <group>

远程安全组(名称或 id)

--description <description>

设置安全组规则描述

--dst-port <port-range>

目的端口可以是单个端口或起始和结束端口范围:137:139。IP 协议 TCP 和 UDP 需要。ICMP IP 协议忽略。

--icmp-type <icmp-type>

icmp ip 协议的 ICMP 类型

--icmp-code <icmp-code>

icmp ip 协议的 ICMP 代码

--protocol <protocol>

IP 协议(ah, dccp, egp, esp, gre, icmp, igmp, ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt, ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, tcp, udp, udplite, vrrp and integer representations [0-255] 或 any; default: default: any (all protocol)

--ingress

规则应用到传入的网络流量(默认)

--egress

规则适用于传出流量

--ethertype <ethertype>

网络流量的 ethertype (ipv4、ipv6;默认:基于 IP 协议)

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

表 69.16. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 69.17. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 69.18. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 69.19. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

69.5. 安全组规则删除

删除安全组规则

使用方法:

openstack security group rule delete [-h] <rule> [<rule> ...]

表 69.20. positional 参数
概述

<rule>

要删除的安全组规则(仅限id)

表 69.21. 命令参数
概述

-h, --help

显示帮助信息并退出

69.6. 安全组规则列表

列出安全组规则

使用方法:

openstack security group rule list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          [--protocol <protocol>]
                                          [--ethertype <ethertype>]
                                          [--ingress | --egress] [--long]
                                          [<group>]

表 69.22. positional 参数
概述

<bx id="1" />

列出此安全组中的所有规则(名称或 id)

表 69.23. 命令参数
概述

-h, --help

显示帮助信息并退出

--protocol <protocol>

通过 ip 协议列出规则(ah, dhcp, egp, esp, gre, icmp, igmp, ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt, ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, tcp, udp, udplite, vrrp 和 integer 表示 [0-255] 或任何 ; 默认:任何(所有协议)

--ethertype <ethertype>

按 ethertype (ipv4 或 ipv6)列出规则

--ingress

列出应用到传入的网络流量的规则

--egress

列出应用到传出网络流量的规则

--long

列出输出中的其他字段

表 69.24. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 69.25. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 69.26. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 69.27. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

69.7. 安全组规则显示

显示安全组规则详情

使用方法:

openstack security group rule show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <rule>

表 69.28. positional 参数
概述

<rule>

要显示的安全组规则(仅id)

表 69.29. 命令参数
概述

-h, --help

显示帮助信息并退出

表 69.30. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 69.31. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 69.32. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 69.33. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

69.8. 安全组集

设置安全组属性

使用方法:

openstack security group set [-h] [--name <new-name>]
                                    [--description <description>]
                                    [--tag <tag>] [--no-tag]
                                    <group>

表 69.34. positional 参数
概述

<bx id="1" />

要修改的安全组(名称或 id)

表 69.35. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <new-name>

新的安全组名称

--description <description>

新的安全组描述

--tag <tag>

要添加到安全组的标签(重复选项来设置多个标签)

--no-tag

清除与安全组关联的标签。指定 --tag 和 --no-tag 来覆盖当前标签

69.9. 安全组显示

显示安全组详情

使用方法:

openstack security group show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <group>

表 69.36. positional 参数
概述

<bx id="1" />

要显示的安全组(名称或 id)

表 69.37. 命令参数
概述

-h, --help

显示帮助信息并退出

表 69.38. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 69.39. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 69.40. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 69.41. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

69.10. 安全组未设置

取消设置安全组属性

使用方法:

openstack security group unset [-h] [--tag <tag> | --all-tag] <group>

表 69.42. positional 参数
概述

<bx id="1" />

要修改的安全组(名称或 id)

表 69.43. 命令参数
概述

-h, --help

显示帮助信息并退出

--tag <tag>

要从安全组中删除的标签(重复选项来删除多个标签)

--all-tag

清除与安全组关联的所有标签

第 70 章 server

本章描述了 server 命令下的命令。

70.1. 服务器添加固定的 ip

为服务器添加固定 IP 地址

使用方法:

openstack server add fixed ip [-h] [--fixed-ip-address <ip-address>]
                                     <server> <network>

表 70.1. positional 参数
概述

<server>

服务器接收固定的 ip 地址(名称或 id)

<network>

网络从中分配固定的 ip 地址(名称或 ID)

表 70.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--fixed-ip-address <ip-address>

请求的固定 IP 地址

70.2. 服务器添加浮动 IP

为服务器添加浮动 IP 地址

使用方法:

openstack server add floating ip [-h] [--fixed-ip-address <ip-address>]
                                        <server> <ip-address>

表 70.3. positional 参数
概述

<server>

服务器接收浮动 IP 地址(名称或 id)

<ip-address>

分配给第一个可用服务器端口的浮动 IP 地址(仅限 IP)

表 70.4. 命令参数
概述

-h, --help

显示帮助信息并退出

--fixed-ip-address <ip-address>

修复了 ip 地址,以与此浮动 ip 地址关联。将使用包含固定 IP 地址的第一个服务器端口

70.3. 服务器添加网络

将网络添加到服务器

使用方法:

openstack server add network [-h] <server> <network>

表 70.5. positional 参数
概述

<server>

服务器将网络添加到(名称或 id)

<network>

要添加到服务器的网络(名称或 id)

表 70.6. 命令参数
概述

-h, --help

显示帮助信息并退出

70.4. 服务器添加端口

向服务器添加端口

使用方法:

openstack server add port [-h] <server> <port>

表 70.7. positional 参数
概述

<server>

服务器将端口添加到(名称或 id)

<port>

要添加到服务器的端口(名称或 id)

表 70.8. 命令参数
概述

-h, --help

显示帮助信息并退出

70.5. 服务器添加安全组

将安全组添加到服务器

使用方法:

openstack server add security group [-h] <server> <group>

表 70.9. positional 参数
概述

<server>

server (名称或 id)

<bx id="1" />

要添加的安全组(名称或 id)

表 70.10. 命令参数
概述

-h, --help

显示帮助信息并退出

70.6. 服务器添加卷

将卷添加到服务器。指定 ''--os-compute-api-version 2.20'' 或更高版本,将卷添加到状态为 ''SHELVED' 或 ''SHELVED_OFFLOADED'' 的服务器中。

使用方法:

openstack server add volume [-h] [--device <device>] <server> <volume>

表 70.11. positional 参数
概述

<server>

server (名称或 id)

<volume>

要添加的卷(名称或 id)

表 70.12. 命令参数
概述

-h, --help

显示帮助信息并退出

--device <device>

卷的内部设备名称

70.7. 服务器备份创建

创建服务器备份镜像

使用方法:

openstack server backup create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--name <image-name>]
                                      [--type <backup-type>]
                                      [--rotate <count>] [--wait]
                                      <server>

表 70.13. positional 参数
概述

<server>

要备份的服务器(名称或 id)

表 70.14. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <image-name>

备份镜像的名称(默认:服务器名称)

--type <backup-type>

用于填充备份镜像的 backup_type 属性(默认为空)

--rotate <count>

要保留的备份数(默认:1)

--wait

等待备份镜像创建完成

表 70.15. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 70.16. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 70.17. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 70.18. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

70.8. 服务器创建

创建新服务器

使用方法:

openstack server create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               (--image <image> | --image-property <key=value> | --volume <volume>)
                               --flavor <flavor>
                               [--security-group <security-group>]
                               [--key-name <key-name>]
                               [--property <key=value>]
                               [--file <dest-filename=source-filename>]
                               [--user-data <user-data>]
                               [--description <description>]
                               [--availability-zone <zone-name>]
                               [--host <host>]
                               [--hypervisor-hostname <hypervisor-hostname>]
                               [--boot-from-volume <volume-size>]
                               [--block-device-mapping <dev-name=mapping>]
                               [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none>]
                               [--network <network>] [--port <port>]
                               [--hint <key=value>]
                               [--config-drive <config-drive-volume>|True]
                               [--min <count>] [--max <count>] [--wait]
                               <server-name>

表 70.19. positional 参数
概述

<server-name>

新服务器名称

表 70.20. 命令参数
概述

-h, --help

显示帮助信息并退出

--image <image>

从此镜像创建服务器引导磁盘(名称或 id)

--image-property <key=value>

要匹配的镜像属性

--volume <volume>

使用此卷作为引导磁盘(名称或 ID)创建服务器。这个选项会自动创建引导索引为 0 的块设备映射。在很多 hypervisor (例如libvirt/kvm)上,这将是设备 vda。不要为此卷使用 --block-device- 映射创建重复的映射。

--flavor <flavor>

创建使用此类别的服务器(名称或 id)

--security-group <security-group>

要分配给此服务器的安全组(名称或 id)(重复设置多个组)

--key-name <key-name>

注入此服务器的密钥对(可选扩展)

--property <key=value>

在此服务器上设置属性(重复选项来设置多个值)

--file <dest-filename=source-filename>

在引导前要注入镜像的文件(重复选项来设置多个文件)

--user-data <user-data>

从元数据服务器提供服务的用户数据文件

--description <description>

为服务器设置描述(由 --os- compute-api-version 2.19 或更高版本支持)

--availability-zone <zone-name>

为服务器选择一个可用区

--host <host>

请求主机来创建服务器。默认情况下,只有 admin (由 --os-compute-api-version 2.74 或更高版本支持)

--hypervisor-hostname <hypervisor-hostname>

请求 hypervisor 主机名来创建服务器。默认情况下 admin (只支持 --os-compute-api- 版本 2.74 或更高版本)

--boot-from-volume <volume-size>

当与 '--image' 或 '-image-property' 选项一同使用时,这个选项会自动创建带有引导索引 0 的块设备映射,并告知计算服务从指定镜像创建给定大小(以 GB 为单位)的卷,并将其用作服务器的根磁盘。当服务器被删除时,根卷不会被删除。这个选项与 '--volume' 选项相互排斥。

--block-device-mapping <dev-name=mapping>

在服务器上创建块设备。块设备映射的格式为 <dev-name>=<id>:<type>:<size (GB)>:<delete-on- termination> <dev-name>: block device name,例如:VirtualMachine、xvdc (必需)<id>: 卷的名称或 ID、卷快照或镜像(必需)<type>: volume, snapshot or image; default: volume (optional)<size (GB)>: volume size if create from image or snapshot (optional)<delete-on-terminate>: true 或 false; default: false (可选)(可选)

--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none>

在服务器上创建一个 nic。指定多个选项来创建多个 NIC。必须提供 net-id 或 port- id,但不能提供两者。net-id: 将 NIC 附加到带有此 UUID 的网络,port-id: 将 NIC 附加到使用此 UUID 的端口,v4-fixed-ip: IPv4 固定地址将自动分配网络。指定 auto 或 none 的 --nic 不能与其他 --nic 值一起使用。

--network <network>

在服务器上创建一个 nic,并将其连接到网络。多次指定选项来创建多个 NIC。这是 --nic net-id=<network& gt; 参数的一个打包程序,它为将新的服务器连接到给定网络的标准用例提供简单的语法。有关更高级的用例,请参阅 -- nic 参数。

--port <port>

在服务器上创建一个 nic,并将其连接到端口。多次指定选项来创建多个 NIC。这是 --nic port-id=<port& gt; 参数的一个打包程序,它为将新的服务器连接到给定端口的标准用例提供简单的语法。有关更高级的用例,请参阅 --nic 参数。

--hint <key=value>

调度程序的提示(可选扩展)

--config-drive <config-drive-volume>|True

使用指定的卷作为配置驱动器,或 true 来使用临时驱动器

--min <count>

要启动的最小服务器数量(默认=1)

--max <count>

要启动的最大服务器数量(默认=1)

--wait

等待构建完成

表 70.21. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 70.22. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 70.23. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 70.24. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

70.9. 服务器删除

删除服务器

使用方法:

openstack server delete [-h] [--wait] <server> [<server> ...]

表 70.25. positional 参数
概述

<server>

要删除的服务器(名称或 id)

表 70.26. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait

等待删除完成

70.10. 服务器转储创建

在服务器中创建转储文件 Trigger 崩溃转储,其功能(如 Linux 中的 kdump )。它将在服务器上创建一个转储文件,从而转储服务器的内存,并崩溃服务器。OSC 将转储文件(服务器转储)视为资源类型。此命令需要 ''-os-compute-api- version' 2.17 或更高版本。

使用方法:

openstack server dump create [-h] <server> [<server> ...]

表 70.27. positional 参数
概述

<server>

创建转储文件的服务器(名称或 id)

表 70.28. 命令参数
概述

-h, --help

显示帮助信息并退出

70.11. 服务器事件列表

列出服务器的最近事件。指定 ''--os-compute-api-version 2.21'' 或更高,以显示已删除的服务器的事件,仅由 ID 指定。

使用方法:

openstack server event list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN] [--long]
                                   <server>

表 70.29. positional 参数
概述

<server>

服务器列出事件(名称或 id)

表 70.30. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 70.31. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 70.32. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 70.33. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 70.34. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

70.12. 服务器事件显示

显示服务器事件详情。指定 ''--os-compute-api-version 2.21'' 或更高版本来显示已删除服务器的事件详情,仅由 ID 指定。指定 ''--os-compute-api-version 2.51' 或更高版本来显示非管理员用户的事件详情。

使用方法:

openstack server event show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <server> <request-id>

表 70.35. positional 参数
概述

<server>

服务器以显示事件详情(名称或 id)

<request-id>

要显示的事件的请求 ID (仅限id)

表 70.36. 命令参数
概述

-h, --help

显示帮助信息并退出

表 70.37. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 70.38. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 70.39. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 70.40. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

70.13. 服务器组创建

创建新服务器组。

使用方法:

openstack server group create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--policy <policy>] [--rule <key=value>]
                                     <name>

表 70.41. positional 参数
概述

<name>

新服务器组名称

表 70.42. 命令参数
概述

-h, --help

显示帮助信息并退出

--policy <policy>

在 <name> 中添加策略( 关联性 或反关联性,默认为 关联性)。为 soft-affinitysoft-anti-affinity 策略指定 --os-compute-api- 版本 2.15 或更高版本。

--rule <key=value>

策略的规则。目前,反关联性 策略只支持 max_server_per_host 规则。

表 70.43. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 70.44. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 70.45. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 70.46. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

70.14. 服务器组删除

删除现有的服务器组。

使用方法:

openstack server group delete [-h] <server-group> [<server-group> ...]

表 70.47. positional 参数
概述

<server-group>

要删除的服务器组(名称或 id)

表 70.48. 命令参数
概述

-h, --help

显示帮助信息并退出

70.15. 服务器组列表

列出所有服务器组。

使用方法:

openstack server group list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--all-projects] [--long]

表 70.49. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的信息(仅限 admin)

--long

列出输出中的其他字段

表 70.50. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 70.51. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 70.52. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 70.53. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

70.16. 服务器组显示

显示服务器组详细信息。

使用方法:

openstack server group show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <server-group>

表 70.54. positional 参数
概述

<server-group>

要显示的服务器组(名称或 id)

表 70.55. 命令参数
概述

-h, --help

显示帮助信息并退出

表 70.56. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 70.57. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 70.58. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 70.59. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

70.17. 服务器镜像创建

从现有服务器创建新服务器磁盘镜像

使用方法:

openstack server image create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--name <image-name>] [--wait]
                                     <server>

表 70.60. positional 参数
概述

<server>

要创建镜像的服务器(名称或 id)

表 70.61. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <image-name>

新磁盘镜像的名称(默认:服务器名称)

--wait

等待操作完成

表 70.62. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 70.63. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 70.64. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 70.65. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

70.18. 服务器列表

列出服务器

使用方法:

openstack server list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN]
                             [--reservation-id <reservation-id>]
                             [--ip <ip-address-regex>]
                             [--ip6 <ip-address-regex>] [--name <name-regex>]
                             [--instance-name <server-name>]
                             [--status <status>] [--flavor <flavor>]
                             [--image <image>] [--host <hostname>]
                             [--all-projects] [--project <project>]
                             [--project-domain <project-domain>]
                             [--user <user>] [--user-domain <user-domain>]
                             [--long] [-n | --name-lookup-one-by-one]
                             [--marker <server>] [--limit <num-servers>]
                             [--deleted] [--changes-before <changes-before>]
                             [--changes-since <changes-since>]
                             [--locked | --unlocked]

表 70.66. 命令参数
概述

-h, --help

显示帮助信息并退出

--reservation-id <reservation-id>

仅返回与保留匹配的实例

--ip <ip-address-regex>

匹配 ip 地址的正则表达式

--ip6 <ip-address-regex>

匹配 ipv6 地址的正则表达式。请注意,在使用 '--os-compute-api-version' 2.5 或更高版本时,这个选项只适用于非 admin 用户。

--name <name-regex>

匹配名称的正则表达式

--instance-name <server-name>

匹配实例名称的正则表达式(仅限 admin)

--status <status>

按服务器状态搜索

--flavor <flavor>

按类别搜索(名称或 id)

--image <image>

按镜像搜索(名称或 id)

--host <hostname>

按主机名搜索

--all-projects

包括所有项目(仅限管理员)

--project <project>

按项目搜索(仅限管理员)(名称或 ID)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--user <user>

按用户搜索(仅限管理员)(名称或 id)

--user-domain <user-domain>

用户所属的域(名称或 id)。这可用于在用户名之间存在冲突时使用。

--long

列出输出中的其他字段

-n, --no-name-lookup

跳过类别和镜像名称 lookup。通过 "--name-lookup-one" 选项相互排斥。

--name-lookup-one-by-one

查找类别和镜像名称时,根据需要查找它们,而不是全部查找(默认)。与 "--no-name- lookup|-n" 选项相互排斥。

--marker <server>

上一页的最后一台服务器。标记后显示服务器列表。如果未指定,则显示所有服务器。与 '--deleted' 一起使用时,标记必须是 ID,否则可以使用名称或 ID。

--limit <num-servers>

要显示的最大服务器数。如果限制等于 -1,则会显示所有服务器。如果限制大于 Nova API 的 osapi_max_limit 选项,则将改为使用 osapi_max_limit

--deleted

仅显示已删除的服务器(仅限管理员)。

--changes-before <changes-before>

仅列出在特定时间点之前更改的服务器。提供的时间应该是 ISO 8061 格式的时间(如 2016-03-05T06:27:59Z)。(由 API 版本 2.66 支持 - 2.latest

--changes-since <changes-since>

仅列出特定时间后更改的服务器。提供的时间应该是 ISO 8061 格式的时间(如 2016-03-04T06:27:59Z)。

--locked

仅显示锁定的服务器。需要 '--os-compute- api-version'' 2.73 或更高版本。

--unlocked

仅显示解锁的服务器。需要 '--os- compute-api-version'' 2.73 或更高版本。

表 70.67. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 70.68. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 70.69. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 70.70. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

70.19. 服务器锁定

锁定服务器。非管理员用户将无法执行操作

使用方法:

openstack server lock [-h] [--reason <reason>] <server> [<server> ...]

表 70.71. positional 参数
概述

<server>

要锁定的服务器(名称或 id)

表 70.72. 命令参数
概述

-h, --help

显示帮助信息并退出

--reason <reason>

锁定服务器的原因,需要 ''-os- compute-api-version'' 2.73 或更高版本。

70.20. 服务器迁移

将服务器迁移到其他主机

使用方法:

openstack server migrate [-h] [--live-migration]
                                [--live <hostname> | --host <hostname>]
                                [--shared-migration | --block-migration]
                                [--disk-overcommit | --no-disk-overcommit]
                                [--wait]
                                <server>

表 70.73. positional 参数
概述

<server>

server (名称或 id)

表 70.74. 命令参数
概述

-h, --help

显示帮助信息并退出

--live-migration

实时迁移服务器。使用 '--host' 选项为迁移指定目标主机,它将由调度程序进行验证。

--live <hostname>

弃用 此选项有问题,因为它需要主机并在计算 API 版本 2.30 之前,在实时迁移期间指定主机将绕过调度程序,这可能会导致服务器实际迁移到指定主机或超额订阅主机。使用 ''--live-migration' 选项替代。如果同时使用这个选项和 '--live-migration'',则 '--live- migration'' 将具有优先权。

--host <hostname>

将服务器迁移到指定的主机。在与 '--live-migration' 选项一起使用时,需要 ''--os-compute-api-version'' 2.30 或更高版本,否则需要 ''--os-compute-api-version' 2.56 或更高版本。

--shared-migration

执行共享实时迁移(默认)

--block-migration

执行块实时迁移

--disk-overcommit

允许目标主机上的磁盘超额提交

--no-disk-overcommit

不要在目标主机上超额提交磁盘(默认)

--wait

等待迁移完成

70.21. 服务器暂停

暂停服务器

使用方法:

openstack server pause [-h] <server> [<server> ...]

表 70.75. positional 参数
概述

<server>

要暂停的服务器(名称或 id)

表 70.76. 命令参数
概述

-h, --help

显示帮助信息并退出

70.22. 服务器重启

执行硬或软服务器重启

使用方法:

openstack server reboot [-h] [--hard | --soft] [--wait] <server>

表 70.77. positional 参数
概述

<server>

server (名称或 id)

表 70.78. 命令参数
概述

-h, --help

显示帮助信息并退出

--hard

执行硬重启

--soft

执行软重启

--wait

等待重启完成

70.23. 服务器重建

重建服务器

使用方法:

openstack server rebuild [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--image <image>]
                                [--password <password>]
                                [--property <key=value>]
                                [--description <description>] [--wait]
                                [--key-name <key-name> | --key-unset]
                                <server>

表 70.79. positional 参数
概述

<server>

server (名称或 id)

表 70.80. 命令参数
概述

-h, --help

显示帮助信息并退出

--image <image>

从指定镜像(名称或 id)重新创建服务器。默认为当前使用的。

--password <password>

在重建的实例上设置密码

--property <key=value>

在重建的实例上设置属性(重复选项来设置多个值)

--description <description>

服务器的新描述(由 --os- compute-api-version 2.19 或更高版本支持)

--wait

等待重建完成

--key-name <key-name>

在重新构建的实例上设置密钥对的密钥对名称。不能使用 --key-unset 选项指定。(由 API 版本 2.54 支持 - 2.latest

--key-unset

在重建的实例中取消设置密钥对的密钥对名称。不能使用 --key-name 选项指定。(由 API 版本 2.54 支持 - 2.latest

表 70.81. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 70.82. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 70.83. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 70.84. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

70.24. 服务器删除固定的 ip

从服务器中删除固定 IP 地址

使用方法:

openstack server remove fixed ip [-h] <server> <ip-address>

表 70.85. positional 参数
概述

<server>

服务器从中删除固定的 ip 地址(名称或 id)

<ip-address>

修复了要从服务器中删除的 ip 地址(仅限 IP 地址)

表 70.86. 命令参数
概述

-h, --help

显示帮助信息并退出

70.25. 服务器删除浮动 IP

从服务器中删除浮动 IP 地址

使用方法:

openstack server remove floating ip [-h] <server> <ip-address>

表 70.87. positional 参数
概述

<server>

服务器从中删除浮动 IP 地址(名称或 id)

<ip-address>

要从服务器中删除的浮动 IP 地址(仅限 IP 地址)

表 70.88. 命令参数
概述

-h, --help

显示帮助信息并退出

70.26. 服务器删除网络

从服务器中删除网络的所有端口

使用方法:

openstack server remove network [-h] <server> <network>

表 70.89. positional 参数
概述

<server>

服务器要从中删除端口(名称或 id)

<network>

要从服务器中删除的网络(名称或 id)

表 70.90. 命令参数
概述

-h, --help

显示帮助信息并退出

70.27. 服务器删除端口

从服务器中删除端口

使用方法:

openstack server remove port [-h] <server> <port>

表 70.91. positional 参数
概述

<server>

服务器要从中删除端口(名称或 id)

<port>

从服务器中删除的端口(名称或 id)

表 70.92. 命令参数
概述

-h, --help

显示帮助信息并退出

70.28. 服务器删除安全组

从服务器中删除安全组

使用方法:

openstack server remove security group [-h] <server> <group>

表 70.93. positional 参数
概述

<server>

要使用的服务器的名称或 ID

<bx id="1" />

要从服务器中删除的安全组的名称或 ID

表 70.94. 命令参数
概述

-h, --help

显示帮助信息并退出

70.29. 服务器删除卷

从服务器中删除卷。指定 ''--os-compute-api-version 2.20'' 或更高版本,从状态为 ''SHELVED' 或 ''SHELVED_OFFLOADED'' 的服务器中删除卷。

使用方法:

openstack server remove volume [-h] <server> <volume>

表 70.95. positional 参数
概述

<server>

server (名称或 id)

<volume>

要删除的卷(名称或 id)

表 70.96. 命令参数
概述

-h, --help

显示帮助信息并退出

70.30. 服务器救援

将服务器置于救援模式

使用方法:

openstack server rescue [-h] [--image <image>] [--password <password>]
                               <server>

表 70.97. positional 参数
概述

<server>

server (名称或 id)

表 70.98. 命令参数
概述

-h, --help

显示帮助信息并退出

--image <image>

用于救援模式的镜像(名称或 id)。默认为当前使用的。

--password <password>

在救援实例上设置密码

70.31. 服务器调整大小确认

确认服务器调整大小。确认(验证)调整大小操作并释放旧服务器。

使用方法:

openstack server resize confirm [-h] <server>

表 70.99. positional 参数
概述

<server>

server (名称或 id)

表 70.100. 命令参数
概述

-h, --help

显示帮助信息并退出

70.32. 服务器重新定义恢复

恢复服务器调整大小。恢复调整大小的操作。释放新的服务器并重新启动旧服务器。

使用方法:

openstack server resize revert [-h] <server>

表 70.101. positional 参数
概述

<server>

server (名称或 id)

表 70.102. 命令参数
概述

-h, --help

显示帮助信息并退出

70.33. 服务器调整大小

将服务器扩展到新类别。通过创建新服务器并将原始磁盘的内容复制到新的磁盘来实现调整大小操作。它还是用户的两步过程:第一步骤是执行调整大小,第二个是确认(验证)成功并释放旧服务器,或者声明恢复来释放新的服务器并重新启动旧服务器。

使用方法:

openstack server resize [-h] [--flavor <flavor> | --confirm | --revert]
                               [--wait]
                               <server>

表 70.103. positional 参数
概述

<server>

server (名称或 id)

表 70.104. 命令参数
概述

-h, --help

显示帮助信息并退出

--flavor <flavor>

将服务器调整为指定类别

--confirm

确认服务器调整大小已完成

--revert

在调整大小前恢复服务器状态

--wait

等待调整大小完成

70.34. 服务器恢复

恢复服务器

使用方法:

openstack server restore [-h] <server> [<server> ...]

表 70.105. positional 参数
概述

<server>

要恢复的服务器(名称或 id)

表 70.106. 命令参数
概述

-h, --help

显示帮助信息并退出

70.35. 服务器恢复

恢复服务器

使用方法:

openstack server resume [-h] <server> [<server> ...]

表 70.107. positional 参数
概述

<server>

要恢复的服务器(名称或 id)

表 70.108. 命令参数
概述

-h, --help

显示帮助信息并退出

70.36. 服务器集

设置服务器属性

使用方法:

openstack server set [-h] [--name <new-name>] [--root-password]
                            [--property <key=value>] [--state <state>]
                            [--description <description>]
                            <server>

表 70.109. positional 参数
概述

<server>

server (名称或 id)

表 70.110. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <new-name>

新服务器名称

--root-password

设置新的 root 密码(仅限交互式)

--property <key=value>

为这个服务器添加/更改的属性(重复选项来设置多个属性)

--state <state>

新服务器状态(valid 值:active、error)

--description <description>

新的服务器描述(由 --os-compute-api- 版本 2.19 或更高版本支持)

70.37. 服务器 shelve

shelve 服务器

使用方法:

openstack server shelve [-h] <server> [<server> ...]

表 70.111. positional 参数
概述

<server>

到 shelve 的服务器(名称或 id)

表 70.112. 命令参数
概述

-h, --help

显示帮助信息并退出

70.38. 服务器显示

显示服务器详细信息。指定 ''--os-compute-api-version 2.47'' 或更高,以查看服务器的嵌入式类别信息。

使用方法:

openstack server show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--diagnostics]
                             <server>

表 70.113. positional 参数
概述

<server>

server (名称或 id)

表 70.114. 命令参数
概述

-h, --help

显示帮助信息并退出

--diagnostics

显示服务器诊断信息

表 70.115. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 70.116. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 70.117. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 70.118. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

70.39. 服务器 ssh

SSH 到服务器

使用方法:

openstack server ssh [-h] [--login <login-name>] [--port <port>]
                            [--identity <keyfile>] [--option <config-options>]
                            [-4 | -6]
                            [--public | --private | --address-type <address-type>]
                            <server>

表 70.119. positional 参数
概述

<server>

server (名称或 id)

表 70.120. 命令参数
概述

-h, --help

显示帮助信息并退出

--login <login-name>

登录名(ssh -l 选项)

--port <port>

目的端口(ssh -p 选项)

--identity <keyfile>

私钥文件(ssh -i 选项)

--option <config-options>

ssh_config (5)格式的选项(ssh -o 选项)

-4

只使用 ipv4 地址

-6

只使用 ipv6 地址

--public

使用公共 IP 地址

--private

使用私有 ip 地址

--address-type <address-type>

使用其他 ip 地址(公共、私有等)

70.40. 服务器启动

启动服务器。

使用方法:

openstack server start [-h] <server> [<server> ...]

表 70.121. positional 参数
概述

<server>

要启动的服务器(名称或 id)

表 70.122. 命令参数
概述

-h, --help

显示帮助信息并退出

70.41. 服务器停止

停止服务器。

使用方法:

openstack server stop [-h] <server> [<server> ...]

表 70.123. positional 参数
概述

<server>

要停止的服务器(名称或 id)

表 70.124. 命令参数
概述

-h, --help

显示帮助信息并退出

70.42. 服务器挂起

挂起服务器

使用方法:

openstack server suspend [-h] <server> [<server> ...]

表 70.125. positional 参数
概述

<server>

要挂起的服务器(名称或 id)

表 70.126. 命令参数
概述

-h, --help

显示帮助信息并退出

70.43. 服务器解锁

解锁服务器

使用方法:

openstack server unlock [-h] <server> [<server> ...]

表 70.127. positional 参数
概述

<server>

要解锁的服务器(名称或 id)

表 70.128. 命令参数
概述

-h, --help

显示帮助信息并退出

70.44. 服务器取消暂停

取消暂停服务器

使用方法:

openstack server unpause [-h] <server> [<server> ...]

表 70.129. positional 参数
概述

<server>

要取消暂停的服务器(名称或 id)

表 70.130. 命令参数
概述

-h, --help

显示帮助信息并退出

70.45. 服务器 unrescue

从救援模式恢复服务器

使用方法:

openstack server unrescue [-h] <server>

表 70.131. positional 参数
概述

<server>

server (名称或 id)

表 70.132. 命令参数
概述

-h, --help

显示帮助信息并退出

70.46. 服务器取消设置

取消设置服务器属性

使用方法:

openstack server unset [-h] [--property <key>] [--description] <server>

表 70.133. positional 参数
概述

<server>

server (名称或 id)

表 70.134. 命令参数
概述

-h, --help

显示帮助信息并退出

--property <key>

要从服务器中删除的属性键(需要删除多个值)

--description

取消设置服务器描述(由 --os-compute-api- 版本 2.19 或更高版本支持)

70.47. 服务器 unshelve

unshelve 服务器

使用方法:

openstack server unshelve [-h] [--availability-zone AVAILABILITY_ZONE]
                                 <server> [<server> ...]

表 70.135. positional 参数
概述

<server>

server (s)取消shelve (名称或 id)

表 70.136. 命令参数
概述

-h, --help

显示帮助信息并退出

--availability-zone AVAILABILITY_ZONE

取消 SHELVED_OFFLOADED 服务器的可用区的名称(由 --os-compute- api-version 2.77 或更高版本支持)

第 71 章 service

本章描述了 service 命令下的命令。

71.1. service create

创建新服务

使用方法:

openstack service create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--name <name>]
                                [--description <description>]
                                [--enable | --disable]
                                <type>

表 71.1. positional 参数
概述

<type>

新服务类型(compute、镜像、身份、卷等)

表 71.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新服务名称

--description <description>

新服务描述

--enable

启用服务(默认)

--disable

禁用服务

表 71.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 71.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 71.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 71.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

71.2. service delete

删除服务

使用方法:

openstack service delete [-h] <service> [<service> ...]

表 71.7. positional 参数
概述

<service>

要删除的服务(类型、名称或 ID)

表 71.8. 命令参数
概述

-h, --help

显示帮助信息并退出

71.3. 服务列表

列出服务

使用方法:

openstack service list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN] [--long]

表 71.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 71.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 71.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 71.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 71.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

71.4. 服务提供商创建

创建新服务提供商

使用方法:

openstack service provider create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty] --auth-url <auth-url>
                                         [--description <description>]
                                         --service-provider-url <sp-url>
                                         [--enable | --disable]
                                         <name>

表 71.14. positional 参数
概述

<name>

新服务供应商名称(必须是唯一的)

表 71.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--auth-url <auth-url>

远程联邦服务提供商的身份验证 url (必需)

--description <description>

新服务提供商描述

--service-provider-url <sp-url>

发送 saml 断言的服务 url (必需的)

--enable

启用服务供应商(默认)

--disable

禁用服务供应商

表 71.16. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 71.17. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 71.18. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 71.19. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

71.5. Service provider delete

删除服务提供商

使用方法:

openstack service provider delete [-h]
                                         <service-provider>
                                         [<service-provider> ...]

表 71.20. positional 参数
概述

<service-provider>

要删除的服务供应商

表 71.21. 命令参数
概述

-h, --help

显示帮助信息并退出

71.6. 服务提供商列表

列出服务提供商

使用方法:

openstack service provider list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]

表 71.22. 命令参数
概述

-h, --help

显示帮助信息并退出

表 71.23. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 71.24. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 71.25. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 71.26. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

71.7. 服务提供商集

设置服务提供商属性

使用方法:

openstack service provider set [-h] [--auth-url <auth-url>]
                                      [--description <description>]
                                      [--service-provider-url <sp-url>]
                                      [--enable | --disable]
                                      <service-provider>

表 71.27. positional 参数
概述

<service-provider>

要修改的服务提供商

表 71.28. 命令参数
概述

-h, --help

显示帮助信息并退出

--auth-url <auth-url>

远程联邦服务提供商的新身份验证 URL

--description <description>

新服务提供商描述

--service-provider-url <sp-url>

新的服务提供商 url,其中发送 saml 断言

--enable

启用服务供应商

--disable

禁用服务供应商

71.8. 服务提供商显示

显示服务提供商详情

使用方法:

openstack service provider show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <service-provider>

表 71.29. positional 参数
概述

<service-provider>

要显示的服务供应商

表 71.30. 命令参数
概述

-h, --help

显示帮助信息并退出

表 71.31. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 71.32. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 71.33. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 71.34. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

71.9. 服务集

设置服务属性

使用方法:

openstack service set [-h] [--type <type>] [--name <service-name>]
                             [--description <description>]
                             [--enable | --disable]
                             <service>

表 71.35. positional 参数
概述

<service>

要修改的服务(类型、名称或 id)

表 71.36. 命令参数
概述

-h, --help

显示帮助信息并退出

--type <type>

新服务类型(compute、镜像、身份、卷等)

--name <service-name>

新服务名称

--description <description>

新服务描述

--enable

启用服务

--disable

禁用服务

71.10. 服务显示

显示服务详情

使用方法:

openstack service show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <service>

表 71.37. positional 参数
概述

<service>

要显示的服务(类型、名称或 id)

表 71.38. 命令参数
概述

-h, --help

显示帮助信息并退出

表 71.39. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 71.40. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 71.41. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 71.42. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 72 章 sfc

本章描述了 sfc 命令下的命令。

72.1. sfc 流分类器创建

创建流分类符

使用方法:

openstack sfc flow classifier create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--description <description>]
                                            [--protocol <protocol>]
                                            [--ethertype {IPv4,IPv6}]
                                            [--source-port <min-port>:<max-port>]
                                            [--destination-port <min-port>:<max-port>]
                                            [--source-ip-prefix <source-ip-prefix>]
                                            [--destination-ip-prefix <destination-ip-prefix>]
                                            [--logical-source-port <logical-source-port>]
                                            [--logical-destination-port <logical-destination-port>]
                                            [--l7-parameters L7_PARAMETERS]
                                            <name>

表 72.1. positional 参数
概述

<name>

流分类器的名称

表 72.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

流分类器的描述

--protocol <protocol>

IP 协议名称。协议名称应该根据 iana 标准使用。

--ethertype {IPv4,IPv6}

L2 ethertype,默认为 ipv4

--source-port <min-port>:<max-port>

源协议端口(允许范围 [1,65535]. 必须指定为 a:b,其中 a=min-port 和 b=max-port)在允许范围内指定。

--destination-port <min-port>:<max-port>

目的地协议端口(允许范围 [1,65535])。必须在允许范围内指定为 a:b,其中 a=min-port 和 b=max- port。

--source-ip-prefix <source-ip-prefix>

源 IP 地址(cidr 表示法)

--destination-ip-prefix <destination-ip-prefix>

目标 IP 地址(cidr 表示法)

--logical-source-port <logical-source-port>

Neutron 源端口(名称或 id)

--logical-destination-port <logical-destination-port>

Neutron 目的地端口(名称或 id)

--l7-parameters L7_PARAMETERS

l7 参数的字典。当前,这个选项不支持任何值。

表 72.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 72.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 72.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 72.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

72.2. sfc 流分类器删除

删除给定流分类器

使用方法:

openstack sfc flow classifier delete [-h] <flow-classifier>

表 72.7. positional 参数
概述

<flow-classifier>

要删除流分类符(名称或 id)

表 72.8. 命令参数
概述

-h, --help

显示帮助信息并退出

72.3. sfc 流分类器列表

列出流分类符

使用方法:

openstack sfc flow classifier list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN] [--long]

表 72.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 72.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 72.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 72.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 72.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

72.4. sfc 流分类器集

设置流分类属性

使用方法:

openstack sfc flow classifier set [-h] [--name <name>]
                                         [--description <description>]
                                         <flow-classifier>

表 72.14. positional 参数
概述

<flow-classifier>

要修改的流分类符(名称或 id)

表 72.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

流分类器的名称

--description <description>

流分类器的描述

72.5. sfc 流分类器显示

显示流分类器详情

使用方法:

openstack sfc flow classifier show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <flow-classifier>

表 72.16. positional 参数
概述

<flow-classifier>

要显示的流程分类符(名称或 id)

表 72.17. 命令参数
概述

-h, --help

显示帮助信息并退出

表 72.18. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 72.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 72.20. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 72.21. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

72.6. sfc 端口链创建

创建端口链

使用方法:

openstack sfc port chain create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--description <description>]
                                       [--flow-classifier <flow-classifier>]
                                       [--chain-parameters correlation=<correlation-type>,symmetric=<boolean>]
                                       --port-pair-group <port-pair-group>
                                       <name>

表 72.22. positional 参数
概述

<name>

端口链的名称

表 72.23. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

端口链的描述

--flow-classifier <flow-classifier>

添加流分类符(name 或 id)。此选项可以被重复。

--chain-parameters correlation=<correlation-type>,symmetric=<boolean>

链参数的字典。支持 correlation=(mpls|nsh) (默认为 mpls)和 symmetric=(true|false)。

--port-pair-group <port-pair-group>

添加端口对组(名称或 id)。此选项可以被重复。

表 72.24. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 72.25. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 72.26. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 72.27. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

72.7. sfc 端口链删除

删除给定端口链

使用方法:

openstack sfc port chain delete [-h] <port-chain>

表 72.28. positional 参数
概述

<port-chain>

要删除的端口链(名称或 id)

表 72.29. 命令参数
概述

-h, --help

显示帮助信息并退出

72.8. sfc 端口链列表

列出端口链

使用方法:

openstack sfc port chain list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN] [--long]

表 72.30. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 72.31. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 72.32. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 72.33. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 72.34. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

72.9. sfc 端口链集

设置端口链属性

使用方法:

openstack sfc port chain set [-h] [--name <name>]
                                    [--description <description>]
                                    [--flow-classifier <flow-classifier>]
                                    [--no-flow-classifier]
                                    [--port-pair-group <port-pair-group>]
                                    [--no-port-pair-group]
                                    <port-chain>

表 72.35. positional 参数
概述

<port-chain>

要修改的端口链(名称或 id)

表 72.36. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

端口链的名称

--description <description>

端口链的描述

--flow-classifier <flow-classifier>

添加流分类符(name 或 id)。此选项可以被重复。

--no-flow-classifier

从端口链中删除关联的流分类器

--port-pair-group <port-pair-group>

添加端口对组(名称或 id)。当前端口对组顺序被保留,添加的端口对组将放在端口链的末尾。这个选项可以被重复。

--no-port-pair-group

从端口链中删除关联的端口对组。必须至少指定一个 --port-pair-group。

72.10. sfc 端口链显示

显示端口链详情

使用方法:

openstack sfc port chain show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <port-chain>

表 72.37. positional 参数
概述

<port-chain>

要显示的端口链(名称或 id)

表 72.38. 命令参数
概述

-h, --help

显示帮助信息并退出

表 72.39. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 72.40. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 72.41. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 72.42. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

72.11. sfc 端口链取消设置

取消设置端口链属性

使用方法:

openstack sfc port chain unset [-h]
                                      [--flow-classifier <flow-classifier> | --all-flow-classifier]
                                      [--port-pair-group <port-pair-group>]
                                      <port-chain>

表 72.43. positional 参数
概述

<port-chain>

端口链不设置(名称或 id)

表 72.44. 命令参数
概述

-h, --help

显示帮助信息并退出

--flow-classifier <flow-classifier>

从端口链(名称或 ID)中删除流分类符。这个选项可以被重复。

--all-flow-classifier

从端口链中删除所有流分类器

--port-pair-group <port-pair-group>

从端口链(名称或 ID)中删除端口对组。这个选项可以被重复。

72.12. sfc 端口对创建的

创建端口对

使用方法:

openstack sfc port pair create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--description <description>]
                                      [--service-function-parameters correlation=<correlation-type>,weight=<weight>]
                                      --ingress <ingress> --egress <egress>
                                      <name>

表 72.45. positional 参数
概述

<name>

端口对的名称

表 72.46. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

端口对的描述

--service-function-parameters correlation=<correlation-type>,weight=<weight>

服务功能参数的字典。目前,支持关联=(None|mpls|nsh)和权重。weight 是一个整数,它会影响在端口对组中为流选择端口对。权重越大,更多流将哈希到端口对。默认权重为 1。

--Ingress <ingress>

Ingress neutron 端口(名称或 id)

--egress <egress>

出口 neutron 端口(名称或 id)

表 72.47. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 72.48. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 72.49. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 72.50. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

72.13. sfc 端口对删除

删除给定端口对

使用方法:

openstack sfc port pair delete [-h] <port-pair>

表 72.51. positional 参数
概述

<port-pair>

要删除的端口对(名称或 id)

表 72.52. 命令参数
概述

-h, --help

显示帮助信息并退出

72.14. sfc 端口对组创建

创建端口对组

使用方法:

openstack sfc port pair group create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--description <description>]
                                            [--port-pair <port-pair>]
                                            [--enable-tap | --disable-tap]
                                            [--port-pair-group-parameters lb-fields=<lb-fields>]
                                            <name>

表 72.53. positional 参数
概述

<name>

端口对组的名称

表 72.54. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

端口对组的描述

--port-pair <port-pair>

端口对(名称或 id)。此选项可以被重复。

--enable-tap

此端口对组的端口对部署为被动 tap 服务功能

--disable-tap

此端口对组的端口对部署为 l3 服务功能(默认)

--port-pair-group-parameters lb-fields=<lb-fields>

端口对组参数的字典。目前只支持一个参数 lb-fields,支持.<lb-fields> 是一个负载平衡字段的列表。

表 72.55. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 72.56. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 72.57. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 72.58. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

72.15. sfc 端口对组删除

删除给定端口对组

使用方法:

openstack sfc port pair group delete [-h] <port-pair-group>

表 72.59. positional 参数
概述

<port-pair-group>

要删除的端口对组(名称或 id)

表 72.60. 命令参数
概述

-h, --help

显示帮助信息并退出

72.16. sfc port pair group list

列出端口对组

使用方法:

openstack sfc port pair group list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN] [--long]

表 72.61. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 72.62. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 72.63. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 72.64. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 72.65. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

72.17. sfc 端口对组集

设置端口对组属性

使用方法:

openstack sfc port pair group set [-h] [--name <name>]
                                         [--description <description>]
                                         [--port-pair <port-pair>]
                                         [--no-port-pair]
                                         <port-pair-group>

表 72.66. positional 参数
概述

<port-pair-group>

要修改的端口对组(名称或 id)

表 72.67. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

端口对组的名称

--description <description>

端口对组的描述

--port-pair <port-pair>

端口对(名称或 id)。此选项可以被重复。

--no-port-pair

从端口对组删除所有端口对

72.18. sfc port pair group show

显示端口对组详情

使用方法:

openstack sfc port pair group show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <port-pair-group>

表 72.68. positional 参数
概述

<port-pair-group>

要显示的端口对组(名称或 id)

表 72.69. 命令参数
概述

-h, --help

显示帮助信息并退出

表 72.70. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 72.71. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 72.72. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 72.73. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

72.19. sfc 端口对组未设置

从端口对组中取消设置端口对

使用方法:

openstack sfc port pair group unset [-h]
                                           [--port-pair <port-pair> | --all-port-pair]
                                           <port-pair-group>

表 72.74. positional 参数
概述

<port-pair-group>

要取消设置的端口对组(名称或 id)

表 72.75. 命令参数
概述

-h, --help

显示帮助信息并退出

--port-pair <port-pair>

从端口对组(名称或 ID)中删除端口对。这个选项可以被重复。

--all-port-pair

从端口对组删除所有端口对

72.20. sfc port pair list

列出端口对

使用方法:

openstack sfc port pair list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN] [--long]

表 72.76. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 72.77. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 72.78. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 72.79. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 72.80. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

72.21. sfc 端口对集

设置端口对属性

使用方法:

openstack sfc port pair set [-h] [--name <name>]
                                   [--description <description>]
                                   <port-pair>

表 72.81. positional 参数
概述

<port-pair>

要修改的端口对(名称或 id)

表 72.82. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

端口对的名称

--description <description>

端口对的描述

72.22. sfc 端口对显示

显示端口对详情

使用方法:

openstack sfc port pair show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <port-pair>

表 72.83. positional 参数
概述

<port-pair>

要显示的端口对(名称或 id)

表 72.84. 命令参数
概述

-h, --help

显示帮助信息并退出

表 72.85. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 72.86. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 72.87. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 72.88. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

72.23. sfc 服务图创建

创建服务图。

使用方法:

openstack sfc service graph create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--description DESCRIPTION]
                                          --branching-point
                                          SRC_CHAIN:DST_CHAIN_1,DST_CHAIN_2,DST_CHAIN_N
                                          <name>

表 72.89. positional 参数
概述

<name>

服务图的名称。

表 72.90. 命令参数
概述

-h, --help

显示帮助信息并退出

--description DESCRIPTION

服务图的描述。

--branching-point SRC_CHAIN:DST_CHAIN_1,DST_CHAIN_2,DST_CHAIN_N

服务图形分支点:键是源端口链,而值是目标端口链的列表。这个选项可以被重复。

表 72.91. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 72.92. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 72.93. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 72.94. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

72.24. sfc 服务图删除

删除给定服务图。

使用方法:

openstack sfc service graph delete [-h] <service-graph>

表 72.95. positional 参数
概述

<service-graph>

要删除的服务图形的 ID 或名称。

表 72.96. 命令参数
概述

-h, --help

显示帮助信息并退出

72.25. sfc 服务图列表

列出服务图

使用方法:

openstack sfc service graph list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN] [--long]

表 72.97. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 72.98. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 72.99. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 72.100. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 72.101. 表格式器选项
概述

--max-width <integer>

最大显示宽度 <1 要禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。如果 --max-width 大于 0,则表示表示。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示的数据,打印空表。

72.26. sfc 服务图形集

设置服务图形属性

使用方法:

openstack sfc service graph set [-h] [--name <name>]
                                       [--description <description>]
                                       <service-graph>

表 72.102. positional 参数
概述

<service-graph>

用于修改的服务图(名称或 id)

表 72.103. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

服务图的名称

--description <description>

服务图的描述

72.27. sfc 服务图显示

显示给定服务图的信息。

使用方法:

openstack sfc service graph show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <service-graph>

表 72.104. positional 参数
概述

<service-graph>

要显示的服务图的 ID 或名称。

表 72.105. 命令参数
概述

-h, --help

显示帮助信息并退出

表 72.106. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 72.107. JSON 格式选项
概述

--noindent

是否禁用缩进 json

表 72.108. Shell formatter 选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 72.109. 表格式器选项
概述

--max-width <integer>

最大显示宽度 <1 要禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。如果 --max-width 大于 0,则表示表示。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示的数据,打印空表。

第 73 章 software

本章论述了 软件 命令下的命令。

73.1. 软件配置创建

创建软件配置

使用方法:

openstack software config create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--config-file <config-file>]
                                        [--definition-file <destination-file>]
                                        [--group <group>]
                                        <config-name>

表 73.1. positional 参数
概述

<config-name>

要创建的软件配置的名称

表 73.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--config-file <config-file>

包含定义 <inputs>、<outputs> 和 <options> 的映射的路径

--definition-file <destination-file>

软件配置脚本/数据的路径

--group <group>

软件配置预期的工具组名称

表 73.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 json

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 73.4. JSON 格式选项
概述

--noindent

是否禁用缩进 json

表 73.5. Shell formatter 选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 73.6. 表格式器选项
概述

--max-width <integer>

最大显示宽度 <1 要禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。如果 --max-width 大于 0,则表示表示。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示的数据,打印空表。

73.2. 软件配置删除

删除软件配置

使用方法:

openstack software config delete [-h] <config> [<config> ...]

表 73.7. positional 参数
概述

<config>

要删除的软件配置的 ID

表 73.8. 命令参数
概述

-h, --help

显示帮助信息并退出

73.3. 软件配置列表

列出软件配置

使用方法:

openstack software config list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--limit <limit>] [--marker <id>]

表 73.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

限制返回的配置数量

--marker <id>

返回给定配置 ID 后出现的配置

表 73.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定要对数据进行排序的列(首先指定的列有优先级,非现有列将被忽略),可以重复执行

表 73.11. CSV 格式选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,则默认为非数字

表 73.12. JSON 格式选项
概述

--noindent

是否禁用缩进 json

表 73.13. 表格式器选项
概述

--max-width <integer>

最大显示宽度 <1 要禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。如果 --max-width 大于 0,则表示表示。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示的数据,打印空表。

73.4. 软件配置显示

显示软件配置详情

使用方法:

openstack software config show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--config-only]
                                      <config>

表 73.14. positional 参数
概述

<config>

配置的 ID

表 73.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--config-only

仅显示 <config> 属性的值。

表 73.16. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 73.17. JSON 格式选项
概述

--noindent

是否禁用缩进 json

表 73.18. Shell formatter 选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 73.19. 表格式器选项
概述

--max-width <integer>

最大显示宽度 <1 要禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。如果 --max-width 大于 0,则表示表示。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示的数据,打印空表。

73.5. 软件部署创建

创建软件部署。

使用方法:

openstack software deployment create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--input-value <key=value>]
                                            [--action <action>]
                                            [--config <config>]
                                            [--signal-transport <signal-transport>]
                                            [--container <container>]
                                            [--timeout <timeout>] --server
                                            <server>
                                            <deployment-name>

表 73.20. positional 参数
概述

<deployment-name>

与此部署关联的派生配置的名称。这用于对当前部署到服务器的配置列表应用排序顺序。

表 73.21. 命令参数
概述

-h, --help

显示帮助信息并退出

--input-value <key=value>

要在部署上设置的输入值。这可以多次指定。

--action <action>

此部署的操作名称。可以是自定义操作,也可以是 CREATE、UPDATE、DELETE、SUSPEND、RESUME 之一。默认为 UPDATE

--config <config>

要部署的配置 ID

--signal-transport <signal-transport>

服务器应该如何使用部署输出值向 heat 发出信号。TEMP_URL_SIGNAL 将创建一个 Swift TempURL,以通过 HTTP PUT 发出信号。ZAQAR_SIGNAL 将创建一个专用的 zaqar 队列,以使用提供的 keystone 凭据发出信号。NO_SIGNAL 将导致资源进入 COMPLETE 状态,而不等待任何信号

--container <container>

用于存储 temp_url_signal 对象的容器的可选名称。如果没有指定容器,则使用从 DEPLOY_NAME 派生的名称来创建容器

--timeout <timeout>

部署超时时间(分钟)

--server <server>

部署到的服务器 ID

表 73.22. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 73.23. JSON 格式选项
概述

--noindent

是否禁用缩进 json

表 73.24. Shell formatter 选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 73.25. 表格式器选项
概述

--max-width <integer>

最大显示宽度 <1 要禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。如果 --max-width 大于 0,则表示表示。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示的数据,打印空表。

73.6. 软件部署删除

删除软件部署以及相对的配置。

使用方法:

openstack software deployment delete [-h]
                                            <deployment> [<deployment> ...]

表 73.26. positional 参数
概述

<deployment>

要删除的部署 ID。

表 73.27. 命令参数
概述

-h, --help

显示帮助信息并退出

73.7. 软件部署列表

列出软件部署。

使用方法:

openstack software deployment list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--noindent] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--sort-column SORT_COLUMN]
                                          [--server <server>] [--long]

表 73.28. 命令参数
概述

-h, --help

显示帮助信息并退出

--server <server>

要获取部署的服务器的 ID

--long

列出输出中的更多字段

表 73.29. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定要对数据进行排序的列(首先指定的列有优先级,非现有列将被忽略),可以重复执行

表 73.30. CSV 格式选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,则默认为非数字

表 73.31. JSON 格式选项
概述

--noindent

是否禁用缩进 json

表 73.32. 表格式器选项
概述

--max-width <integer>

最大显示宽度 <1 要禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。如果 --max-width 大于 0,则表示表示。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示的数据,打印空表。

73.8. 软件部署元数据显示

获取指定服务器的部署配置元数据。

使用方法:

openstack software deployment metadata show [-h] <server>

表 73.33. positional 参数
概述

<server>

要获取部署的服务器的 ID

表 73.34. 命令参数
概述

-h, --help

显示帮助信息并退出

73.9. 软件部署输出显示

显示特定的部署输出。

使用方法:

openstack software deployment output show [-h] [--all] [--long]
                                                 <deployment> [<output-name>]

表 73.35. positional 参数
概述

<deployment>

显示输出的部署 ID

<output-name>

要显示的输出名称

表 73.36. 命令参数
概述

-h, --help

显示帮助信息并退出

--all

显示所有部署输出

--long

显示输出中的完整部署日志

73.10. 软件部署显示

显示 SoftwareDeployment 详情。

使用方法:

openstack software deployment show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--long]
                                          <deployment>

表 73.37. positional 参数
概述

<deployment>

部署的 ID

表 73.38. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

显示输出中的更多字段

表 73.39. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 73.40. JSON 格式选项
概述

--noindent

是否禁用缩进 json

表 73.41. Shell formatter 选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 73.42. 表格式器选项
概述

--max-width <integer>

最大显示宽度 <1 要禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。如果 --max-width 大于 0,则表示表示。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示的数据,打印空表。

第 74 章 queue

本章描述了 stack 命令中的命令。

74.1. 堆栈带外

带外堆栈和输出结果.

使用方法:

openstack stack abandon [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--output-file <output-file>]
                               <stack>

表 74.1. positional 参数
概述

<stack>

到带的堆栈的名称或 id

表 74.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--output-file <output-file>

输出带外结果的文件

表 74.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 json

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 74.4. JSON 格式选项
概述

--noindent

是否禁用缩进 json

表 74.5. Shell formatter 选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.6. 表格式器选项
概述

--max-width <integer>

最大显示宽度 <1 要禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。如果 --max-width 大于 0,则表示表示。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示的数据,打印空表。

74.2. 堆栈采用

采用堆栈。

使用方法:

openstack stack adopt [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [-e <environment>]
                             [--timeout <timeout>] [--enable-rollback]
                             [--parameter <key=value>] [--wait] --adopt-file
                             <adopt-file>
                             <stack-name>

表 74.7. positional 参数
概述

<stack-name>

要采用的堆栈的名称

表 74.8. 命令参数
概述

-h, --help

显示帮助信息并退出

-e <environment>, --environment <environment>

环境的路径。可多次指定

--timeout <timeout>

堆栈创建超时(以分钟为单位)

--enable-rollback

在 create/update 失败时启用回滚

--parameter <key=value>

用于创建堆栈的参数值可多次指定

--wait

等待堆栈采用完成

--adopt-file <adopt-file>

采用堆栈数据文件的路径

表 74.9. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 74.10. JSON 格式选项
概述

--noindent

是否禁用缩进 json

表 74.11. Shell formatter 选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.12. 表格式器选项
概述

--max-width <integer>

最大显示宽度 <1 要禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。如果 --max-width 大于 0,则表示表示。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示的数据,打印空表。

74.3. 堆栈取消

取消堆栈的当前任务。支持的取消任务:* update * create

使用方法:

openstack stack cancel [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN] [--wait]
                              [--no-rollback]
                              <stack> [<stack> ...]

表 74.13. positional 参数
概述

<stack>

要取消(名称或 id)的堆栈

表 74.14. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait

等待取消完成

--no-rollback

取消没有回滚

表 74.15. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 74.16. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 74.17. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.18. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.4. 堆栈检查

检查堆栈。

使用方法:

openstack stack check [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--wait]
                             <stack> [<stack> ...]

表 74.19. positional 参数
概述

<stack>

用于检查更新(名称或 id)的堆栈

表 74.20. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait

等待检查完成

表 74.21. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 74.22. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 74.23. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.24. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.5. 堆栈创建

创建堆栈。

使用方法:

openstack stack create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [-e <environment>]
                              [--timeout <timeout>] [--pre-create <resource>]
                              [--enable-rollback] [--parameter <key=value>]
                              [--parameter-file <key=file>] [--wait]
                              [--tags <tag1,tag2...>] [--dry-run] -t
                              <template>
                              <stack-name>

表 74.25. positional 参数
概述

<stack-name>

要创建的堆栈的名称

表 74.26. 命令参数
概述

-h, --help

显示帮助信息并退出

-e <environment>, --environment <environment>

到环境的路径。可多次指定

--timeout <timeout>

堆栈以分钟为单位创建超时

--pre-create <resource>

要将预先创建 hook 设置为的资源名称。嵌套堆栈中的资源可以使用斜杠作为分隔符设置: ''nested_stack/another/my_resource''。您可以使用通配符来匹配多个堆栈或资源: ''nested_stack/an598 the_resource''。这可以多次指定

--enable-rollback

在创建/更新失败时启用回滚

--parameter <key=value>

用于创建堆栈的参数值。这可以多次指定

--parameter-file <key=file>

用于创建堆栈的文件的参数值。这可以多次指定。参数值将是文件的内容

--wait

等待堆栈进入 create_complete 或 CREATE_FAILED

--tags <tag1,tag2…​>

与堆栈关联的标签列表

--dry-run

不要实际执行堆栈创建,但显示将创建的内容

-T <template>, --template <template>

模板的路径

表 74.27. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 74.28. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.29. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.30. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.6. 堆栈删除

删除堆栈。

使用方法:

openstack stack delete [-h] [-y] [--wait] <stack> [<stack> ...]

表 74.31. positional 参数
概述

<stack>

要删除的堆栈(名称或 id)

表 74.32. 命令参数
概述

-h, --help

显示帮助信息并退出

-y, --yes

跳过是/无提示(假设是)

--wait

等待堆栈删除完成

74.7. 堆栈环境显示

显示堆栈的环境。

使用方法:

openstack stack environment show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <NAME or ID>

表 74.33. positional 参数
概述

<NAME 或 ID>

要查询的堆栈的名称或 ID

表 74.34. 命令参数
概述

-h, --help

显示帮助信息并退出

表 74.35. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 74.36. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.37. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.38. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.8. 堆栈事件列表

列出事件。

使用方法:

openstack stack event list [-h] [-f {csv,json,log,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  [--resource <resource>]
                                  [--filter <key=value>] [--limit <limit>]
                                  [--marker <id>] [--nested-depth <depth>]
                                  [--sort <key>[:<direction>]] [--follow]
                                  <stack>

表 74.39. positional 参数
概述

<stack>

用于显示事件的堆栈的名称或 ID

表 74.40. 命令参数
概述

-h, --help

显示帮助信息并退出

--resource <resource>

要显示事件的资源名称。请注意:这不能使用 --nested-depth 指定

--filter <key=value>

在返回的事件中应用的过滤参数

--limit <limit>

限制返回的事件数量

--marker <id>

仅返回给定 ID 后显示的事件

--nested-depth <depth>

显示事件的嵌套堆栈的深度。注:无法使用 --resource 指定它

--sort <key>[:<direction>]

根据所选键和方向(asc 或 desc)对输出进行排序(默认为 asc)。指定要在多个键排序的次数。排序键可以是:"event_time" (default), "resource_name", "links", "logical_resource_id", "resource_status", "resource_status_reason", "physical_resource_id", 或 "id"。您可以将键留空,并指定 ":desc" 以进行反向时间排序。

--follow

打印事件,直到进程停止

表 74.41. 输出格式选项
概述

-f {csv,json,log,table,value,yaml}, --format {csv,json,log,table,value,yaml}

输出格式,默认为 log

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 74.42. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 74.43. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.44. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.9. 堆栈事件显示

显示事件详情。

使用方法:

openstack stack event show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <stack> <resource> <event>

表 74.45. positional 参数
概述

<stack>

用于显示事件的堆栈的名称或 ID

<resource>

资源事件的名称

<event>

要显示事件详情的 ID

表 74.46. 命令参数
概述

-h, --help

显示帮助信息并退出

表 74.47. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 74.48. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.49. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.50. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.10. 堆栈导出

导出堆栈数据 json。

使用方法:

openstack stack export [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--output-file <output-file>]
                              <stack>

表 74.51. positional 参数
概述

<stack>

要导出的堆栈的名称或 ID

表 74.52. 命令参数
概述

-h, --help

显示帮助信息并退出

--output-file <output-file>

输出导出数据的文件

表 74.53. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 json

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 74.54. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.55. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.56. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.11. 堆栈失败列表

显示有关失败堆栈资源的信息。

使用方法:

openstack stack failures list [-h] [--long] <stack>

表 74.57. positional 参数
概述

<stack>

要显示的堆栈(名称或 id)

表 74.58. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

在输出中显示完整的部署日志

74.12. 堆栈文件列表

显示堆栈的文件映射。

使用方法:

openstack stack file list [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <NAME or ID>

表 74.59. positional 参数
概述

<NAME 或 ID>

要查询的堆栈的名称或 ID

表 74.60. 命令参数
概述

-h, --help

显示帮助信息并退出

表 74.61. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 74.62. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.63. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.64. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.13. 堆栈 hook 清除

在给定堆栈上清除资源 hook。

使用方法:

openstack stack hook clear [-h] [--pre-create] [--pre-update]
                                  [--pre-delete]
                                  <stack> <resource> [<resource> ...]

表 74.65. positional 参数
概述

<stack>

要显示的堆栈(名称或 id)

<resource>

包含要清除的资源名称。嵌套堆栈中的资源可以使用斜杠作为分隔符设置: ''nested_stack/another/my_resource''。您可以使用通配符来匹配多个堆栈或资源: ''nested_stack/an598 the_resource''

表 74.66. 命令参数
概述

-h, --help

显示帮助信息并退出

--pre-create

清除 pre-create hook

--pre-update

清除预更新 hook

--pre-delete

清除预删除 hook

74.14. 堆栈 hook 轮询

列出堆栈带有待处理 hook 的资源。

使用方法:

openstack stack hook poll [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN]
                                 [--nested-depth <nested-depth>]
                                 <stack>

表 74.67. positional 参数
概述

<stack>

要显示的堆栈(名称或 id)

表 74.68. 命令参数
概述

-h, --help

显示帮助信息并退出

--nested-depth <nested-depth>

显示 hook 的嵌套堆栈深度

表 74.69. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 74.70. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 74.71. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.72. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.15. 堆栈列表

列出堆栈。

使用方法:

openstack stack list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--deleted] [--nested] [--hidden]
                            [--property <key=value>] [--tags <tag1,tag2...>]
                            [--tag-mode <mode>] [--limit <limit>]
                            [--marker <id>] [--sort <key>[:<direction>]]
                            [--all-projects] [--short] [--long]

表 74.73. 命令参数
概述

-h, --help

显示帮助信息并退出

--deleted

在堆栈列表中包括软删除堆栈

--nested

在堆栈列表中包括嵌套的堆栈

--hidden

在堆栈列表中包括隐藏的堆栈

--property <key=value>

过滤要在返回的堆栈上应用的属性(重复对多个属性进行过滤)

--tags <tag1,tag2…​>

要按过滤的标签列表。可以与 --tag- 模式结合使用以指定如何过滤标签

--tag-mode <mode>

过滤标签的方法。必须是"any"、"not"或"not-any"之一。如果没有指定,多个标签将与布尔值 AND 表达式结合使用

--limit <limit>

返回的堆栈数

--marker <id>

仅返回给定 ID 后出现的堆栈

--sort <key>[:<direction>]

根据所选键和方向(asc 或 desc)对输出进行排序(默认为 asc)。指定要对多个属性排序多次

--all-projects

包括所有项目(仅限管理员)

--short

列出输出中较少的字段

--long

列出输出中的其他字段,这由 --all-projects 表示

表 74.74. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 74.75. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 74.76. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.77. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.16. 堆栈输出列表

列出堆栈输出。

使用方法:

openstack stack output list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   <stack>

表 74.78. positional 参数
概述

<stack>

要查询的堆栈的名称或 ID

表 74.79. 命令参数
概述

-h, --help

显示帮助信息并退出

表 74.80. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 74.81. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 74.82. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.83. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.17. 堆栈输出显示

显示堆栈输出。

使用方法:

openstack stack output show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty] [--all]
                                   <stack> [<output>]

表 74.84. positional 参数
概述

<stack>

要查询的堆栈的名称或 ID

<output>

要显示的输出名称

表 74.85. 命令参数
概述

-h, --help

显示帮助信息并退出

--all

显示所有堆栈输出

表 74.86. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 74.87. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.88. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.89. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.18. 堆栈资源列表

列出堆栈资源。

使用方法:

openstack stack resource list [-h] [-f {csv,dot,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN] [--long]
                                     [-n <nested-depth>]
                                     [--filter <key=value>]
                                     <stack>

表 74.90. positional 参数
概述

<stack>

要查询的堆栈的名称或 ID

表 74.91. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

启用资源列表中为每个资源显示的详细信息

-n <nested-depth>, --nested-depth <nested-depth>

显示资源的嵌套堆栈的深度

--filter <key=value>

根据名称、状态、类型、操作、id 和 physical_resource_id 过滤参数以应用到返回的资源

表 74.92. 输出格式选项
概述

-f {csv,dot,json,table,value,yaml}, --format {csv,dot,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 74.93. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 74.94. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.95. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.19. 堆栈资源标记不健康

设置资源的健康状况。

使用方法:

openstack stack resource mark unhealthy [-h] [--reset]
                                               <stack> <resource> [reason]

表 74.96. positional 参数
概述

<stack>

资源所属的堆栈的名称或 ID

<resource>

资源名称

reason

状态更改的原因

表 74.97. 命令参数
概述

-h, --help

显示帮助信息并退出

--reset

将资源设置为健康

74.20. 堆栈资源元数据

显示资源元数据

使用方法:

openstack stack resource metadata [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <stack> <resource>

表 74.98. positional 参数
概述

<stack>

要显示的堆栈(名称或 id)

<resource>

要显示元数据的资源名称

表 74.99. 命令参数
概述

-h, --help

显示帮助信息并退出

表 74.100. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 json

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 74.101. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.102. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.103. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.21. 堆栈资源显示

显示堆栈资源。

使用方法:

openstack stack resource show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--with-attr <attribute>]
                                     <stack> <resource>

表 74.104. positional 参数
概述

<stack>

要查询的堆栈的名称或 ID

<resource>

资源名称

表 74.105. 命令参数
概述

-h, --help

显示帮助信息并退出

--with-attr <attribute>

要显示的属性,可以多次指定

表 74.106. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 74.107. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.108. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.109. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.22. 堆栈资源信号

使用可选数据发送资源。

使用方法:

openstack stack resource signal [-h] [--data <data>]
                                       [--data-file <data-file>]
                                       <stack> <resource>

表 74.110. positional 参数
概述

<stack>

资源所属的堆栈的名称或 ID

<resource>

向信号发送者的名称

表 74.111. 命令参数
概述

-h, --help

显示帮助信息并退出

--data <data>

要发送到信号处理器的 JSON 数据

--data-file <data-file>

包含要发送到信号处理器的 json 数据的文件

74.23. 堆栈恢复

恢复堆栈。

使用方法:

openstack stack resume [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN] [--wait]
                              <stack> [<stack> ...]

表 74.112. positional 参数
概述

<stack>

要恢复的堆栈(名称或 id)

表 74.113. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait

等待恢复完成

表 74.114. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 74.115. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 74.116. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.117. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.24. 堆栈显示

显示堆栈详细信息。

使用方法:

openstack stack show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--no-resolve-outputs]
                            <stack>

表 74.118. positional 参数
概述

<stack>

要显示的堆栈(名称或 id)

表 74.119. 命令参数
概述

-h, --help

显示帮助信息并退出

--no-resolve-outputs

不要解析堆栈的输出。

表 74.120. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 74.121. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.122. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.123. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.25. 堆栈快照创建

创建堆栈快照。

使用方法:

openstack stack snapshot create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] [--name <name>]
                                       <stack>

表 74.124. positional 参数
概述

<stack>

堆栈的名称或 ID

表 74.125. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

快照名称

表 74.126. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 74.127. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.128. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.129. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.26. 堆栈快照删除

删除堆栈快照。

使用方法:

openstack stack snapshot delete [-h] [-y] <stack> <snapshot>

表 74.130. positional 参数
概述

<stack>

堆栈的名称或 ID

<snapshot>

堆栈快照 ID

表 74.131. 命令参数
概述

-h, --help

显示帮助信息并退出

-y, --yes

跳过是/无提示(假设是)

74.27. 堆栈快照列表

列出堆栈快照。

使用方法:

openstack stack snapshot list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     <stack>

表 74.132. positional 参数
概述

<stack>

包含快照的堆栈的名称或 ID

表 74.133. 命令参数
概述

-h, --help

显示帮助信息并退出

表 74.134. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 74.135. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 74.136. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.137. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.28. 堆栈快照恢复

恢复堆栈快照

使用方法:

openstack stack snapshot restore [-h] <stack> <snapshot>

表 74.138. positional 参数
概述

<stack>

包含快照的堆栈的名称或 ID

<snapshot>

要恢复的快照 ID

表 74.139. 命令参数
概述

-h, --help

显示帮助信息并退出

74.29. 堆栈快照显示

显示堆栈快照。

使用方法:

openstack stack snapshot show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <stack> <snapshot>

表 74.140. positional 参数
概述

<stack>

包含快照的堆栈的名称或 ID

<snapshot>

要显示的快照 ID

表 74.141. 命令参数
概述

-h, --help

显示帮助信息并退出

表 74.142. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 74.143. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.144. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.145. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.30. 堆栈挂起

挂起堆栈。

使用方法:

openstack stack suspend [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN] [--wait]
                               <stack> [<stack> ...]

表 74.146. positional 参数
概述

<stack>

要挂起的堆栈(名称或 id)

表 74.147. 命令参数
概述

-h, --help

显示帮助信息并退出

--wait

等待挂起完成

表 74.148. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 74.149. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 74.150. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.151. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.31. 堆栈模板显示

显示堆栈模板。

使用方法:

openstack stack template show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <stack>

表 74.152. positional 参数
概述

<stack>

要查询的堆栈的名称或 ID

表 74.153. 命令参数
概述

-h, --help

显示帮助信息并退出

表 74.154. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 74.155. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.156. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.157. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

74.32. 堆栈更新

更新堆栈。

使用方法:

openstack stack update [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [-t <template>]
                              [-e <environment>] [--pre-update <resource>]
                              [--timeout <timeout>] [--rollback <value>]
                              [--dry-run] [--show-nested]
                              [--parameter <key=value>]
                              [--parameter-file <key=file>] [--existing]
                              [--clear-parameter <parameter>]
                              [--tags <tag1,tag2...>] [--wait] [--converge]
                              <stack>

表 74.158. positional 参数
概述

<stack>

要更新的堆栈的名称或 ID

表 74.159. 命令参数
概述

-h, --help

显示帮助信息并退出

-T <template>, --template <template>

模板的路径

-e <environment>, --environment <environment>

到环境的路径。可多次指定

--pre-update <resource>

将预更新 hook 设置为的资源名称。嵌套堆栈中的资源可以使用斜杠作为分隔符设置: ''nested_stack/another/my_resource''。您可以使用通配符来匹配多个堆栈或资源: ''nested_stack/an598 the_resource''。这可以多次指定

--timeout <timeout>

堆栈更新超时时间(以分钟为单位)

--rollback <value>

在更新失败时设置回滚。值 "enabled" 将 rollback 设置为 enabled。值 "disabled" 将 rollback 设置为 disabled。"keep" 值使用要更新的现有堆栈的值(默认)

--dry-run

不要实际执行堆栈更新,但显示要更改的内容

--show-nested

执行 --dry-run 时显示嵌套堆栈

--parameter <key=value>

用于创建堆栈的参数值。这可以多次指定

--parameter-file <key=file>

用于创建堆栈的文件的参数值。这可以多次指定。参数值是文件的内容

--existing

重新使用当前堆栈的模板、参数和环境。如果省略了模板参数,则使用现有模板。如果没有指定 --environment,则使用现有环境。--parameter 中指定的参数将修补当前堆栈中的现有值。忽略的参数会保留现有值

--clear-parameter <parameter>

从 stack-update 当前堆栈的一组参数中删除参数。将使用模板中的默认值。这可以多次指定

--tags <tag1,tag2…​>

与堆栈关联的更新标签列表

--wait

等待堆栈进入 update_complete 或 UPDATE_FAILED

--converge

持续观察到堆栈更新。

表 74.160. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 74.161. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 74.162. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 74.163. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 75 章 子网

本章描述了 subnet 命令下的命令。

75.1. 子网创建

创建子网

使用方法:

openstack subnet create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--project <project>]
                               [--project-domain <project-domain>]
                               [--subnet-pool <subnet-pool> | --use-prefix-delegation USE_PREFIX_DELEGATION | --use-default-subnet-pool]
                               [--prefix-length <prefix-length>]
                               [--subnet-range <subnet-range>]
                               [--dhcp | --no-dhcp] [--gateway <gateway>]
                               [--ip-version {4,6}]
                               [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
                               [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
                               [--network-segment <network-segment>] --network
                               <network> [--description <description>]
                               [--allocation-pool start=<ip-address>,end=<ip-address>]
                               [--dns-nameserver <dns-nameserver>]
                               [--host-route destination=<subnet>,gateway=<ip-address>]
                               [--service-type <service-type>]
                               [--tag <tag> | --no-tag]
                               <name>

表 75.1. positional 参数
概述

<name>

新子网名称

表 75.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--subnet-pool <subnet-pool>

此子网从中获取 cidr 的子网池(名称或 ID)

--use-prefix-delegation USE_PREFIX_DELEGATION

如果 ip 是 ipv6 格式,且 ip 将外部委托,则使用 prefix-delegation

--use-default-subnet-pool

将默认子网池用于 --ip-version

--prefix-length <prefix-length>

子网池中子网分配的前缀长度

--subnet-range <subnet-range>

cidr 表示法的子网范围(如果未指定 --subnet- 池,则必需选项),否则是可选的。

--dhcp

启用 dhcp (默认)

--no-dhcp

禁用 dhcp

--gateway {>

为子网指定一个网关。三个选项为:<ip-address>: Specific IP 地址用作网关,auto: Gateway address 被自动从子网本身中选择,无:此子网不使用网关,例如:--gateway 192.168.9.1, --gateway auto, --gateway none (默认为 auto)。

--ip-version {4,6}

IP 版本(默认为 4)。请注意,当指定子网池时,IP 版本由子网池中决定,这个选项将被忽略。

--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}

Ipv6 ra (路由器广告)模式,有效模式: [dhcpv6-stateful, dhcpv6-stateless, slaac]

--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}

Ipv6 地址模式, 有效模式: [dhcpv6-stateful, dhcpv6-stateless, slaac]

--network-segment <network-segment>

与此子网(名称或 ID)关联的网络片段

--network <network>

此子网所属的网络(名称或 id)

--description <description>

设置子网描述

--allocation-pool start=<ip-address>,end=<ip-address>

此子网的分配池 IP 地址,例如:start=192.168.199.2,end=192.168.199.254 (repeat 选项,添加多个 IP 地址)

--dns-nameserver <dns-nameserver>

此子网的 DNS 服务器(需要设置多个 DNS 服务器)

--host-route destination=<subnet>,gateway=<ip-address>

此子网的额外路由,如: destination=10.10.0.0/16,gateway=192.168.71.254 destination: destination subnet (以 CIDR 表示法)网关:下一步 IP 地址(重复,添加多个路由)

--service-type <service-type>

此子网的服务类型,如:network:floatingip_agent_gateway。必须是网络端口的有效设备所有者值(需要设置多个服务类型)

--tag <tag>

要添加到子网的标签(重复选项来设置多个标签)

--no-tag

没有与子网关联的标签

表 75.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 75.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 75.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 75.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

75.2. subnet delete

删除子网

使用方法:

openstack subnet delete [-h] <subnet> [<subnet> ...]

表 75.7. positional 参数
概述

<subnet>

要删除的子网(名称或 id)

表 75.8. 命令参数
概述

-h, --help

显示帮助信息并退出

75.3. 子网列表

列出子网

使用方法:

openstack subnet list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--long]
                             [--ip-version <ip-version>] [--dhcp | --no-dhcp]
                             [--service-type <service-type>]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--network <network>] [--gateway <gateway>]
                             [--name <name>] [--subnet-range <subnet-range>]
                             [--tags <tag>[,<tag>,...]]
                             [--any-tags <tag>[,<tag>,...]]
                             [--not-tags <tag>[,<tag>,...]]
                             [--not-any-tags <tag>[,<tag>,...]]

表 75.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

--ip-version <ip-version>

仅列出输出中给定 ip 版本的子网。IP 版本允许的值是 4 和 6。

--dhcp

列出启用了 dhcp 的子网

--no-dhcp

列出禁用了 dhcp 的子网

--service-type <service-type>

仅列出输出中给定服务类型的子网,例如:network:floatingip_agent_gateway。必须是网络端口的有效设备所有者值(重复选项,列出多个服务类型)

--project <project>

仅列出输出中属于给定项目的子网(名称或 ID)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--network <network>

仅列出输出中属于给定网络的子网(名称或 ID)

--gateway {>

仅列出输出中给定网关 ip 的子网

--name <name>

仅列出输出中给定名称的子网

--subnet-range <subnet-range>

仅列出输出中给定子网范围(以 cidr 表示法)的子网,例如:--subnet-range 10.10.0.0/16

--tags <tag>[,<tag>,…​]

列出具有所有给定标签的子网(以逗号分隔的标签列表)

--any-tags <tag>[,<tag>,…​]

列出具有任何给定标签的子网(以逗号分隔的标签列表)

--not-tags <tag>[,<tag>,…​]

排除具有所有给定标签的子网(以逗号分隔的标签列表)

--not-any-tags <tag>[,<tag>,…​]

排除具有任何给定标签的子网(以逗号分隔的标签列表)

表 75.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 75.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 75.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 75.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

75.4. 子网池创建

创建子网池

使用方法:

openstack subnet pool create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] --pool-prefix
                                    <pool-prefix>
                                    [--default-prefix-length <default-prefix-length>]
                                    [--min-prefix-length <min-prefix-length>]
                                    [--max-prefix-length <max-prefix-length>]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--address-scope <address-scope>]
                                    [--default | --no-default]
                                    [--share | --no-share]
                                    [--description <description>]
                                    [--default-quota <num-ip-addresses>]
                                    [--tag <tag> | --no-tag]
                                    <name>

表 75.14. positional 参数
概述

<name>

新子网池的名称

表 75.15. 命令参数
概述

-h, --help

显示帮助信息并退出

--pool-prefix <pool-prefix>

设置子网池前缀(以 cidr 表示法表示)(重复选项设置多个前缀)

--default-prefix-length <default-prefix-length>

设置子网池默认前缀长度

--min-prefix-length <min-prefix-length>

设置子网池最小前缀长度

--max-prefix-length <max-prefix-length>

设置子网池最大前缀长度

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--address-scope <address-scope>

设置与子网池(名称或 ID)关联的地址范围,前缀必须在地址范围内唯一

--default

把它设置为默认子网池

--no-default

把它设置为非默认子网池

--share

将此子网池设置为共享

--no-share

将这个子网池设置为不共享

--description <description>

设置子网池描述

--default-quota <num-ip-addresses>

为此子网池设置默认按项目配额设置为可以从子网池中分配的 IP 地址数

--tag <tag>

要添加到子网池的标签(重复选项来设置多个标签)

--no-tag

没有与子网池关联的标签

表 75.16. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 75.17. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 75.18. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 75.19. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

75.5. 子网池删除

删除子网池

使用方法:

openstack subnet pool delete [-h] <subnet-pool> [<subnet-pool> ...]

表 75.20. positional 参数
概述

<subnet-pool>

要删除的子网池(名称或 id)

表 75.21. 命令参数
概述

-h, --help

显示帮助信息并退出

75.6. 子网池列表

列出子网池

使用方法:

openstack subnet pool list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN] [--long]
                                  [--share | --no-share]
                                  [--default | --no-default]
                                  [--project <project>]
                                  [--project-domain <project-domain>]
                                  [--name <name>]
                                  [--address-scope <address-scope>]
                                  [--tags <tag>[,<tag>,...]]
                                  [--any-tags <tag>[,<tag>,...]]
                                  [--not-tags <tag>[,<tag>,...]]
                                  [--not-any-tags <tag>[,<tag>,...]]

表 75.22. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

--share

列出项目间共享的子网池

--no-share

列出没有在项目间共享的子网池

--default

列出用作默认外部子网池的子网池

--no-default

列出不用作默认外部子网池的子网池

--project <project>

根据项目(名称或 ID)列出子网池

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--name <name>

仅列出输出中给定名称的子网池

--address-scope <address-scope>

仅列出输出中给定地址范围的子网池(名称或 ID)

--tags <tag>[,<tag>,…​]

列出具有所有给定标签的子网池(以逗号分隔的标签列表)

--any-tags <tag>[,<tag>,…​]

列出具有任何给定标签的子网池(以逗号分隔的标签列表)

--not-tags <tag>[,<tag>,…​]

排除具有所有给定标签(通用标签列表)的子网池

--not-any-tags <tag>[,<tag>,…​]

排除具有任何给定标签(Comma 分隔标签列表的子网池)

表 75.23. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 75.24. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 75.25. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 75.26. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

75.7. 子网池集

设置子网池属性

使用方法:

openstack subnet pool set [-h] [--name <name>]
                                 [--pool-prefix <pool-prefix>]
                                 [--default-prefix-length <default-prefix-length>]
                                 [--min-prefix-length <min-prefix-length>]
                                 [--max-prefix-length <max-prefix-length>]
                                 [--address-scope <address-scope> | --no-address-scope]
                                 [--default | --no-default]
                                 [--description <description>]
                                 [--default-quota <num-ip-addresses>]
                                 [--tag <tag>] [--no-tag]
                                 <subnet-pool>

表 75.27. positional 参数
概述

<subnet-pool>

要修改的子网池(名称或 id)

表 75.28. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置子网池名称

--pool-prefix <pool-prefix>

设置子网池前缀(以 cidr 表示法表示)(重复选项设置多个前缀)

--default-prefix-length <default-prefix-length>

设置子网池默认前缀长度

--min-prefix-length <min-prefix-length>

设置子网池最小前缀长度

--max-prefix-length <max-prefix-length>

设置子网池最大前缀长度

--address-scope <address-scope>

设置与子网池(名称或 ID)关联的地址范围,前缀必须在地址范围内唯一

--no-address-scope

删除与子网池关联的地址范围

--default

把它设置为默认子网池

--no-default

把它设置为非默认子网池

--description <description>

设置子网池描述

--default-quota <num-ip-addresses>

为此子网池设置默认按项目配额设置为可以从子网池中分配的 IP 地址数

--tag <tag>

要添加到子网池的标签(重复选项来设置多个标签)

--no-tag

清除与子网池关联的标签。指定 --tag 和 --no-tag 来覆盖当前标签

75.8. 子网池显示

显示子网池详情

使用方法:

openstack subnet pool show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <subnet-pool>

表 75.29. positional 参数
概述

<subnet-pool>

要显示的子网池(名称或 id)

表 75.30. 命令参数
概述

-h, --help

显示帮助信息并退出

表 75.31. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 75.32. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 75.33. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 75.34. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

75.9. 子网池未设置

取消设置子网池属性

使用方法:

openstack subnet pool unset [-h] [--tag <tag> | --all-tag]
                                   <subnet-pool>

表 75.35. positional 参数
概述

<subnet-pool>

要修改的子网池(名称或 id)

表 75.36. 命令参数
概述

-h, --help

显示帮助信息并退出

--tag <tag>

要从子网池中移除的标签(重复选项来删除多个标签)

--all-tag

清除与子网池关联的所有标签

75.10. 子网集

设置子网属性

使用方法:

openstack subnet set [-h] [--name <name>] [--dhcp | --no-dhcp]
                            [--gateway <gateway>]
                            [--network-segment <network-segment>]
                            [--description <description>] [--tag <tag>]
                            [--no-tag]
                            [--allocation-pool start=<ip-address>,end=<ip-address>]
                            [--no-allocation-pool]
                            [--dns-nameserver <dns-nameserver>]
                            [--no-dns-nameservers]
                            [--host-route destination=<subnet>,gateway=<ip-address>]
                            [--no-host-route] [--service-type <service-type>]
                            <subnet>

表 75.37. positional 参数
概述

<subnet>

要修改的子网(名称或 id)

表 75.38. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

更新子网的名称

--dhcp

启用 dhcp

--no-dhcp

禁用 dhcp

--gateway {>

为子网指定一个网关。选项为:<ip-address>: Specific IP 地址用作网关,none :此子网不使用网关,例如:--gateway 192.168.9.1, --gateway none。

--network-segment <network-segment>

与此子网(名称或 ID)关联的网络片段。只有当前值为 None 时,仅允许设置网段,网络还必须只有一个网段,且网络中只能有一个子网。

--description <description>

设置子网描述

--tag <tag>

要添加到子网的标签(重复选项来设置多个标签)

--no-tag

清除与子网关联的标签。指定 --tag 和 --no-tag 来覆盖当前标签

--allocation-pool start=<ip-address>,end=<ip-address>

此子网的分配池 IP 地址,例如:start=192.168.199.2,end=192.168.199.254 (repeat 选项,添加多个 IP 地址)

--no-allocation-pool

从子网清除关联的 allocation-pools。指定 --allocation-pool 和 --no-allocation- 池来覆盖当前的分配池信息。

--dns-nameserver <dns-nameserver>

此子网的 DNS 服务器(需要设置多个 DNS 服务器)

--no-dns-nameservers

清除 dns 名称服务器的现有信息。指定 --dns-nameserver 和 --no-dns-nameserver 来覆盖当前的 DNS Nameserver 信息。

--host-route destination=<subnet>,gateway=<ip-address>

此子网的额外路由,如: destination=10.10.0.0/16,gateway=192.168.71.254 destination: destination subnet (以 CIDR 表示法)网关:下一步 IP 地址(重复,添加多个路由)

--no-host-route

从子网清除关联的 host-routes。指定 --host-route 和 --no-host-route,以覆盖当前的主机路由信息。

--service-type <service-type>

此子网的服务类型,如:network:floatingip_agent_gateway。必须是网络端口的有效设备所有者值(需要设置多个服务类型)

75.11. 子网显示

显示子网详情

使用方法:

openstack subnet show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <subnet>

表 75.39. positional 参数
概述

<subnet>

要显示的子网(名称或 id)

表 75.40. 命令参数
概述

-h, --help

显示帮助信息并退出

表 75.41. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 75.42. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 75.43. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 75.44. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

75.12. 子网未设置

取消设置子网属性

使用方法:

openstack subnet unset [-h]
                              [--allocation-pool start=<ip-address>,end=<ip-address>]
                              [--dns-nameserver <dns-nameserver>]
                              [--host-route destination=<subnet>,gateway=<ip-address>]
                              [--service-type <service-type>]
                              [--tag <tag> | --all-tag]
                              <subnet>

表 75.45. positional 参数
概述

<subnet>

要修改的子网(名称或 id)

表 75.46. 命令参数
概述

-h, --help

显示帮助信息并退出

--allocation-pool start=<ip-address>,end=<ip-address>

要从这个子网中删除的分配池 ip 地址,例如: start=192.168.199.2,end=192.168.199.254 (repeat 选项用于取消设置多个分配池)

--dns-nameserver <dns-nameserver>

要从这个子网中删除的 DNS 服务器(重复选项以取消设置多个 DNS 服务器)

--host-route destination=<subnet>,gateway=<ip-address>

要从这个子网中删除的路由,如 destination=10.10.0.0/16,gateway=192.168.71.254 destination: destination subnet (CIDR 标记) gateway: nexthop IP address (repeat 选项,取消设置多个主机路由)

--service-type <service-type>

要从这个子网中删除的服务类型,如 network:floatingip_agent_gateway。必须是网络端口的有效设备所有者值(需要设置多个服务类型)

--tag <tag>

要从子网中删除的标签(需要删除多个标签)

--all-tag

清除与子网关联的所有标签

第 76 章 task

本章描述了 任务 命令下的命令。

76.1. 任务执行列表

列出所有任务。

使用方法:

openstack task execution list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--marker [MARKER]] [--limit [LIMIT]]
                                     [--sort_keys [SORT_KEYS]]
                                     [--sort_dirs [SORT_DIRS]]
                                     [--filter FILTERS] [--oldest]
                                     [workflow_execution]

表 76.1. positional 参数
概述

workflow_execution

与任务列表关联的工作流执行 ID。

表 76.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

上一页的最后执行 uuid 显示在"marker"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

以逗号分隔的排序键列表,按以下方式对结果进行排序。默认: created_at。示例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序方向列表。默认为 asc。示例:mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

filters. 可以重复。

--oldest

显示从最旧的条目而不是最新的条目开始的执行

表 76.3. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 76.4. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 76.5. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 76.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

76.2. 任务执行公布的显示

显示任务发布的变量。

使用方法:

openstack task execution published show [-h] id

表 76.7. positional 参数
概述

id

任务 ID

表 76.8. 命令参数
概述

-h, --help

显示帮助信息并退出

76.3. 任务执行重新运行

重新运行现有任务。

使用方法:

openstack task execution rerun [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--resume] [-e ENV]
                                      id

表 76.9. positional 参数
概述

id

任务标识符

表 76.10. 命令参数
概述

-h, --help

显示帮助信息并退出

--resume

仅针对 with-items 任务重新运行失败或未启动的操作执行

-e ENV, --env ENV

环境变量

表 76.11. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 76.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 76.13. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 76.14. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

76.4. 任务执行结果显示

显示任务输出数据。

使用方法:

openstack task execution result show [-h] id

表 76.15. positional 参数
概述

id

任务 ID

表 76.16. 命令参数
概述

-h, --help

显示帮助信息并退出

76.5. 任务执行显示

显示特定的任务。

使用方法:

openstack task execution show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     task

表 76.17. positional 参数
概述

task

任务标识符

表 76.18. 命令参数
概述

-h, --help

显示帮助信息并退出

表 76.19. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 76.20. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 76.21. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 76.22. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 77 章 tld

本章描述了 tld 命令下的命令。

77.1. tld create

创建新 tld

使用方法:

openstack tld create [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] --name NAME
                            [--description DESCRIPTION] [--all-projects]
                            [--edit-managed]
                            [--sudo-project-id SUDO_PROJECT_ID]

表 77.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--name NAME

TLD 名称

--description DESCRIPTION

描述

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 77.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 77.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 77.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 77.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

77.2. tld delete

删除 tld

使用方法:

openstack tld delete [-h] [--all-projects] [--edit-managed]
                            [--sudo-project-id SUDO_PROJECT_ID]
                            id

表 77.6. positional 参数
概述

id

tld id

表 77.7. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

77.3. tld list

List tlds

使用方法:

openstack tld list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                          [--quote {all,minimal,none,nonnumeric}] [--noindent]
                          [--max-width <integer>] [--fit-width]
                          [--print-empty] [--sort-column SORT_COLUMN]
                          [--name NAME] [--description DESCRIPTION]
                          [--all-projects] [--edit-managed]
                          [--sudo-project-id SUDO_PROJECT_ID]

表 77.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--name NAME

TLD 名称

--description DESCRIPTION

TLD 描述

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 77.9. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 77.10. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 77.11. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 77.12. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

77.4. TLD set

设置 tld 属性

使用方法:

openstack tld set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                         [--noindent] [--prefix PREFIX]
                         [--max-width <integer>] [--fit-width] [--print-empty]
                         [--name NAME]
                         [--description DESCRIPTION | --no-description]
                         [--all-projects] [--edit-managed]
                         [--sudo-project-id SUDO_PROJECT_ID]
                         id

表 77.13. positional 参数
概述

id

tld id

表 77.14. 命令参数
概述

-h, --help

显示帮助信息并退出

--name NAME

TLD 名称

--description DESCRIPTION

描述

--no-description—​all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 77.15. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 77.16. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 77.17. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 77.18. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

77.5. tld show

显示 tld 详情

使用方法:

openstack tld show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                          [--noindent] [--prefix PREFIX]
                          [--max-width <integer>] [--fit-width]
                          [--print-empty] [--all-projects] [--edit-managed]
                          [--sudo-project-id SUDO_PROJECT_ID]
                          id

表 77.19. positional 参数
概述

id

tld id

表 77.20. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 77.21. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 77.22. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 77.23. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 77.24. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 78 章 token

本章描述了 token 命令下的命令。

78.1. 令牌问题

发出新令牌

使用方法:

openstack token issue [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]

表 78.1. 命令参数
概述

-h, --help

显示帮助信息并退出

表 78.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 78.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 78.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 78.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

78.2. 令牌撤销

撤销现有令牌

使用方法:

openstack token revoke [-h] <token>

表 78.6. positional 参数
概述

<token>

要删除的令牌

表 78.7. 命令参数
概述

-h, --help

显示帮助信息并退出

第 79 章 tripleo

本章描述了 tripleo 命令下的命令。

79.1. tripleo config generate ansible

为部署生成默认 ansible.cfg。

使用方法:

openstack tripleo config generate ansible
                                                 [--deployment-user DEPLOYMENT_USER]
                                                 [--output-dir OUTPUT_DIR]

表 79.1. 命令参数
概述

--deployment-user DEPLOYMENT_USER

执行 tripleo config generate 命令的用户。默认为 stack。

--output-dir OUTPUT_DIR

输出 ansible.cfg 和 ansible.log 文件的目录。

79.2. tripleo 容器镜像构建

使用 tripleo-ansible 构建 tripleo 容器镜像。

使用方法:

openstack tripleo container image build [-h] [--authfile <authfile>]
                                               [--base <base-image>]
                                               [--config-file <config-file>]
                                               [--config-path <config-path>]
                                               [--distro <distro>]
                                               [--exclude <container-name>]
                                               [--extra-config <extra-config>]
                                               [--namespace <registry-namespace>]
                                               [--registry <registry-url>]
                                               [--skip-build]
                                               [--tag <image-tag>]
                                               [--prefix <image-prefix>]
                                               [--push] [--label <label-data>]
                                               [--volume <volume-path>]
                                               [--work-dir <work-directory>]
                                               [--rhel-modules <rhel-modules>]

表 79.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--authfile <authfile>

身份验证文件的路径。使用 REGISTRY_AUTH_FILE 环境变量覆盖(默认为 /root/containers/auth.json)

--base <base-image>

基本镜像名称,带有可选版本。可以是 centos:8 ,基础镜像将是 centos:8,但将拉取 centos:8 以构建基础镜像。(默认为 ubi8)

--config-file <config-file>

YAML 配置文件指定要构建的镜像。(默认为 tripleo_containers.yaml)

--config-path <config-path>

基本配置路径。这是所有 container-image 文件的基本路径。定义的容器必须位于此路径中的 tcib 文件夹中。如果设置了这个选项,将修改 <config-file> 的默认路径。(默认为 /usr/share/tripleo- common/container-images)

--distro <distro>

distro 名称,如果未定义系统将使用主机 distro 构建(默认值:centos)

--exclude <container-name>

要与要跳过的容器列表匹配的一个容器的名称。在跳过多个容器时,应多次指定。(默认值:[])

--extra-config <extra-config>

从给定配置 YAML 文件中应用附加选项。这将适用于所有构建的容器。(默认为 None)

--namespace <registry-namespace>

容器 registry 命名空间(默认为 tripleotrain)

--registry <registry-url>

容器 registry url (默认:localhost)

--skip-build

跳过或不是镜像构建(默认为 false)

--tag <image-tag>

镜像标签(默认为 latest)

--prefix <image-prefix>

镜像前缀。(默认为 openstack)

--push

启用镜像推送到给定 registry。(默认值:False)

--label <label-data>

为容器添加标签。此选项可多次指定。每个标签都是 key=value 对。

--volume <volume-path>

构建镜像时使用的容器绑定挂载。如果多个卷,应多次指定。(默认为 [/etc/yum.repos.d:/etc/distro.repos.d:z,/etc/pki/rpm-gpg:/etc/pki/rpm-gpg:z])

--work-dir <work-directory>

tripleo 容器构建目录,存储各个镜像的配置和日志。(默认为 /tmp/container-builds)

--rhel-modules <rhel-modules>

以逗号分隔的 rhel 模块列表,用于其版本。示例: mariadb:10.3,virt:8.3

79.3. tripleo 容器镜像删除

从 registry 中删除指定的镜像。

使用方法:

openstack tripleo container image delete [-h]
                                                [--registry-url <registry url>]
                                                [--username <username>]
                                                [--password <password>] [-y]
                                                <image to delete>

表 79.3. positional 参数
概述

<image to delete>

要删除的镜像的完整 url,格式为 <fqdn>:<port>/path/to/image

表 79.4. 命令参数
概述

-h, --help

显示帮助信息并退出

--registry-url <registry url>

registry 镜像的 URL 从中列出,格式为 <fqdn>:<port>。

--username <username>

镜像 registry 的用户名。

--password <password>

镜像 registry 的密码。

-y, --yes

跳过是/无提示(假设是 yes)。

79.4. tripleo 容器镜像热修复

使用 tripleo-ansible 热修复容器镜像。

使用方法:

openstack tripleo container image hotfix [-h] --image <images>
                                                --rpms-path <rpms-path>
                                                [--tag <image-tag>]

表 79.5. 命令参数
概述

-h, --help

显示帮助信息并退出

--image <images>

对要修改的源镜像的完全限定引用。可以多次指定(每个镜像一个)(默认值:[])。

--rpms-path <rpms-path>

包含要安装的 RPM 的路径(默认:none)。

--tag <image-tag>

镜像热修复标签(默认为 latest)

79.5. tripleo 容器镜像列表

列出 registry 中发现的镜像。

使用方法:

openstack tripleo container image list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              [--registry-url <registry url>]
                                              [--username <username>]
                                              [--password <password>]

表 79.6. 命令参数
概述

-h, --help

显示帮助信息并退出

--registry-url <registry url>

registry 镜像的 URL 从中列出,格式为 <fqdn>:<port>。

--username <username>

镜像 registry 的用户名。

--password <password>

镜像 registry 的密码。

表 79.7. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 79.8. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 79.9. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 79.10. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

79.6. tripleo 容器镜像准备默认

生成默认的 ContainerImagePrepare 参数。

使用方法:

openstack tripleo container image prepare default [-h]
                                                         [--output-env-file <file path>]
                                                         [--local-push-destination]
                                                         [--enable-registry-login]

表 79.11. 命令参数
概述

-h, --help

显示帮助信息并退出

--output-env-file <file path>

用于写入包含默认 ContainerImagePrepare 值的环境文件的文件。

--local-push-destination

包括一个 push_destination,用于触发上传到本地 registry。

--enable-registry-login

使用此标志启用标志,使系统尝试在拉取容器前尝试登录到远程 registry。不使用 --local-push-destination 且目标系统与远程 registry 有网络连接时,应使用此标志。不要将其用于可能没有与远程 registry 的网络连接的 overcloud。

79.7. tripleo 容器镜像准备

从单个命令准备和上传容器。

使用方法:

openstack tripleo container image prepare [-h]
                                                 [--environment-file <file path>]
                                                 [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                                 [--roles-file ROLES_FILE]
                                                 [--output-env-file <file path>]
                                                 [--dry-run]
                                                 [--cleanup <full, partial, none>]

表 79.12. 命令参数
概述

-h, --help

显示帮助信息并退出

--environment-file <file path>, -e <file path>

包含 containerimageprepare 参数的环境文件,该参数指定所有准备操作。另外,指定容器化服务的环境文件。条目将过滤为仅包含容器化服务使用的镜像。(可多次指定。)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

自动添加到环境中的环境文件目录。可以多次指定。目录中的文件以升序顺序加载。

--roles-file ROLES_FILE, -r ROLES_FILE

角色文件,覆盖用于部署的 t-h-t templates 目录中的默认 roles_data.yaml。可以是绝对路径或相对于模板目录的路径。

--output-env-file <file path>

用于编写指定所有镜像参数的 heat 环境文件的文件。任何现有文件都会被覆盖。

--dry-run

不要执行任何 pull、Mod 或 push 操作。环境文件仍会填充,就像执行这些操作一样。

--cleanup <full, partial, none>

上传后保留本地镜像的清理行为。默认 full 将尝试删除所有本地镜像。部分 将保留在此主机上部署所需的镜像。none 将不进行清理。

79.8. tripleo 容器镜像推送

将指定的镜像推送到 registry。

使用方法:

openstack tripleo container image push [-h] [--local]
                                              [--registry-url <registry url>]
                                              [--append-tag APPEND_TAG]
                                              [--username <username>]
                                              [--password <password>]
                                              [--source-username <source_username>]
                                              [--source-password <source_password>]
                                              [--dry-run] [--multi-arch]
                                              [--cleanup]
                                              <image to push>

表 79.13. positional 参数
概述

<image to push>

要上传的容器镜像。应该采用 <registry>/<namespace>/<name>:<tag> 的形式。如果没有提供 tag,则使用 latest。

表 79.14. 命令参数
概述

-h, --help

显示帮助信息并退出

--local

如果容器镜像已在当前系统中,且不需要从远程 registry 中拉取,则使用此标志。

--registry-url <registry url>

目标 registry 的 URL,格式为 <fqdn>:<port>。

--append-tag APPEND_TAG

在推送容器时附加到现有标签的标签。

--username <username>

目标镜像 registry 的用户名。

--password <password>

目标镜像 registry 的密码。

--source-username <source_username>

源镜像 registry 的用户名。

--source-password <source_password>

源镜像 registry 的密码。

--dry-run

执行空运行上传。不执行 upload 操作,而是尝试身份验证过程。

--multi-arch

为上传启用多架构支持。

--cleanup

上传后删除镜像的本地副本

79.9. tripleo 容器镜像显示

显示从 registry 中选择的镜像。

使用方法:

openstack tripleo container image show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--username <username>]
                                              [--password <password>]
                                              <image to inspect>

表 79.15. positional 参数
概述

<image to inspect>

要检查的镜像,例如: docker.io/library/centos:7 或 docker://docker.io/library/centos:7

表 79.16. 命令参数
概述

-h, --help

显示帮助信息并退出

--username <username>

镜像 registry 的用户名。

--password <password>

镜像 registry 的密码。

表 79.17. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 json

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 79.18. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 79.19. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 79.20. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

79.10. tripleo deploy

部署容器化 undercloud

使用方法:

openstack tripleo deploy [--templates [TEMPLATES]] [--standalone]
                                [--upgrade] [-y] [--stack STACK]
                                [--output-dir OUTPUT_DIR] [--output-only]
                                [--standalone-role STANDALONE_ROLE]
                                [-t <TIMEOUT>] [-e <HEAT ENVIRONMENT FILE>]
                                [--roles-file ROLES_FILE]
                                [--networks-file NETWORKS_FILE]
                                [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                [--heat-api-port <HEAT_API_PORT>]
                                [--heat-user <HEAT_USER>]
                                [--deployment-user DEPLOYMENT_USER]
                                [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                [--heat-container-image <HEAT_CONTAINER_IMAGE>]
                                [--heat-native [HEAT_NATIVE]]
                                [--local-ip <LOCAL_IP>]
                                [--control-virtual-ip <CONTROL_VIRTUAL_IP>]
                                [--public-virtual-ip <PUBLIC_VIRTUAL_IP>]
                                [--local-domain <LOCAL_DOMAIN>] [--cleanup]
                                [--hieradata-override [HIERADATA_OVERRIDE]]
                                [--keep-running] [--inflight-validations]
                                [--ansible-forks ANSIBLE_FORKS]
                                [--force-stack-update | --force-stack-create]

表 79.21. 命令参数
概述

--templates [TEMPLATES]

要部署的 heat 模板的目录

--standalone

作为没有 undercloud 的独立部署运行部署。

--upgrade

升级现有部署。

-y, --yes

跳过是/无提示(假设是 yes)。

--stack STACK

临时的名称(一次性创建和忘记) heat 堆栈。

--output-dir OUTPUT_DIR

输出状态、处理的 heat 模板、ansible 部署文件的目录。

--output-only

不要执行 ansible playbook。默认情况下,playbook 保存至 output-dir,然后执行。

--standalone-role STANDALONE_ROLE

填充部署操作时用于独立配置的角色。

-t <TIMEOUT>, --timeout <TIMEOUT>

部署超时(以分钟为单位)。

-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>

要传递给 heat stack-create 或 heat stack-update 命令的环境文件。(可多次指定。)

--roles-file ROLES_FILE, -r ROLES_FILE

角色文件,覆盖用于部署的 t-h-t templates 目录中的默认 roles_data_undercloud.yaml。可以是绝对路径或相对于模板目录的路径。

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

角色文件,覆盖用于部署的 t-h-t templates 目录中的默认 /dev/null。可以是绝对路径或相对于模板目录的路径。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

计划环境文件,覆盖 --templates 目录中的默认 plan- environment.yaml

--heat-api-port <HEAT_API_PORT>

用于安装程序私有 heat API 实例的 Heat api 端口。可选。默认:8006.)

--heat-user <HEAT_USER>

用户执行非特权 heat-all 进程。默认为 heat。

--deployment-user DEPLOYMENT_USER

执行 tripleo deploy 命令的用户。默认为 $SUDO_USER。如果 $SUDO_USER 取消设置,则默认为 stack。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

用于部署操作的 python 解释器的路径。如果没有指定 openstackclient 的 python 版本,则使用。如果在 python3 系统的 python2 主机上部署,或者反之之,则可能需要使用它。

--heat-container-image <HEAT_CONTAINER_IMAGE>

启动 heat-all 进程时要使用的容器镜像。默认为: tripleomaster/centos-binary- heat-all:current-tripleo

--heat-native [HEAT_NATIVE]

在此主机上执行 heat-all 进程。此选项要求在此计算机上本地安装 heat-all 二进制文件。默认启用此选项,这意味着 heat-all 在主机操作系统上直接执行。

--local-ip <LOCAL_IP>

用于 undercloud 流量的本地 ip/cidr。

--control-virtual-ip <CONTROL_VIRTUAL_IP>

control plane vip。这允许 undercloud 安装程序在 control plane 上配置自定义 VIP。

--public-virtual-ip <PUBLIC_VIRTUAL_IP>

公共 nw vip。这允许 undercloud 安装程序在公共(外部)NW 上配置自定义 VIP。

--local-domain <LOCAL_DOMAIN>

独立云及其 api 端点的本地域

--cleanup

清理临时文件。使用此标志将删除在该命令运行后部署期间使用的临时文件。

--hieradata-override [HIERADATA_OVERRIDE]

hieradata 覆盖文件的路径。当它指向 heat env 文件的路径,它将通过 --environment-file 在 t-h-t 中传递。当文件包含旧的 instack 数据时,它被 <role>ExtraConfig 嵌套,并作为 --output-dir 中创建的 temp 文件传递。请注意,instack hiera 数据可能无法与 t-h-t 兼容,并可能需要手动修订。

--keep-running

在堆栈操作完成后,保持临时 heat 运行。这仅用于调试目的。openstackclient 可以使用临时 Heat,并带有 OS_AUTH_TYPE=none OS_ENDPOINT=http://127.0.0.1:8006/v1/admin openstack stack list,其中 8006 是 --heat- api-port 指定的端口。

--inflight-validations

在部署期间激活动态验证。动态验证提供了一种强大的方法,以确保部署的服务在激活后运行。默认值为 False。

--ansible-forks ANSIBLE_FORKS

用于 config- download ansible-playbook 命令的 ansible fork 数量。

--force-stack-update

对临时 heat 堆栈进行虚拟更新(无法进行实际更新)。新的或失败的部署始终具有 stack_action=CREATE。这个选项强制 stack_action=UPDATE。

--force-stack-create

对临时 heat 堆栈进行虚拟创建。新的或失败的部署始终具有 stack_action=CREATE。这个选项强制 stack_action=CREATE。

79.11. tripleo upgrade

upgrade TripleO

使用方法:

openstack tripleo upgrade [--templates [TEMPLATES]] [--standalone]
                                 [--upgrade] [-y] [--stack STACK]
                                 [--output-dir OUTPUT_DIR] [--output-only]
                                 [--standalone-role STANDALONE_ROLE]
                                 [-t <TIMEOUT>] [-e <HEAT ENVIRONMENT FILE>]
                                 [--roles-file ROLES_FILE]
                                 [--networks-file NETWORKS_FILE]
                                 [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                 [--heat-api-port <HEAT_API_PORT>]
                                 [--heat-user <HEAT_USER>]
                                 [--deployment-user DEPLOYMENT_USER]
                                 [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                 [--heat-container-image <HEAT_CONTAINER_IMAGE>]
                                 [--heat-native [HEAT_NATIVE]]
                                 [--local-ip <LOCAL_IP>]
                                 [--control-virtual-ip <CONTROL_VIRTUAL_IP>]
                                 [--public-virtual-ip <PUBLIC_VIRTUAL_IP>]
                                 [--local-domain <LOCAL_DOMAIN>] [--cleanup]
                                 [--hieradata-override [HIERADATA_OVERRIDE]]
                                 [--keep-running] [--inflight-validations]
                                 [--ansible-forks ANSIBLE_FORKS]
                                 [--force-stack-update | --force-stack-create]

表 79.22. 命令参数
概述

--templates [TEMPLATES]

要部署的 heat 模板的目录

--standalone

作为没有 undercloud 的独立部署运行部署。

--upgrade

升级现有部署。

-y, --yes

跳过是/无提示(假设是 yes)。

--stack STACK

临时的名称(一次性创建和忘记) heat 堆栈。

--output-dir OUTPUT_DIR

输出状态、处理的 heat 模板、ansible 部署文件的目录。

--output-only

不要执行 ansible playbook。默认情况下,playbook 保存至 output-dir,然后执行。

--standalone-role STANDALONE_ROLE

填充部署操作时用于独立配置的角色。

-t <TIMEOUT>, --timeout <TIMEOUT>

部署超时(以分钟为单位)。

-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>

要传递给 heat stack-create 或 heat stack-update 命令的环境文件。(可多次指定。)

--roles-file ROLES_FILE, -r ROLES_FILE

角色文件,覆盖用于部署的 t-h-t templates 目录中的默认 roles_data_undercloud.yaml。可以是绝对路径或相对于模板目录的路径。

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

角色文件,覆盖用于部署的 t-h-t templates 目录中的默认 /dev/null。可以是绝对路径或相对于模板目录的路径。

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

计划环境文件,覆盖 --templates 目录中的默认 plan- environment.yaml

--heat-api-port <HEAT_API_PORT>

用于安装程序私有 heat API 实例的 Heat api 端口。可选。默认:8006.)

--heat-user <HEAT_USER>

用户执行非特权 heat-all 进程。默认为 heat。

--deployment-user DEPLOYMENT_USER

执行 tripleo deploy 命令的用户。默认为 $SUDO_USER。如果 $SUDO_USER 取消设置,则默认为 stack。

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

用于部署操作的 python 解释器的路径。如果没有指定 openstackclient 的 python 版本,则使用。如果在 python3 系统的 python2 主机上部署,或者反之之,则可能需要使用它。

--heat-container-image <HEAT_CONTAINER_IMAGE>

启动 heat-all 进程时要使用的容器镜像。默认为: tripleomaster/centos-binary- heat-all:current-tripleo

--heat-native [HEAT_NATIVE]

在此主机上执行 heat-all 进程。此选项要求在此计算机上本地安装 heat-all 二进制文件。默认启用此选项,这意味着 heat-all 在主机操作系统上直接执行。

--local-ip <LOCAL_IP>

用于 undercloud 流量的本地 ip/cidr。

--control-virtual-ip <CONTROL_VIRTUAL_IP>

control plane vip。这允许 undercloud 安装程序在 control plane 上配置自定义 VIP。

--public-virtual-ip <PUBLIC_VIRTUAL_IP>

公共 nw vip。这允许 undercloud 安装程序在公共(外部)NW 上配置自定义 VIP。

--local-domain <LOCAL_DOMAIN>

独立云及其 api 端点的本地域

--cleanup

清理临时文件。使用此标志将删除在该命令运行后部署期间使用的临时文件。

--hieradata-override [HIERADATA_OVERRIDE]

hieradata 覆盖文件的路径。当它指向 heat env 文件的路径,它将通过 --environment-file 在 t-h-t 中传递。当文件包含旧的 instack 数据时,它被 <role>ExtraConfig 嵌套,并作为 --output-dir 中创建的 temp 文件传递。请注意,instack hiera 数据可能无法与 t-h-t 兼容,并可能需要手动修订。

--keep-running

在堆栈操作完成后,保持临时 heat 运行。这仅用于调试目的。openstackclient 可以使用临时 Heat,并带有 OS_AUTH_TYPE=none OS_ENDPOINT=http://127.0.0.1:8006/v1/admin openstack stack list,其中 8006 是 --heat- api-port 指定的端口。

--inflight-validations

在部署期间激活动态验证。动态验证提供了一种强大的方法,以确保部署的服务在激活后运行。默认值为 False。

--ansible-forks ANSIBLE_FORKS

用于 config- download ansible-playbook 命令的 ansible fork 数量。

--force-stack-update

对临时 heat 堆栈进行虚拟更新(无法进行实际更新)。新的或失败的部署始终具有 stack_action=CREATE。这个选项强制 stack_action=UPDATE。

--force-stack-create

对临时 heat 堆栈进行虚拟创建。新的或失败的部署始终具有 stack_action=CREATE。这个选项强制 stack_action=CREATE。

79.12. tripleo validator group info

显示有关组的详细信息

使用方法:

openstack tripleo validator group info [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              [--config CONFIG]
                                              [--validation-dir VALIDATION_DIR]

表 79.23. 命令参数
概述

-h, --help

显示帮助信息并退出

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

--noindent

是否禁用缩进 json

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

--config CONFIG

验证的配置文件路径。

--validation-dir VALIDATION_DIR

验证 playbook 所在的路径。

79.13. tripleo validator init

创建路径和基础架构以创建社区验证

使用方法:

openstack tripleo validator init [-h] [--config CONFIG]
                                        <validation_name>

表 79.24. positional 参数
概述

<validation_name>

社区验证的名称:验证名称仅限于仅包含小写字母数字字符,加上 _-,并以 alpha 字符开头。EX:my-val、my_val2。这将在 /root/community-validations 中生成一个 Ansible 角色和一个 playbook。请注意,在第一次使用时会创建此目录的结构。

表 79.25. 命令参数
概述

-h, --help

显示帮助信息并退出

--config CONFIG

验证的配置文件路径。

79.14. tripleo validator list

列出可用的验证

使用方法:

openstack tripleo validator list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--config CONFIG]
                                        [--group <group_id>[,<group_id>,...]]
                                        [--category <category_id>[,<category_id>,...]]
                                        [--product <product_id>[,<product_id>,...]]
                                        [--validation-dir VALIDATION_DIR]

表 79.26. 命令参数
概述

-h, --help

显示帮助信息并退出

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

--noindent

是否禁用缩进 json

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

--config CONFIG

验证的配置文件路径。

--group <group_id>[,<group_id>,…​], -g <group_id>[,<group_id>,…​]

如果需要多个组,则使用逗号分隔组名称,则列出特定的验证组。

--category <category_id>[,<category_id>,…​]

如果需要多个类别,请使用逗号分隔类别名称,则列出特定类别的验证类别。

--product <product_id>[,<product_id>,…​]

如果需要多个产品,请使用逗号分隔产品名称,请列出特定产品进行验证。

--validation-dir VALIDATION_DIR

验证 playbook 所在的路径。

79.15. tripleo validator run

运行可用的验证

使用方法:

openstack tripleo validator run [-h] [--config CONFIG]
                                       [--limit <host1>[,<host2>,<host3>,...]]
                                       [--ssh-user SSH_USER]
                                       [--validation-dir VALIDATION_DIR]
                                       [--ansible-base-dir ANSIBLE_BASE_DIR]
                                       [--validation-log-dir VALIDATION_LOG_DIR]
                                       [--inventory INVENTORY]
                                       [--output-log OUTPUT_LOG]
                                       [--junitxml JUNITXML]
                                       [--python-interpreter --python-interpreter <PYTHON_INTERPRETER_PATH>]
                                       [--extra-env-vars key1=<val1> [--extra-env-vars key2=<val2>]]
                                       [--skiplist SKIP_LIST]
                                       [--extra-vars key1=<val1> [--extra-vars key2=<val2>]
                                       | --extra-vars-file
                                       /tmp/my_vars_file.[json|yaml]]
                                       (--validation <validation_id>[,<validation_id>,...] | --group <group_id>[,<group_id>,...] | --category <category_id>[,<category_id>,...] | --product <product_id>[,<product_id>,...])

表 79.27. 命令参数
概述

-h, --help

显示帮助信息并退出

--config CONFIG

验证的配置文件路径。

--limit <host1>[,<host2>,<host3>,…​]

在此升级运行调用中,用于标识单个节点或以逗号分隔的节点列表的字符串。

--ssh-user SSH_USER

ansible ssh 连接的 SSH 用户名。

--validation-dir VALIDATION_DIR

验证 playbook 所在的路径。

--ansible-base-dir ANSIBLE_BASE_DIR

ansible 角色、库和插件所在的路径。

--validation-log-dir VALIDATION_LOG_DIR

日志文件和工件所在的路径。

--inventory INVENTORY, -i INVENTORY

ansible 清单的路径。

--output-log OUTPUT_LOG

存储运行结果的路径。

--junitxml JUNITXML

以 junitxml 格式运行结果的路径将被存储。

--python-interpreter --python-interpreter <PYTHON_INTERPRETER_PATH>

用于 ansible 执行的 Python 解释器。

--extra-env-vars key1=<val1> [--extra-env-vars key2=<val2>]

添加您可能需要以 KEY=VALUE 对形式提供给 Ansible 执行的额外环境变量。请注意,如果您多次传递相同的 KEY,则同一 KEY 的最后给定 VALUE 将覆盖其他 KEY。

--skiplist SKIP_LIST

存储跳过列表的路径。在 validations-libs 存储库的根目录中找到 skiplist 格式的示例。

--extra-vars key1=<val1> [--extra-vars key2=<val2>]

将 ansible 额外变量添加到验证执行中作为 KEY=VALUE 对。请注意,如果您多次传递相同的 KEY,则同一 KEY 的最后给定 VALUE 将覆盖其他 KEY。

--extra-vars-file /tmp/my_vars_file.[json|yaml]

绝对或到 json/yaml 文件的相对路径,其中包含要传递给一个或多个验证的额外变量。

--validation <validation_id>[,<validation_id>,…​]

如果需要多个验证,请使用逗号分隔名称,请运行特定的验证。

--group <group_id>[,<group_id>,…​], -g <group_id>[,<group_id>,…​]

如果需要多个组,则使用逗号分隔组名称,请运行特定的组验证。

--category <category_id>[,<category_id>,…​]

如果需要多个类别,则按类别运行特定的验证,请使用逗号分隔类别名称。

--product <product_id>[,<product_id>,…​]

如果多个产品需要使用逗号分隔产品名称,则按产品运行特定的验证。

79.16. tripleo validator show history

显示验证执行历史记录

使用方法:

openstack tripleo validator show history [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--noindent]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                [--config CONFIG]
                                                [--validation <validation_id>]
                                                [--limit HISTORY_LIMIT]
                                                [--validation-log-dir VALIDATION_LOG_DIR]

表 79.28. 命令参数
概述

-h, --help

显示帮助信息并退出

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

--noindent

是否禁用缩进 json

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

--config CONFIG

验证的配置文件路径。

--validation <validation_id>

显示验证的执行历史记录

--limit HISTORY_LIMIT

显示 <n> 最新运行的 <validation>. <n> 必须是 > 0。默认的显示限制被设置为 15。

--validation-log-dir VALIDATION_LOG_DIR

验证日志文件的路径。

79.17. tripleo validator show 参数

显示验证参数

使用方法:

openstack tripleo validator show parameter [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--config CONFIG]
                                                  [--validation-dir VALIDATION_DIR]
                                                  [--validation <validation_id>[,<validation_id>,...]
                                                  | --group
                                                  <group_id>[,<group_id>,...]
                                                  | --category
                                                  <category_id>[,<category_id>,...]
                                                  | --product
                                                  <product_id>[,<product_id>,...]]
                                                  [--download DOWNLOAD]
                                                  [--format-output <format_output>]

表 79.29. 命令参数
概述

-h, --help

显示帮助信息并退出

--config CONFIG

验证的配置文件路径。

--validation-dir VALIDATION_DIR

验证 playbook 所在的路径。

--validation <validation_id>[,<validation_id>,…​]

如果需要多个验证,请使用逗号分隔名称,请列出特定的验证。

--group <group_id>[,<group_id>,…​], -g <group_id>[,<group_id>,…​]

列出特定的组验证,如果需要多个组,则使用逗号分隔组名称。

--category <category_id>[,<category_id>,…​]

如果需要多个类别,则按类别列出特定的验证,请使用逗号分隔类别名称。

--product <product_id>[,<product_id>,…​]

如果需要多个产品,则按产品列出特定的验证,请使用逗号分隔产品名称。

--download DOWNLOAD

创建包含可用于验证的所有变量的 json 或 yaml 文件: /tmp/myvars

--format-output <format_output>

输出验证表示。输出格式的选择是 json,yaml。

表 79.30. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 79.31. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 79.32. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 79.33. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

79.18. tripleo validator show run

显示验证执行的详情

使用方法:

openstack tripleo validator show run [-h] [--config CONFIG] [--full]
                                            [--validation-log-dir VALIDATION_LOG_DIR]
                                            <uuid>

表 79.34. positional 参数
概述

<uuid>

验证 uuid 运行

表 79.35. 命令参数
概述

-h, --help

显示帮助信息并退出

--config CONFIG

验证的配置文件路径。

--full

显示运行的完整详情

--validation-log-dir VALIDATION_LOG_DIR

验证日志文件的路径。

79.19. tripleo validator show

显示有关验证的详细信息

使用方法:

openstack tripleo validator show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--config CONFIG]
                                        [--validation-dir VALIDATION_DIR]
                                        <validation>

表 79.36. positional 参数
概述

<validation>

显示特定的验证。

表 79.37. 命令参数
概述

-h, --help

显示帮助信息并退出

--config CONFIG

验证的配置文件路径。

--validation-dir VALIDATION_DIR

验证 playbook 所在的路径。

表 79.38. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 79.39. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 79.40. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 79.41. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 80 章 trust

本章描述了 trust 命令下的命令。

80.1. trust create

创建新信任

使用方法:

openstack trust create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] --project <project> --role
                              <role> [--impersonate]
                              [--expiration <expiration>]
                              [--project-domain <project-domain>]
                              [--trustor-domain <trustor-domain>]
                              [--trustee-domain <trustee-domain>]
                              <trustor-user> <trustee-user>

表 80.1. positional 参数
概述

<trustor-user>

委派授权(名称或 id)的用户

<trustee-user>

假设授权的用户(名称或 id)

表 80.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

正在委托的项目(名称或 id)(必需)

--role <role>

要授权(名称或 id)的角色(重复选项来设置多个值,必需)

--impersonate

从信任生成的令牌将表示 <trustor> (默认为 False)

--expiration <expiration>

为信任设置过期日期(yyyy- mm-ddTHH:MM:SS 的格式)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--trustor-domain <trustor-domain>

包含 <trustor> (名称或 id)的域

--trustee-domain <trustee-domain>

包含 <trustee> (名称或 id)的域

表 80.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 80.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 80.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 80.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

80.2. trust delete

删除信任

使用方法:

openstack trust delete [-h] <trust> [<trust> ...]

表 80.7. positional 参数
概述

<trust>

要删除的信任

表 80.8. 命令参数
概述

-h, --help

显示帮助信息并退出

80.3. 信任列表

列出信任

使用方法:

openstack trust list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]

表 80.9. 命令参数
概述

-h, --help

显示帮助信息并退出

表 80.10. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 80.11. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 80.12. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 80.13. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

80.4. 信任显示

显示信任详情

使用方法:

openstack trust show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty]
                            <trust>

表 80.14. positional 参数
概述

<trust>

信任显示

表 80.15. 命令参数
概述

-h, --help

显示帮助信息并退出

表 80.16. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 80.17. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 80.18. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 80.19. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 81 章 tsigkey

本章论述了 tsigkey 命令下的命令。

81.1. tsigkey create

创建新的 tsigkey

使用方法:

openstack tsigkey create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] --name NAME --algorithm
                                ALGORITHM --secret SECRET --scope SCOPE
                                --resource-id RESOURCE_ID [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]

表 81.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--name NAME

Tsigkey 名称

--algorithm ALGORITHM

Tsigkey 算法

--secret SECRET

Tsigkey secret

--scope SCOPE

Tsigkey 范围

--resource-id RESOURCE_ID

Tsigkey resource_id

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 81.2. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 81.3. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 81.4. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 81.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

81.2. tsigkey delete

删除 tsigkey

使用方法:

openstack tsigkey delete [-h] [--all-projects] [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                id

表 81.6. positional 参数
概述

id

Tsigkey id

表 81.7. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

81.3. tsigkey list

列出 tsigkeys

使用方法:

openstack tsigkey list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN] [--name NAME]
                              [--algorithm ALGORITHM] [--scope SCOPE]
                              [--all-projects] [--edit-managed]
                              [--sudo-project-id SUDO_PROJECT_ID]

表 81.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--name NAME

Tsigkey 名称

--algorithm ALGORITHM

Tsigkey 算法

--scope SCOPE

Tsigkey 范围

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 81.9. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 81.10. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 81.11. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 81.12. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

81.4. tsigkey set

设置 tsigkey 属性

使用方法:

openstack tsigkey set [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--name NAME]
                             [--algorithm ALGORITHM] [--secret SECRET]
                             [--scope SCOPE] [--all-projects] [--edit-managed]
                             [--sudo-project-id SUDO_PROJECT_ID]
                             id

表 81.13. positional 参数
概述

id

Tsigkey id

表 81.14. 命令参数
概述

-h, --help

显示帮助信息并退出

--name NAME

Tsigkey 名称

--algorithm ALGORITHM

Tsigkey 算法

--secret SECRET

Tsigkey secret

--scope SCOPE

Tsigkey 范围

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 81.15. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 81.16. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 81.17. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 81.18. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

81.5. tsigkey show

显示 tsigkey 详情

使用方法:

openstack tsigkey show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--all-projects]
                              [--edit-managed]
                              [--sudo-project-id SUDO_PROJECT_ID]
                              id

表 81.19. positional 参数
概述

id

Tsigkey id

表 81.20. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 81.21. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 81.22. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 81.23. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 81.24. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 82 章 undercloud

本章描述了 undercloud 命令下的命令。

82.1. undercloud 备份

备份 undercloud

使用方法:

openstack undercloud backup [--init [INIT]] [--setup-nfs]
                                   [--setup-rear] [--cron] [--db-only]
                                   [--inventory INVENTORY]
                                   [--add-path ADD_PATH]
                                   [--exclude-path EXCLUDE_PATH]
                                   [--extra-vars EXTRA_VARS]

表 82.1. 命令参数
概述

--init [INIT]

初始化用于备份的环境,使用 rearnfs 作为 args,它将检查软件包安装和配置的 ReaR 或者 NFS 服务器。默认为:rear. 例如 --init rear。警告:此标志将被弃用,并由 --setup-rear--setup-nfs 替代。

--setup-nfs

在备份节点上设置 nfs 服务器,它将在 ansible 清单的主机 BackupNode 上安装所需的软件包和配置。

--setup-rear

在将安装和配置 ReaR 的 undercloud 主机上设置重新执行。

--cron

设置一个新的 cron 作业,默认情况下将在 Sundays 周等执行每周备份,但可以使用 tripleo_backup_and_restore_cron 额外变量进行自定义。

--db-only

undercloud 主机执行 db 备份。db 备份文件将存储在 /home/stack 中,名称为 openstack-backup-mysql-<timestamp>.sql。

--inventory INVENTORY

使用 tripleo-ansible- inventory 命令生成的 tripleo 清单文件。默认为: /home/stack/tripleo- inventory.yaml。

--add-path ADD_PATH

为 backup 添加额外文件。默认为:/home/stack/ i.e. --add-path / this/is/a/folder/ --add- path / this/is/a/texfile.txt

--exclude-path EXCLUDE_PATH

执行 undercloud 备份时排除路径,可以多次指定此选项。默认为:none i.e. --exclude-path / this/is/a/folder/ --exclude-path / this/is/a/texfile.txt

--extra-vars EXTRA_VARS

将额外变量设置为 dict 或为 JSON 或 YAML 文件类型的绝对路径。例如 --extra-vars {"key": "val", "key2": "val2"} i.e. --extra-vars /path/to/my_vars.yaml i.e. --extra-vars /path/to/my_vars.json。有关可传递的变量的更多信息,请访问 :https://opendev.org/openstack/tripleo-ansible/src/bran ch/master/tripleo_ansible/roles/backup_and_restore/def aults/main.yml。

82.2. undercloud 安装

安装和设置 undercloud

使用方法:

openstack undercloud install [--force-stack-update] [--no-validations]
                                    [--inflight-validations] [--dry-run] [-y]

表 82.2. 命令参数
概述

--force-stack-update

对临时 heat 堆栈进行虚拟更新。新的或失败的部署始终具有 stack_action=CREATE。这个选项强制 stack_action=UPDATE。

--no-validations

不要执行 undercloud 配置验证

--inflight-validations

在部署期间激活动态验证。动态验证提供了一种强大的方法,以确保部署的服务在激活后运行。默认值为 False。

--dry-run

打印 install 命令而不是运行它

-y, --yes

跳过是/无提示(假设是 yes)。

82.3. undercloud minion 安装

安装和设置 undercloud minion

使用方法:

openstack undercloud minion install [--force-stack-update]
                                           [--no-validations] [--dry-run] [-y]

表 82.3. 命令参数
概述

--force-stack-update

对临时 heat 堆栈进行虚拟更新。新的或失败的部署始终具有 stack_action=CREATE。这个选项强制 stack_action=UPDATE。

--no-validations

不要执行 minion 配置验证

--dry-run

打印 install 命令而不是运行它

-y, --yes

跳过是/无提示(假设是 yes)。

82.4. undercloud minion 升级

升级 undercloud minion

使用方法:

openstack undercloud minion upgrade [--force-stack-update]
                                           [--no-validations] [--dry-run] [-y]

表 82.4. 命令参数
概述

--force-stack-update

对临时 heat 堆栈进行虚拟更新。新的或失败的部署始终具有 stack_action=CREATE。这个选项强制 stack_action=UPDATE。

--no-validations

不要执行 minion 配置验证

--dry-run

打印 install 命令而不是运行它

-y, --yes

跳过是/无提示(假设是 yes)。

82.5. undercloud 升级

升级 undercloud

使用方法:

openstack undercloud upgrade [--force-stack-update] [--no-validations]
                                    [--inflight-validations] [--dry-run] [-y]
                                    [--skip-package-updates]

表 82.5. 命令参数
概述

--force-stack-update

对临时 heat 堆栈进行虚拟更新。新的或失败的部署始终具有 stack_action=CREATE。这个选项强制 stack_action=UPDATE。

--no-validations

不要执行 undercloud 配置验证

--inflight-validations

在部署期间激活动态验证。动态验证提供了一种强大的方法,以确保部署的服务在激活后运行。默认值为 False。

--dry-run

打印 install 命令而不是运行它

-y, --yes

跳过是/无提示(假设是 yes)。

--skip-package-updates

执行升级和更新时跳过软件包更新的标志

第 83 章 usage

本章描述了 usage 命令下的命令。

83.1. 使用列表

列出每个项目的资源使用量

使用方法:

openstack usage list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--start <start>] [--end <end>]

表 83.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--start <start>

使用范围开始日期 ex 2012-01-20 (默认值:4 周前)

--end <end>

使用范围结束日期,ex 2012-01-20 (默认:以下)

表 83.2. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 83.3. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 83.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 83.5. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

83.2. 用法显示

显示单个项目的资源使用情况

使用方法:

openstack usage show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--project <project>]
                            [--start <start>] [--end <end>]

表 83.6. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

用于显示使用情况的项目的名称或 ID

--start <start>

使用范围开始日期 ex 2012-01-20 (默认值:4 周前)

--end <end>

使用范围结束日期,ex 2012-01-20 (默认:以下)

表 83.7. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 83.8. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 83.9. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 83.10. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 84 章 user

本章描述了 user 命令下的命令。

84.1. User create

创建新用户

使用方法:

openstack user create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--domain <domain>]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--password <password>] [--password-prompt]
                             [--email <email-address>]
                             [--description <description>]
                             [--enable | --disable] [--or-show]
                             <name>

表 84.1. positional 参数
概述

<name>

新用户名

表 84.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

默认域(名称或 id)

--project <project>

默认项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--password <password>

设置用户密码

--password-prompt

以互动方式输入密码

--email <email-address>

设置用户电子邮件地址

--description <description>

用户描述

--enable

启用用户(默认)

--disable

禁用用户

--or-show

返回现有用户

表 84.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 84.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 84.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 84.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

84.2. user delete

删除用户

使用方法:

openstack user delete [-h] [--domain <domain>] <user> [<user> ...]

表 84.7. positional 参数
概述

<user>

要删除的用户(名称或 id)

表 84.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

域拥有 <user> (名称或 id)

84.3. 用户列表

列出用户

使用方法:

openstack user list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           [--domain <domain>]
                           [--group <group> | --project <project>] [--long]

表 84.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

--group <group>

--project <project>

--long

表 84.10. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

--sort-column SORT_COLUMN

表 84.11. 
概述

--quote {all,minimal,none,nonnumeric}

表 84.12. 
概述

--noindent

表 84.13. 
概述

--max-width <integer>

--fit-width

--print-empty

84.4. 

使用方法:

openstack user password set [-h] [--password <new-password>]
                                   [--original-password <original-password>]

表 84.14. 命令参数
概述

-h, --help

显示帮助信息并退出

--password <new-password>

--original-password <original-password>

84.5. 

使用方法:

openstack user set [-h] [--name <name>] [--domain <domain>]
                          [--project <project>]
                          [--project-domain <project-domain>]
                          [--password <password>] [--password-prompt]
                          [--email <email-address>]
                          [--description <description>] [--enable | --disable]
                          <user>

表 84.15. 
概述

<user>

表 84.16. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

--domain <domain>

--project <project>

--project-domain <project-domain>

--password <password>

--password-prompt

--email <email-address>

--description <description>

--enable

--disable

84.6. 

使用方法:

openstack user show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--domain <domain>]
                           <user>

表 84.17. 
概述

<user>

表 84.18. 命令参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

表 84.19. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 84.20. 
概述

--noindent

表 84.21. 
概述

--prefix PREFIX

表 84.22. 
概述

--max-width <integer>

--fit-width

--print-empty

第 85 章 

85.1. 

使用方法:

openstack versions show [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN]
                               [--all-interfaces | --interface <interface>]
                               [--region-name <region_name>]
                               [--service <region_name>]
                               [--status <region_name>]

表 85.1. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-interfaces

--interface <interface>

--region-name <region_name>

--service <region_name>

--status <region_name>

表 85.2. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

--sort-column SORT_COLUMN

表 85.3. 
概述

--quote {all,minimal,none,nonnumeric}

表 85.4. 
概述

--noindent

表 85.5. 
概述

--max-width <integer>

--fit-width

--print-empty

第 86 章 

86.1. 

使用方法:

openstack volume backup create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--name <name>]
                                      [--description <description>]
                                      [--container <container>]
                                      [--snapshot <snapshot>] [--force]
                                      [--incremental]
                                      <volume>

表 86.1. 
概述

<volume>

表 86.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

--description <description>

--container <container>

--snapshot <snapshot>

--force

--incremental

表 86.3. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 86.4. 
概述

--noindent

表 86.5. 
概述

--prefix PREFIX

表 86.6. 
概述

--max-width <integer>

--fit-width

--print-empty

86.2. 

使用方法:

openstack volume backup delete [-h] [--force] <backup> [<backup> ...]

表 86.7. 
概述

<backup>

表 86.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--force

86.3. 

使用方法:

openstack volume backup list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN] [--long]
                                    [--name <name>] [--status <status>]
                                    [--volume <volume>]
                                    [--marker <volume-backup>]
                                    [--limit <num-backups>] [--all-projects]

表 86.9. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

--name <name>

--status <status>

--volume <volume>

--marker <volume-backup>

--limit <num-backups>

--all-projects

表 86.10. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

--sort-column SORT_COLUMN

表 86.11. 
概述

--quote {all,minimal,none,nonnumeric}

表 86.12. 
概述

--noindent

表 86.13. 
概述

--max-width <integer>

--fit-width

--print-empty

86.4. 

使用方法:

openstack volume backup restore [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <backup> <volume>

表 86.14. 
概述

<backup>

<volume>

表 86.15. 命令参数
概述

-h, --help

显示帮助信息并退出

表 86.16. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 86.17. 
概述

--noindent

表 86.18. 
概述

--prefix PREFIX

表 86.19. 
概述

--max-width <integer>

--fit-width

--print-empty

86.5. 

使用方法:

openstack volume backup set [-h] [--name <name>]
                                   [--description <description>]
                                   [--state <state>]
                                   <backup>

表 86.20. 
概述

<backup>

表 86.21. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

--description <description>

--state <state>

86.6. 

使用方法:

openstack volume backup show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <backup>

表 86.22. 
概述

<backup>

表 86.23. 命令参数
概述

-h, --help

显示帮助信息并退出

表 86.24. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 86.25. 
概述

--noindent

表 86.26. 
概述

--prefix PREFIX

表 86.27. 
概述

--max-width <integer>

--fit-width

--print-empty

86.7. 

使用方法:

openstack volume create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--size <size>]
                               [--type <volume-type>]
                               [--image <image> | --snapshot <snapshot> | --source <volume>]
                               [--description <description>]
                               [--availability-zone <availability-zone>]
                               [--consistency-group consistency-group>]
                               [--property <key=value>] [--hint <key=value>]
                               [--bootable | --non-bootable]
                               [--read-only | --read-write]
                               <name>

表 86.28. 
概述

<name>

表 86.29. 命令参数
概述

-h, --help

显示帮助信息并退出

--size <size>

--type <volume-type>

--image <image>

--snapshot <snapshot>

--source <volume>

--description <description>

--availability-zone <availability-zone>

--consistency-group consistency-group>

--property <key=value>

--hint <key=value>

--bootable

--non-bootable

--read-only

--read-write

表 86.30. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

表 86.31. 
概述

--noindent

表 86.32. 
概述

--prefix PREFIX

表 86.33. 
概述

--max-width <integer>

--fit-width

--print-empty

86.8. 

使用方法:

openstack volume delete [-h] [--force | --purge]
                               <volume> [<volume> ...]

表 86.34. 
概述

<volume>

表 86.35. 命令参数
概述

-h, --help

显示帮助信息并退出

--force

--purge

86.9. 

使用方法:

openstack volume host set [-h] [--disable | --enable] <host-name>

表 86.36. 
概述

<host-name>

表 86.37. 命令参数
概述

-h, --help

显示帮助信息并退出

--disable

--enable

thaw 并启用指定的卷主机

86.10. 卷列表

列出卷

使用方法:

openstack volume list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN] [--project <project>]
                             [--project-domain <project-domain>]
                             [--user <user>] [--user-domain <user-domain>]
                             [--name <name>] [--status <status>]
                             [--all-projects] [--long] [--marker <volume>]
                             [--limit <num-volumes>]

表 86.38. 命令参数
概述

-h, --help

显示帮助信息并退出

--project <project>

根据项目(名称或 id)过滤结果(仅限管理员)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--user <user>

按用户(名称或 id)过滤结果(仅限管理员)

--user-domain <user-domain>

用户所属的域(名称或 id)。这可用于在用户名之间存在冲突时使用。

--name <name>

按卷名称过滤结果

--status <status>

按状态过滤结果

--all-projects

包括所有项目(仅限管理员)

--long

列出输出中的其他字段

--marker <volume>

上一页的最后卷 ID

--limit <num-volumes>

要显示的最大卷数

表 86.39. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 86.40. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 86.41. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.42. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.11. 卷迁移

将卷迁移到新主机

使用方法:

openstack volume migrate [-h] --host <host> [--force-host-copy]
                                [--lock-volume]
                                <volume>

表 86.43. positional 参数
概述

<volume>

要迁移的卷(名称或 id)

表 86.44. 命令参数
概述

-h, --help

显示帮助信息并退出

--host <host>

目标主机(获取表单:host@backend-name thepool)

--force-host-copy

启用基于主机的通用强制迁移,这会绕过驱动程序优化

--lock-volume

如果指定,卷状态将会被锁定,并且不允许中止迁移(可能会被另一个操作)

86.12. 卷 qos 关联

将 QoS 规格与卷类型关联

使用方法:

openstack volume qos associate [-h] <qos-spec> <volume-type>

表 86.45. positional 参数
概述

<qos-spec>

要修改的 QoS 规格(名称或 id)

<volume-type>

要关联 qos (名称或 id)的卷类型

表 86.46. 命令参数
概述

-h, --help

显示帮助信息并退出

86.13. 卷 qos create

创建新的 QoS 规格

使用方法:

openstack volume qos create [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty] [--consumer <consumer>]
                                   [--property <key=value>]
                                   <name>

表 86.47. positional 参数
概述

<name>

新的 qos 规格名称

表 86.48. 命令参数
概述

-h, --help

显示帮助信息并退出

--consumer <consumer>

qos. 有效消费者的消费者:后端、前端(默认为 两者

--property <key=value>

设置 qos 规格属性(重复选项来设置多个属性)

表 86.49. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 86.50. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.51. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 86.52. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.14. 卷 qos delete

删除 QoS 规格

使用方法:

openstack volume qos delete [-h] [--force] <qos-spec> [<qos-spec> ...]

表 86.53. positional 参数
概述

<qos-spec>

要删除的 QoS 规格(名称或 id)

表 86.54. 命令参数
概述

-h, --help

显示帮助信息并退出

--force

允许删除正在使用的 qos 规格

86.15. 卷 qos 解除关联

从卷类型解除 QoS 规格关联

使用方法:

openstack volume qos disassociate [-h]
                                         [--volume-type <volume-type> | --all]
                                         <qos-spec>

表 86.55. positional 参数
概述

<qos-spec>

要修改的 QoS 规格(名称或 id)

表 86.56. 命令参数
概述

-h, --help

显示帮助信息并退出

--volume-type <volume-type>

卷类型从中解除 qos (名称或 id)

--all

从每个卷类型解除 qos 解除关联

86.16. 卷 qos list

列出 QoS 规格

使用方法:

openstack volume qos list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN]

表 86.57. 命令参数
概述

-h, --help

显示帮助信息并退出

表 86.58. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 86.59. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 86.60. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.61. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.17. 卷 qos set

设置 QoS 规格属性

使用方法:

openstack volume qos set [-h] [--property <key=value>] <qos-spec>

表 86.62. positional 参数
概述

<qos-spec>

要修改的 QoS 规格(名称或 id)

表 86.63. 命令参数
概述

-h, --help

显示帮助信息并退出

--property <key=value>

为此 qos 规格添加或修改的属性(需要设置多个属性)

86.18. 卷 qos show

显示 QoS 规格详情

使用方法:

openstack volume qos show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <qos-spec>

表 86.64. positional 参数
概述

<qos-spec>

要显示的 QoS 规格(名称或 id)

表 86.65. 命令参数
概述

-h, --help

显示帮助信息并退出

表 86.66. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 86.67. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.68. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 86.69. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.19. 卷 qos unset

取消设置 QoS 规格属性

使用方法:

openstack volume qos unset [-h] [--property <key>] <qos-spec>

表 86.70. positional 参数
概述

<qos-spec>

要修改的 QoS 规格(名称或 id)

表 86.71. 命令参数
概述

-h, --help

显示帮助信息并退出

--property <key>

从 qos 规格中删除的属性。(重复选项取消设置多个属性)

86.20. 卷服务列表

列出 service 命令

使用方法:

openstack volume service list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--host <host>] [--service <service>]
                                     [--long]

表 86.72. 命令参数
概述

-h, --help

显示帮助信息并退出

--host <host>

列出指定主机上的服务(仅限名称)

--service <service>

仅列出指定的服务(仅限名称)

--long

列出输出中的其他字段

表 86.73. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 86.74. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 86.75. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.76. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.21. 卷服务集

设置卷服务属性

使用方法:

openstack volume service set [-h] [--enable | --disable]
                                    [--disable-reason <reason>]
                                    <host> <service>

表 86.77. positional 参数
概述

<host>

主机的名称

<service>

服务的名称(二进制名称)

表 86.78. 命令参数
概述

-h, --help

显示帮助信息并退出

--enable

启用卷服务

--disable

禁用卷服务

--disable-reason <reason>

禁用该服务的原因(应该与 --disable 选项一起使用)

86.22. 卷集

设置卷属性

使用方法:

openstack volume set [-h] [--name <name>] [--size <size>]
                            [--description <description>] [--no-property]
                            [--property <key=value>]
                            [--image-property <key=value>] [--state <state>]
                            [--attached | --detached] [--type <volume-type>]
                            [--retype-policy <retype-policy>]
                            [--bootable | --non-bootable]
                            [--read-only | --read-write]
                            <volume>

表 86.79. positional 参数
概述

<volume>

要修改的卷(名称或 id)

表 86.80. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新卷名称

--size <size>

在 gb 中扩展卷大小

--description <description>

新卷描述

--no-property

从 <volume> 中删除所有属性(指定 --no-property 和 --property,以在设置新属性前删除当前属性)。

--property <key=value>

在这个卷上设置属性(重复选项来设置多个属性)

--image-property <key=value>

在这个卷上设置 image 属性(重复选项来设置多个镜像属性)

--state <state>

新卷状态("available", "error", "creating", "deleting", "in-use", "attaching", "detaching", "error_deleting" 或 "maintenance") (仅管理员)(此选项只是更改数据库中卷的状态,而不会考虑实际状态,在使用时不谨慎)

--attached

将卷附加状态设置为"附加" (仅限管理员)(此选项只是更改数据库中卷的状态,不考虑实际状态,在使用时请小心)

--detached

将卷附加状态设置为 "detached" (仅限管理员)(此选项只是更改数据库中卷的状态,而无需考虑实际状态,在使用时请小心)

--type <volume-type>

新卷类型(名称或 id)

--retype-policy <retype-policy>

在重新调整卷时迁移策略("never" 或 "on-demand",默认为 "never") (仅在指定 --type 选项时才可用)

--bootable

将卷标记为可引导

--non-bootable

将卷标记为不可引导

--read-only

将 volume 设置为只读访问模式

--read-write

将 volume 设置为读写访问模式

86.23. 卷显示

显示卷详情

使用方法:

openstack volume show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <volume>

表 86.81. positional 参数
概述

<volume>

要显示的卷(名称或 id)

表 86.82. 命令参数
概述

-h, --help

显示帮助信息并退出

表 86.83. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 86.84. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.85. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 86.86. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.24. 卷快照创建

创建新卷快照

使用方法:

openstack volume snapshot create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--volume <volume>]
                                        [--description <description>]
                                        [--force] [--property <key=value>]
                                        [--remote-source <key=value>]
                                        <snapshot-name>

表 86.87. positional 参数
概述

<snapshot-name>

新快照的名称

表 86.88. 命令参数
概述

-h, --help

显示帮助信息并退出

--volume <volume>

对快照的卷(名称或 id)(默认为 <snapshot- name>)

--description <description>

快照的描述

--force

创建连接到实例的快照。默认为 False

--property <key=value>

为此快照设置属性(重复选项来设置多个属性)

--remote-source <key=value>

exsiting 远程卷快照(admin required)的属性(需要指定多个属性)例如:-- remote-source source- name=test_name --remote-source source-id=test_id

表 86.89. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 86.90. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.91. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 86.92. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.25. 卷快照删除

删除卷快照

使用方法:

openstack volume snapshot delete [-h] [--force]
                                        <snapshot> [<snapshot> ...]

表 86.93. positional 参数
概述

<snapshot>

要删除的快照(名称或 id)

表 86.94. 命令参数
概述

-h, --help

显示帮助信息并退出

--force

尝试强制删除快照,无论状态是什么(默认为 False)

86.26. 卷快照列表

列出卷快照

使用方法:

openstack volume snapshot list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--all-projects] [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--long] [--marker <volume-snapshot>]
                                      [--limit <num-snapshots>]
                                      [--name <name>] [--status <status>]
                                      [--volume <volume>]

表 86.95. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

包括所有项目(仅限管理员)

--project <project>

根据项目(名称或 id)过滤结果(仅限管理员)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--long

列出输出中的其他字段

--marker <volume-snapshot>

上一页的最后快照 ID

--limit <num-snapshots>

要显示的最大快照数

--name <name>

根据名称过滤结果。

--status <status>

按状态过滤结果(可用错误创建删除 或错误)

--volume <volume>

按卷(名称或 id)过滤结果。

表 86.96. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 86.97. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 86.98. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.99. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.27. 卷快照集

设置卷快照属性

使用方法:

openstack volume snapshot set [-h] [--name <name>]
                                     [--description <description>]
                                     [--no-property] [--property <key=value>]
                                     [--state <state>]
                                     <snapshot>

表 86.100. positional 参数
概述

<snapshot>

要修改的快照(名称或 id)

表 86.101. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新快照名称

--description <description>

新快照描述

--no-property

从 <snapshot> 中删除所有属性(指定 --no-property 和 --property,以在设置新属性前删除当前属性)。

--property <key=value>

为这个快照添加/更改的属性(重复选项来设置多个属性)

--state <state>

新快照状态。("available", "error", "creating", "deleting", 或 "error_deleting") (仅限管理员)(此选项只是更改数据库中快照的状态,不考虑实际状态,在使用时请小心)

86.28. 卷快照显示

显示卷快照详情

使用方法:

openstack volume snapshot show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <snapshot>

表 86.102. positional 参数
概述

<snapshot>

要显示的快照(名称或 id)

表 86.103. 命令参数
概述

-h, --help

显示帮助信息并退出

表 86.104. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 86.105. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.106. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 86.107. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.29. 卷快照取消设置

取消设置卷快照属性

使用方法:

openstack volume snapshot unset [-h] [--property <key>] <snapshot>

表 86.108. positional 参数
概述

<snapshot>

要修改的快照(名称或 id)

表 86.109. 命令参数
概述

-h, --help

显示帮助信息并退出

--property <key>

从快照中删除的属性(重复选项来删除多个属性)

86.30. 卷传输请求接受

接受卷传输请求。

使用方法:

openstack volume transfer request accept [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                --auth-key <key>
                                                <transfer-request-id>

表 86.110. positional 参数
概述

<transfer-request-id>

要接受的卷传输请求(仅限id)

表 86.111. 命令参数
概述

-h, --help

显示帮助信息并退出

--auth-key <key>

卷传输请求身份验证密钥

表 86.112. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 86.113. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.114. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 86.115. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.31. 卷传输请求创建

创建卷传输请求。

使用方法:

openstack volume transfer request create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--name <name>]
                                                <volume>

表 86.116. positional 参数
概述

<volume>

要传输的卷(名称或 id)

表 86.117. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新传输请求名称(默认为 none)

表 86.118. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 86.119. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.120. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 86.121. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.32. 卷传输请求删除

删除卷传输请求。

使用方法:

openstack volume transfer request delete [-h]
                                                <transfer-request>
                                                [<transfer-request> ...]

表 86.122. positional 参数
概述

<transfer-request>

要删除的卷传输请求(名称或 id)

表 86.123. 命令参数
概述

-h, --help

显示帮助信息并退出

86.33. 卷传输请求列表

列出所有卷传输请求。

使用方法:

openstack volume transfer request list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              [--all-projects]

表 86.124. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

包括所有项目(仅限管理员)

表 86.125. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 86.126. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 86.127. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.128. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.34. 卷传输请求显示

显示卷传输请求详情。

使用方法:

openstack volume transfer request show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              <transfer-request>

表 86.129. positional 参数
概述

<transfer-request>

要显示的卷传输请求(名称或 id)

表 86.130. 命令参数
概述

-h, --help

显示帮助信息并退出

表 86.131. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 86.132. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.133. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 86.134. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.35. 卷类型创建

创建新卷类型

使用方法:

openstack volume type create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    [--description <description>]
                                    [--public | --private]
                                    [--property <key=value>]
                                    [--project <project>]
                                    [--encryption-provider <provider>]
                                    [--encryption-cipher <cipher>]
                                    [--encryption-key-size <key-size>]
                                    [--encryption-control-location <control-location>]
                                    [--project-domain <project-domain>]
                                    <name>

表 86.135. positional 参数
概述

<name>

卷类型名称

表 86.136. 命令参数
概述

-h, --help

显示帮助信息并退出

--description <description>

卷类型描述

--public

公共可以访问卷类型

--private

公共无法访问卷类型

--property <key=value>

在此卷类型上设置属性(重复选项来设置多个属性)

--project <project>

允许 <project> 访问私有类型(名称或 id)(与 --private 选项一起使用)

--encryption-provider <provider>

为此卷类型(如 "luks" 或 "plain" 或 "plain")(仅管理员)设置加密供应商格式(仅在设置卷的加密类型时需要此选项)。考虑使用其他加密选项,如 "-- encryption-cipher", "--encryption-key-size" 和 "-- encryption-control-location")

--encryption-cipher <cipher>

设置此卷类型的加密算法或模式(如 "aes-xts-plain64")(仅限 admin)

--encryption-key-size <key-size>

设置此卷类型的加密密钥大小(如 "128" 或 "256")(仅限 admin)

--encryption-control-location <control-location>

设置执行加密的 notional 服务("前端"或"后端"或"后端" (仅限管理员) (此选项的默认值是"前端"。考虑使用其他加密选项,如:"--encryption-password"、"--encryption-key-size" 和 "--encryption- provider")

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

表 86.137. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 86.138. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.139. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 86.140. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.36. 卷类型删除

删除卷类型

使用方法:

openstack volume type delete [-h] <volume-type> [<volume-type> ...]

表 86.141. positional 参数
概述

<volume-type>

要删除的卷类型(名称或 id)

表 86.142. 命令参数
概述

-h, --help

显示帮助信息并退出

86.37. 卷类型列表

列出卷类型

使用方法:

openstack volume type list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN] [--long]
                                  [--default | --public | --private]
                                  [--encryption-type]

表 86.143. 命令参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

--default

列出默认卷类型

--public

仅列出公共类型

--private

仅列出私有类型(仅限管理员)

--encryption-type

显示每种卷类型的加密信息(仅限 admin)

表 86.144. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 86.145. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 86.146. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.147. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.38. 卷类型集

设置卷类型属性

使用方法:

openstack volume type set [-h] [--name <name>]
                                 [--description <description>]
                                 [--property <key=value>]
                                 [--project <project>]
                                 [--project-domain <project-domain>]
                                 [--encryption-provider <provider>]
                                 [--encryption-cipher <cipher>]
                                 [--encryption-key-size <key-size>]
                                 [--encryption-control-location <control-location>]
                                 <volume-type>

表 86.148. positional 参数
概述

<volume-type>

要修改的卷类型(名称或 id)

表 86.149. 命令参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置卷类型名称

--description <description>

设置卷类型描述

--property <key=value>

在此卷类型上设置属性(重复选项来设置多个属性)

--project <project>

设置项目(名称或 ID)的卷类型访问权限(仅限管理员)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--encryption-provider <provider>

为此卷类型(如"luks"或"plain"或"plain" (仅管理员)设置加密供应商格式(仅在第一次设置卷的加密类型时需要此选项)。考虑使用其他加密选项,如 "--encryption-cipher", "--encryption- key-size" 和 "--encryption-control-location")

--encryption-cipher <cipher>

设置此卷类型的加密算法或模式(如 "aes-xts-plain64")(仅限 admin)

--encryption-key-size <key-size>

设置此卷类型的加密密钥大小(如 "128" 或 "256")(仅限 admin)

--encryption-control-location <control-location>

设置执行加密的 notional 服务("前端"或"后端"或"后端" (仅限管理员) (此选项的默认值是"前端"。考虑使用其他加密选项,如 "--encryption-cipher", "--encryption-key-size" 和 "-- encryption-provider")

86.39. 卷类型显示

显示卷类型详情

使用方法:

openstack volume type show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--encryption-type]
                                  <volume-type>

表 86.150. positional 参数
概述

<volume-type>

要显示的卷类型(名称或 id)

表 86.151. 命令参数
概述

-h, --help

显示帮助信息并退出

--encryption-type

显示此卷类型的加密信息(仅限 admin)

表 86.152. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 86.153. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 86.154. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 86.155. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

86.40. 卷类型未设置

取消设置卷类型属性

使用方法:

openstack volume type unset [-h] [--property <key>]
                                   [--project <project>]
                                   [--project-domain <project-domain>]
                                   [--encryption-type]
                                   <volume-type>

表 86.156. positional 参数
概述

<volume-type>

要修改的卷类型(名称或 id)

表 86.157. 命令参数
概述

-h, --help

显示帮助信息并退出

--property <key>

从此卷类型中删除属性(重复选项来删除多个属性)

--project <project>

删除对项目的卷类型访问(名称或 ID)(仅限管理员)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可用于在项目名称之间存在冲突时使用。

--encryption-type

删除此卷类型的加密类型(仅限 admin)

86.41. 卷取消设置

取消设置卷属性

使用方法:

openstack volume unset [-h] [--property <key>] [--image-property <key>]
                              <volume>

表 86.158. positional 参数
概述

<volume>

要修改的卷(名称或 id)

表 86.159. 命令参数
概述

-h, --help

显示帮助信息并退出

--property <key>

从卷中删除属性(重复选项删除多个属性)

--image-property <key>

从卷中删除镜像属性(需要删除多个镜像属性)

第 87 章 法国

本章描述了参与命令下的 命令

87.1. 法国创建

创建新的技术。

使用方法:

openstack workbook create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--public]
                                 [--namespace [NAMESPACE]]
                                 definition

表 87.1. positional 参数
概述

定义

指导定义文件

表 87.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--public

使用此标志将标记为"public"。

--namespace [NAMESPACE]

在其中创建参与的命名空间。

表 87.3. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 87.4. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 87.5. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 87.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

87.2. 指导定义显示

显示指导定义。

使用方法:

openstack workbook definition show [-h] name

表 87.7. positional 参数
概述

name

合作伙伴名称

表 87.8. 命令参数
概述

-h, --help

显示帮助信息并退出

87.3. 领导删除

删除参与。

使用方法:

openstack workbook delete [-h] [--namespace [NAMESPACE]]
                                 workbook [workbook ...]

表 87.9. positional 参数
概述

法国

参与的名称。

表 87.10. 命令参数
概述

-h, --help

显示帮助信息并退出

--namespace [NAMESPACE]

从中删除参与的命名空间。

87.4. 参与列表

列出所有技术。

使用方法:

openstack workbook list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN] [--marker [MARKER]]
                               [--limit [LIMIT]] [--sort_keys [SORT_KEYS]]
                               [--sort_dirs [SORT_DIRS]] [--filter FILTERS]

表 87.11. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

上一页的最后执行 uuid 显示在"marker"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

以逗号分隔的排序键列表,按以下方式对结果进行排序。默认: created_at。示例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序方向列表。默认为 asc。示例:mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

filters. 可以重复。

表 87.12. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 87.13. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 87.14. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 87.15. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

87.5. 法国显示

显示特定的活动。

使用方法:

openstack workbook show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--namespace [NAMESPACE]]
                               workbook

表 87.16. positional 参数
概述

法国

合作伙伴名称

表 87.17. 命令参数
概述

-h, --help

显示帮助信息并退出

--namespace [NAMESPACE]

从中获取参与的命名空间。

表 87.18. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 87.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 87.20. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 87.21. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

87.6. 领导更新

更新活动。

使用方法:

openstack workbook update [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--namespace [NAMESPACE]]
                                 [--public]
                                 definition

表 87.22. positional 参数
概述

定义

指导定义文件

表 87.23. 命令参数
概述

-h, --help

显示帮助信息并退出

--namespace [NAMESPACE]

更新参与的命名空间。

--public

使用此标志将标记为"public"。

表 87.24. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 87.25. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 87.26. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 87.27. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

87.7. 法国验证

验证参与。

使用方法:

openstack workbook validate [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   definition

表 87.28. positional 参数
概述

定义

指导定义文件

表 87.29. 命令参数
概述

-h, --help

显示帮助信息并退出

表 87.30. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 87.31. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 87.32. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 87.33. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 88 章 工作流

本章描述了 workflow 命令下的命令。

88.1. 工作流创建

创建新工作流。

使用方法:

openstack workflow create [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN]
                                 [--marker [MARKER]] [--limit [LIMIT]]
                                 [--sort_keys [SORT_KEYS]]
                                 [--sort_dirs [SORT_DIRS]] [--filter FILTERS]
                                 [--namespace [NAMESPACE]] [--public]
                                 definition

表 88.1. positional 参数
概述

定义

工作流定义文件。

表 88.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

上一页的最后执行 uuid 显示在"marker"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

以逗号分隔的排序键列表,按以下方式对结果进行排序。默认: created_at。示例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序方向列表。默认为 asc。示例:mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

filters. 可以重复。

--namespace [NAMESPACE]

在其中创建工作流的命名空间。

--public

使用此标志工作流将标记为"public"。

表 88.3. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 88.4. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 88.5. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 88.6. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

88.2. 工作流定义显示

显示工作流定义。

使用方法:

openstack workflow definition show [-h] [--namespace [NAMESPACE]]
                                          identifier

表 88.7. positional 参数
概述

identifier

工作流 ID 或名称。

表 88.8. 命令参数
概述

-h, --help

显示帮助信息并退出

--namespace [NAMESPACE]

从中获取工作流的命名空间。

88.3. 工作流删除

删除工作流。

使用方法:

openstack workflow delete [-h] [--namespace [NAMESPACE]]
                                 workflow [workflow ...]

表 88.9. positional 参数
概述

工作流

工作流的名称或 ID。

表 88.10. 命令参数
概述

-h, --help

显示帮助信息并退出

--namespace [NAMESPACE]

从中删除工作流的命名空间。

88.4. 工作流引擎服务列表

列出所有服务。

使用方法:

openstack workflow engine service list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--noindent]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--sort-column SORT_COLUMN]
                                              [--marker [MARKER]]
                                              [--limit [LIMIT]]
                                              [--sort_keys [SORT_KEYS]]
                                              [--sort_dirs [SORT_DIRS]]
                                              [--filter FILTERS]

表 88.11. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

上一页的最后执行 uuid 显示在"marker"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

以逗号分隔的排序键列表,按以下方式对结果进行排序。默认: created_at。示例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序方向列表。默认为 asc。示例:mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

filters. 可以重复。

表 88.12. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 88.13. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 88.14. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 88.15. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

88.5. 工作流 env create

创建新环境。

使用方法:

openstack workflow env create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     file

表 88.16. positional 参数
概述

file

json 或 yaml 中的环境文件

表 88.17. 命令参数
概述

-h, --help

显示帮助信息并退出

表 88.18. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 88.19. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 88.20. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 88.21. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

88.6. 工作流 env 删除

删除环境。

使用方法:

openstack workflow env delete [-h] environment [environment ...]

表 88.22. positional 参数
概述

环境

环境的名称。

表 88.23. 命令参数
概述

-h, --help

显示帮助信息并退出

88.7. 工作流 env 列表

列出所有环境。

使用方法:

openstack workflow env list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--marker [MARKER]] [--limit [LIMIT]]
                                   [--sort_keys [SORT_KEYS]]
                                   [--sort_dirs [SORT_DIRS]]
                                   [--filter FILTERS]

表 88.24. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

上一页的最后执行 uuid 显示在"marker"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

以逗号分隔的排序键列表,按以下方式对结果进行排序。默认: created_at。示例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序方向列表。默认为 asc。示例:mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

filters. 可以重复。

表 88.25. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 88.26. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 88.27. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 88.28. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

88.8. 工作流 env 显示

显示特定环境。

使用方法:

openstack workflow env show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty] [--export]
                                   environment

表 88.29. positional 参数
概述

环境

环境名称

表 88.30. 命令参数
概述

-h, --help

显示帮助信息并退出

--export

导出适合导入的环境

表 88.31. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 88.32. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 88.33. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 88.34. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

88.9. 工作流环境变量更新

更新环境。

使用方法:

openstack workflow env update [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     file

表 88.35. positional 参数
概述

file

json 或 yaml 中的环境文件

表 88.36. 命令参数
概述

-h, --help

显示帮助信息并退出

表 88.37. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 88.38. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 88.39. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 88.40. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

88.10. 工作流执行创建

创建新执行。

使用方法:

openstack workflow execution create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--namespace [NAMESPACE]]
                                           [-d DESCRIPTION]
                                           [-s [SOURCE_EXECUTION_ID]]
                                           [workflow_identifier]
                                           [workflow_input] [params]

表 88.41. positional 参数
概述

workflow_identifier

工作流 ID 或名称。自 Mitaka 开始,工作流名称将被弃用。

workflow_input

工作流输入

params

工作流附加参数

表 88.42. 命令参数
概述

-h, --help

显示帮助信息并退出

--namespace [NAMESPACE]

工作流命名空间。

-d DESCRIPTION, --description DESCRIPTION

执行描述

-s [SOURCE_EXECUTION_ID]

工作流执行 id,操作员将根据之前成功执行的工作流创建新的工作流执行。示例:mistral execution-create -s 123e4567-e89b-12d3-a456-426655440000

表 88.43. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 88.44. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 88.45. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 88.46. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

88.11. 工作流执行删除

删除执行。

使用方法:

openstack workflow execution delete [-h] [--force]
                                           execution [execution ...]

表 88.47. positional 参数
概述

执行

执行标识符的 ID。

表 88.48. 命令参数
概述

-h, --help

显示帮助信息并退出

--force

强制删除执行。如果用于运行执行,可能会导致级联错误。

88.12. 工作流执行输入显示

显示执行输入数据。

使用方法:

openstack workflow execution input show [-h] id

表 88.49. positional 参数
概述

id

执行 ID

表 88.50. 命令参数
概述

-h, --help

显示帮助信息并退出

88.13. 工作流执行列表

列出所有执行。

使用方法:

openstack workflow execution list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]
                                         [--marker [MARKER]] [--limit [LIMIT]]
                                         [--sort_keys [SORT_KEYS]]
                                         [--sort_dirs [SORT_DIRS]]
                                         [--filter FILTERS] [--oldest]
                                         [--task [TASK]]

表 88.51. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

上一页的最后执行 uuid 显示在"marker"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

以逗号分隔的排序键列表,按以下方式对结果进行排序。默认: created_at。示例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序方向列表。默认为 asc。示例:mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

filters. 可以重复。

--oldest

显示从最旧的条目而不是最新的条目开始的执行

--task [TASK]

与工作流执行列表关联的父任务执行 id。

表 88.52. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 88.53. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 88.54. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 88.55. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

88.14. 工作流执行输出显示

显示执行输出数据。

使用方法:

openstack workflow execution output show [-h] id

表 88.56. positional 参数
概述

id

执行 ID

表 88.57. 命令参数
概述

-h, --help

显示帮助信息并退出

88.15. 工作流执行公布的显示

显示工作流全局发布的变量。

使用方法:

openstack workflow execution published show [-h] id

表 88.58. positional 参数
概述

id

工作流 ID

表 88.59. 命令参数
概述

-h, --help

显示帮助信息并退出

88.16. 工作流执行报告显示

打印执行报告。

使用方法:

openstack workflow execution report show [-h] [--errors-only]
                                                [--no-errors-only]
                                                [--max-depth [MAX_DEPTH]]
                                                id

表 88.60. positional 参数
概述

id

执行 ID

表 88.61. 命令参数
概述

-h, --help

显示帮助信息并退出

--errors-only

只包括错误路径。

--no-errors-only

不仅会包括错误路径。

--max-depth [MAX_DEPTH]

工作流执行树的最大深度。如果 0,则仅包含 root 工作流执行及其任务

88.17. 工作流执行演示

显示特定的执行。

使用方法:

openstack workflow execution show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         execution

表 88.62. positional 参数
概述

执行

执行标识符

表 88.63. 命令参数
概述

-h, --help

显示帮助信息并退出

表 88.64. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 88.65. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 88.66. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 88.67. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

88.18. 工作流执行更新

更新执行。

使用方法:

openstack workflow execution update [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}]
                                           [-e ENV] [-d DESCRIPTION]
                                           id

表 88.68. positional 参数
概述

id

执行标识符

表 88.69. 命令参数
概述

-h, --help

显示帮助信息并退出

-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}, --state {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}

执行状态

-e ENV, --env ENV

环境变量

-d DESCRIPTION, --description DESCRIPTION

执行描述

表 88.70. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 88.71. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 88.72. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 88.73. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

88.19. 工作流列表

列出所有工作流。

使用方法:

openstack workflow list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN] [--marker [MARKER]]
                               [--limit [LIMIT]] [--sort_keys [SORT_KEYS]]
                               [--sort_dirs [SORT_DIRS]] [--filter FILTERS]

表 88.74. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

上一页的最后执行 uuid 显示在"marker"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

以逗号分隔的排序键列表,按以下方式对结果进行排序。默认: created_at。示例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序方向列表。默认为 asc。示例:mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

filters. 可以重复。

表 88.75. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 88.76. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 88.77. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 88.78. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

88.20. 工作流显示

显示特定的工作流。

使用方法:

openstack workflow show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--namespace [NAMESPACE]]
                               workflow

表 88.79. positional 参数
概述

工作流

工作流 ID 或名称。

表 88.80. 命令参数
概述

-h, --help

显示帮助信息并退出

--namespace [NAMESPACE]

从中获取工作流的命名空间。

表 88.81. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 88.82. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 88.83. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 88.84. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

88.21. 工作流更新

更新工作流。

使用方法:

openstack workflow update [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN]
                                 [--marker [MARKER]] [--limit [LIMIT]]
                                 [--sort_keys [SORT_KEYS]]
                                 [--sort_dirs [SORT_DIRS]] [--filter FILTERS]
                                 [--id ID] [--namespace [NAMESPACE]]
                                 [--public]
                                 definition

表 88.85. positional 参数
概述

定义

工作流定义

表 88.86. 命令参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

上一页的最后执行 uuid 显示在"marker"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

以逗号分隔的排序键列表,按以下方式对结果进行排序。默认: created_at。示例:mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序方向列表。默认为 asc。示例:mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

filters. 可以重复。

--id ID

工作流 ID。

--namespace [NAMESPACE]

工作流的命名空间。

--public

使用此标志工作流将标记为"public"。

表 88.87. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 88.88. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 88.89. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 88.90. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

88.22. 工作流验证

验证工作流。

使用方法:

openstack workflow validate [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   definition

表 88.91. positional 参数
概述

定义

工作流定义文件

表 88.92. 命令参数
概述

-h, --help

显示帮助信息并退出

表 88.93. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 88.94. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 88.95. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 88.96. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

第 89 章 zone

本章描述了 zone 命令下的命令。

89.1. zone abandon

带外区

使用方法:

openstack zone abandon [-h] [--all-projects] [--edit-managed]
                              [--sudo-project-id SUDO_PROJECT_ID]
                              id

表 89.1. positional 参数
概述

id

zone id

表 89.2. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

89.2. zone axfr

AXFR 一个区

使用方法:

openstack zone axfr [-h] [--all-projects] [--edit-managed]
                           [--sudo-project-id SUDO_PROJECT_ID]
                           id

表 89.3. positional 参数
概述

id

zone id

表 89.4. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

89.3. zone blacklist create

创建新黑名单

使用方法:

openstack zone blacklist create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] --pattern PATTERN
                                       [--description DESCRIPTION]
                                       [--all-projects] [--edit-managed]
                                       [--sudo-project-id SUDO_PROJECT_ID]

表 89.5. 命令参数
概述

-h, --help

显示帮助信息并退出

--pattern PATTERN

黑名单模式

--description DESCRIPTION

描述

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.6. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.7. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.8. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.9. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.4. zone blacklist delete

删除黑名单

使用方法:

openstack zone blacklist delete [-h] [--all-projects] [--edit-managed]
                                       [--sudo-project-id SUDO_PROJECT_ID]
                                       id

表 89.10. positional 参数
概述

id

blacklist id

表 89.11. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

89.5. zone blacklist list

列出黑名单

使用方法:

openstack zone blacklist list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--all-projects] [--edit-managed]
                                     [--sudo-project-id SUDO_PROJECT_ID]

表 89.12. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.13. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 89.14. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 89.15. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.16. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.6. zone blacklist set

设置黑名单属性

使用方法:

openstack zone blacklist set [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--pattern PATTERN]
                                    [--description DESCRIPTION | --no-description]
                                    [--all-projects] [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    id

表 89.17. positional 参数
概述

id

blacklist id

表 89.18. 命令参数
概述

-h, --help

显示帮助信息并退出

--pattern PATTERN

黑名单模式

--description DESCRIPTION

描述

--no-description—​all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.19. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.20. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.21. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.22. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.7. zone blacklist show

显示黑名单详情

使用方法:

openstack zone blacklist show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--all-projects] [--edit-managed]
                                     [--sudo-project-id SUDO_PROJECT_ID]
                                     id

表 89.23. positional 参数
概述

id

blacklist id

表 89.24. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.25. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.26. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.27. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.28. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.8. zone create

创建新区

使用方法:

openstack zone create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--email EMAIL] [--type TYPE]
                             [--ttl TTL] [--description DESCRIPTION]
                             [--masters MASTERS [MASTERS ...]]
                             [--attributes ATTRIBUTES [ATTRIBUTES ...]]
                             [--all-projects] [--edit-managed]
                             [--sudo-project-id SUDO_PROJECT_ID]
                             name

表 89.29. positional 参数
概述

name

区域名称

表 89.30. 命令参数
概述

-h, --help

显示帮助信息并退出

--email EMAIL

区域电子邮件

--type TYPE

区域类型

--ttl TTL

生存时间(秒)

--description DESCRIPTION

描述

--masters MASTERS [MASTERS …​]

zone master

--attributes ATTRIBUTES [ATTRIBUTES …​]

区属性

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.31. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.32. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.33. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.34. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.9. zone delete

删除区

使用方法:

openstack zone delete [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--all-projects] [--edit-managed]
                             [--sudo-project-id SUDO_PROJECT_ID]
                             id

表 89.35. positional 参数
概述

id

zone id

表 89.36. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.37. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.38. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.39. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.40. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.10. zone export create

导出区

使用方法:

openstack zone export create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--all-projects]
                                    [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_id

表 89.41. positional 参数
概述

zone_id

zone id

表 89.42. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.43. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.44. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.45. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.46. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.11. zone export delete

删除区导出

使用方法:

openstack zone export delete [-h] [--all-projects] [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_export_id

表 89.47. positional 参数
概述

zone_export_id

zone export id

表 89.48. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

89.12. zone export list

列出区域导出

使用方法:

openstack zone export list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]

表 89.49. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.50. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 89.51. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 89.52. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.53. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.13. zone export show

显示区导出

使用方法:

openstack zone export show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_export_id

表 89.54. positional 参数
概述

zone_export_id

zone export id

表 89.55. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.56. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.57. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.58. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.59. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.14. zone export showfile

显示区域导出的区域文件

使用方法:

openstack zone export showfile [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--all-projects]
                                      [--edit-managed]
                                      [--sudo-project-id SUDO_PROJECT_ID]
                                      zone_export_id

表 89.60. positional 参数
概述

zone_export_id

zone export id

表 89.61. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.62. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.63. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.64. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.65. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.15. zone import create

从文件系统上的文件导入区域

使用方法:

openstack zone import create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--all-projects]
                                    [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_file_path

表 89.66. positional 参数
概述

zone_file_path

到区文件的路径

表 89.67. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.68. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.69. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.70. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.71. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.16. 区导入删除

删除区导入

使用方法:

openstack zone import delete [-h] [--all-projects] [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_import_id

表 89.72. positional 参数
概述

zone_import_id

zone import id

表 89.73. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

89.17. 区域导入列表

列出区域导入

使用方法:

openstack zone import list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]

表 89.74. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.75. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 89.76. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 89.77. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.78. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.18. 区域导入显示

显示区导入

使用方法:

openstack zone import show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_import_id

表 89.79. positional 参数
概述

zone_import_id

zone import id

表 89.80. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.81. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.82. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.83. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.84. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.19. zone list

列出区域

使用方法:

openstack zone list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           [--name NAME] [--email EMAIL] [--type TYPE]
                           [--ttl TTL] [--description DESCRIPTION]
                           [--status STATUS] [--all-projects] [--edit-managed]
                           [--sudo-project-id SUDO_PROJECT_ID]

表 89.85. 命令参数
概述

-h, --help

显示帮助信息并退出

--name NAME

区域名称

--email EMAIL

区域电子邮件

--type TYPE

区域类型

--ttl TTL

生存时间(秒)

--description DESCRIPTION

描述

--status STATUS

区域状态

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.86. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 89.87. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 89.88. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.89. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.20. zone set

设置区属性

使用方法:

openstack zone set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                          [--noindent] [--prefix PREFIX]
                          [--max-width <integer>] [--fit-width]
                          [--print-empty] [--email EMAIL] [--ttl TTL]
                          [--description DESCRIPTION | --no-description]
                          [--masters MASTERS [MASTERS ...]] [--all-projects]
                          [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
                          id

表 89.90. positional 参数
概述

id

zone id

表 89.91. 命令参数
概述

-h, --help

显示帮助信息并退出

--email EMAIL

区域电子邮件

--ttl TTL

生存时间(秒)

--description DESCRIPTION

描述

--no-description—​masters MASTERS [MASTERS …​]

zone master

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.92. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.93. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.94. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.95. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.21. 区域显示

显示区详情

使用方法:

openstack zone show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--all-projects] [--edit-managed]
                           [--sudo-project-id SUDO_PROJECT_ID]
                           id

表 89.96. positional 参数
概述

id

zone id

表 89.97. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.98. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.99. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.100. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.101. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.22. zone transfer accept list

列出区域传输接受

使用方法:

openstack zone transfer accept list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           [--all-projects] [--edit-managed]
                                           [--sudo-project-id SUDO_PROJECT_ID]

表 89.102. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.103. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 89.104. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 89.105. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.106. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.23. 区域传送接受请求

接受区传输请求

使用方法:

openstack zone transfer accept request [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              --transfer-id TRANSFER_ID --key
                                              KEY [--all-projects]
                                              [--edit-managed]
                                              [--sudo-project-id SUDO_PROJECT_ID]

表 89.107. 命令参数
概述

-h, --help

显示帮助信息并退出

--transfer-id TRANSFER_ID

传输 ID

--key KEY

传输密钥

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.108. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.109. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.110. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.111. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.24. 区域传送 accept show

显示区传输接受

使用方法:

openstack zone transfer accept show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--all-projects] [--edit-managed]
                                           [--sudo-project-id SUDO_PROJECT_ID]
                                           id

表 89.112. positional 参数
概述

id

zone tranfer 接受 id

表 89.113. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.114. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.115. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.116. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.117. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.25. 区传输请求创建

创建新区传输请求

使用方法:

openstack zone transfer request create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--target-project-id TARGET_PROJECT_ID]
                                              [--description DESCRIPTION]
                                              [--all-projects]
                                              [--edit-managed]
                                              [--sudo-project-id SUDO_PROJECT_ID]
                                              zone_id

表 89.118. positional 参数
概述

zone_id

要传输的区域 ID。

表 89.119. 命令参数
概述

-h, --help

显示帮助信息并退出

--target-project-id TARGET_PROJECT_ID

要传输到的目标项目 ID。

--description DESCRIPTION

描述

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.120. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.121. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.122. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.123. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.26. 区传输请求删除

删除区传输请求

使用方法:

openstack zone transfer request delete [-h] [--all-projects]
                                              [--edit-managed]
                                              [--sudo-project-id SUDO_PROJECT_ID]
                                              id

表 89.124. positional 参数
概述

id

区域传输请求 ID

表 89.125. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

89.27. 区传输请求列表

列出区域传输请求

使用方法:

openstack zone transfer request list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--noindent]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--sort-column SORT_COLUMN]
                                            [--all-projects] [--edit-managed]
                                            [--sudo-project-id SUDO_PROJECT_ID]

表 89.126. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.127. 输出格式选项
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

--sort-column SORT_COLUMN

指定对数据进行排序的列(第一个指定的列具有优先级,不存在的列将被忽略)

表 89.128. CSV 格式化器选项
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 89.129. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.130. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.28. 区传输请求集

设置区传输请求

使用方法:

openstack zone transfer request set [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--description DESCRIPTION | --no-description]
                                           [--all-projects] [--edit-managed]
                                           [--sudo-project-id SUDO_PROJECT_ID]
                                           id

表 89.131. positional 参数
概述

id

区域传输请求 ID

表 89.132. 命令参数
概述

-h, --help

显示帮助信息并退出

--description DESCRIPTION

描述

--no-description—​all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.133. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.134. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.135. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.136. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

89.29. 区域传送请求显示

显示区传输请求详情

使用方法:

openstack zone transfer request show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--all-projects] [--edit-managed]
                                            [--sudo-project-id SUDO_PROJECT_ID]
                                            id

表 89.137. positional 参数
概述

id

zone tranfer request id

表 89.138. 命令参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示来自所有项目的结果。默认为 false

--edit-managed

编辑标记为 managed 的资源。default: false

--sudo-project-id SUDO_PROJECT_ID

要为这个命令模拟的项目 ID。默认为 None

表 89.139. 输出格式选项
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复使用

表 89.140. JSON 格式化器选项
概述

--noindent

是否禁用缩进 json

表 89.141. shell 格式化器选项
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 89.142. 表格式选项
概述

--max-width <integer>

最大显示宽度,<1 禁用。您也可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

将表适合显示宽度。表示,如果 --max- width 大于 0。将环境变量 CLIFF_FIT_WIDTH=1 设置为始终启用

--print-empty

如果没有要显示的数据,请打印空表。

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.